diff --git a/GLib-2.0.gir b/GLib-2.0.gir index 4ffc8ec0..da0791f3 100644 --- a/GLib-2.0.gir +++ b/GLib-2.0.gir @@ -18483,7 +18483,7 @@ the pointer passed to it should not be `volatile`. - new non-0 value for *@value_location + new non-0 value for `*value_location` @@ -44068,8 +44068,8 @@ See your C library manual for more details about chmod(). - If @err or *@err is %NULL, does nothing. Otherwise, -calls g_error_free() on *@err and sets *@err to %NULL. + If @err or `*err` is %NULL, does nothing. Otherwise, +calls g_error_free() on `*err` and sets `*err` to %NULL. @@ -51262,7 +51262,7 @@ the pointer passed to it should not be `volatile`. - new non-0 value for *@value_location + new non-0 value for `*value_location` @@ -51788,7 +51788,7 @@ if the call was interrupted. error message. If @err is %NULL (ie: no error variable) then do nothing. -If *@err is %NULL (ie: an error variable is present but there is no +If `*err` is %NULL (ie: an error variable is present but there is no error condition) then also do nothing. @@ -51809,7 +51809,7 @@ error condition) then also do nothing. - Prefixes @prefix to an existing error message. If @err or *@err is + Prefixes @prefix to an existing error message. If @err or `*err` is %NULL (i.e.: no error variable) then do nothing. @@ -51942,7 +51942,7 @@ placeholders in any case, as their behaviour is locale-dependent. - 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. @@ -51965,8 +51965,8 @@ after calling this function on it. - If @dest is %NULL, free @src; otherwise, moves @src into *@dest. -*@dest must be %NULL. After the move, add a prefix as with + 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(). @@ -53455,8 +53455,8 @@ or when displaying an application's name in the task list. - 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. + 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`. @@ -53484,8 +53484,8 @@ must be %NULL. A new #GError is created and assigned to *@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. + 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, that could include printf() escape sequences. @@ -56361,10 +56361,6 @@ Elements are compared using [func@GLib.str_equal]. To match independently of order, sort the arrays first (using [func@GLib.qsort_with_data] or similar). -Elements are compared using [func@GLib.str_equal]. To match independently -of order, sort the arrays first (using [func@GLib.qsort_with_data] -or similar). - Two empty arrays are considered equal. Neither @strv1 nor @strv2 may be `NULL`. @@ -58902,10 +58898,10 @@ This function does not include compatibility decompositions. It does, however, include algorithmic Hangul Jamo decomposition, as well as 'singleton' decompositions which replace a character by a single -other character. In the case of singletons *@b will +other character. In the case of singletons `*b` will be set to zero. -If @ch is not decomposable, *@a is set to @ch and *@b +If @ch is not decomposable, `*a` is set to @ch and `*b` is set to zero. Note that the way Unicode decomposition pairs are diff --git a/GdkWayland-4.0.gir b/GdkWayland-4.0.gir index b0e516c3..b76d660c 100644 --- a/GdkWayland-4.0.gir +++ b/GdkWayland-4.0.gir @@ -408,6 +408,16 @@ provides access to the Wayland `wl_seat` object with Beyond the [class@Gdk.Surface] API, the Wayland implementation offers access to the Wayland `wl_surface` object with [method@GdkWayland.WaylandSurface.get_wl_surface]. + + + + + + + + + + Returns the Wayland `wl_surface` of a `GdkSurface`. diff --git a/Gio-2.0.gir b/Gio-2.0.gir index 38eebdc1..ef54645c 100644 --- a/Gio-2.0.gir +++ b/Gio-2.0.gir @@ -8,13 +8,13 @@ and/or use gtk-doc annotations. --> - - - - - - + + + + + + @@ -13481,7 +13481,7 @@ artifact and the argument passed to it should not be `volatile`. - 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). @@ -71056,13 +71056,13 @@ blocking. If @enumerator is expected to yield addresses, but for some reason is unable to (eg, because of a DNS error), then the first call to g_socket_address_enumerator_next() will return an appropriate error -in *@error. However, if the first call to +in `*error`. However, if the first call to g_socket_address_enumerator_next() succeeds, then any further internal errors (other than @cancellable being triggered) will be ignored. a #GSocketAddress (owned by the caller), or %NULL on - error (in which case *@error will be set) or if there are no + error (in which case `*error` will be set) or if there are no more addresses. @@ -71113,7 +71113,7 @@ g_socket_address_enumerator_next() for more information about error handling. a #GSocketAddress (owned by the caller), or %NULL on - error (in which case *@error will be set) or if there are no + error (in which case `*error` will be set) or if there are no more addresses. @@ -71138,13 +71138,13 @@ blocking. If @enumerator is expected to yield addresses, but for some reason is unable to (eg, because of a DNS error), then the first call to g_socket_address_enumerator_next() will return an appropriate error -in *@error. However, if the first call to +in `*error`. However, if the first call to g_socket_address_enumerator_next() succeeds, then any further internal errors (other than @cancellable being triggered) will be ignored. a #GSocketAddress (owned by the caller), or %NULL on - error (in which case *@error will be set) or if there are no + error (in which case `*error` will be set) or if there are no more addresses. @@ -71195,7 +71195,7 @@ g_socket_address_enumerator_next() for more information about error handling. a #GSocketAddress (owned by the caller), or %NULL on - error (in which case *@error will be set) or if there are no + error (in which case `*error` will be set) or if there are no more addresses. @@ -71224,7 +71224,7 @@ error handling. a #GSocketAddress (owned by the caller), or %NULL on - error (in which case *@error will be set) or if there are no + error (in which case `*error` will be set) or if there are no more addresses. @@ -71272,7 +71272,7 @@ error handling. a #GSocketAddress (owned by the caller), or %NULL on - error (in which case *@error will be set) or if there are no + error (in which case `*error` will be set) or if there are no more addresses. @@ -84014,19 +84014,19 @@ when the stream is closed. Defines a Unix mount entry (e.g. `/media/cdrom`). This corresponds roughly to a mtab entry. - Compares two unix mounts. + Compares two Unix mounts. - 1, 0 or -1 if @mount1 is greater than, equal to, -or less than @mount2, respectively. + `1`, `0` or `-1` if @mount1 is greater than, equal to, + or less than @mount2, respectively - first #GUnixMountEntry to compare. + first [struct@GioUnix.MountEntry] to compare - second #GUnixMountEntry to compare. + second [struct@GioUnix.MountEntry] to compare @@ -84034,81 +84034,82 @@ or less than @mount2, respectively. Makes a copy of @mount_entry. - a new #GUnixMountEntry + a new [struct@GioUnix.MountEntry] - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - Frees a unix mount. + Frees a Unix mount. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - 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 [struct@GioUnix.MountEntry] - 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 [struct@GioUnix.MountEntry] - 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. + a [struct@GioUnix.MountEntry] to get the mount path for - Gets a comma-separated list of mount options for the unix mount. For example, -`rw,relatime,seclabel,data=ordered`. + Gets a comma separated list of mount options for the Unix mount. -This is similar to g_unix_mount_point_get_options(), but it takes -a #GUnixMountEntry as an argument. +For example: `rw,relatime,seclabel,data=ordered`. + +This is similar to [func@GioUnix.MountPoint.get_options], but it takes +a [struct@GioUnix.MountEntry] as an argument. - a string containing the options, or %NULL if not -available. + a string containing the options, or `NULL` if not + available. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] @@ -84117,193 +84118,206 @@ available. 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 -"mount /dev/sda1 /mnt/foo" and "/bar" for -"mount --bind /mnt/foo/bar /mnt/bar". +For example, the root path is equal to `/` for a mount created by +`mount /dev/sda1 /mnt/foo` and `/bar` for +`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 [struct@GioUnix.MountEntry] - Guesses whether a Unix mount can be ejected. + Guesses whether a Unix mount entry can be ejected. - %TRUE if @mount_entry is deemed to be ejectable. + true if @mount_entry is deemed to be ejectable; false otherwise - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses the icon of a Unix mount. + Guesses the icon of a Unix mount entry. - a #GIcon + a [iface@Gio.Icon] - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses the name of a Unix mount. + Guesses the name of a Unix mount entry. + The result is a translated string. - A newly allocated string that must - be freed with g_free() + a newly allocated translated string - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses whether a Unix mount should be displayed in the UI. + Guesses whether a Unix mount entry should be displayed in the UI. - %TRUE if @mount_entry is deemed to be displayable. + true if @mount_entry is deemed to be displayable; false otherwise - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses the symbolic icon of a Unix mount. + Guesses the symbolic icon of a Unix mount entry. - a #GIcon + a [iface@Gio.Icon] - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - 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; false otherwise - a #GUnixMount. + a [struct@GioUnix.MountEntry] - 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. + Checks if a Unix mount is a system mount. + +This is the Boolean OR of +[func@GioUnix.is_system_fs_type], [func@GioUnix.is_system_device_path] and +[func@GioUnix.is_mount_path_system_internal] on @mount_entry’s properties. The definition of what a ‘system’ mount entry is may change over time as new 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; false otherwise - a #GUnixMount. + a [struct@GioUnix.MountEntry] - 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_mount_entries_changed_since(). + Gets a [struct@GioUnix.MountEntry] 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 +[func@GioUnix.mount_entries_changed_since]. If more mounts have the same mount path, the last matching mount is returned. -This will return %NULL if there is no mount point at @mount_path. +This will return `NULL` if there is no mount point at @mount_path. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - path for a possible unix mount. + path for a possible Unix mount - guint64 to contain a timestamp. + return location for a timestamp - 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_mount_entries_changed_since(). + Gets a [struct@GioUnix.MountEntry] 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 +[func@GioUnix.mount_entries_changed_since]. If more mounts have the same mount path, the last matching mount is returned. -This will return %NULL if looking up the mount entry fails, if +This will return `NULL` if looking up the mount entry fails, if @file_path doesn’t exist or there is an I/O error. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - file path on some unix mount. + file path on some Unix mount - guint64 to contain a timestamp. + return location for a timestamp - Watches #GUnixMounts for changes. + Watches for changes to the set of mount entries and mount points in the +system. + +Connect to the [signal@GioUnix.MountMonitor::mounts-changed] signal to be +notified of changes to the [struct@GioUnix.MountEntry] list. + +Connect to the [signal@GioUnix.MountMonitor::mountpoints-changed] signal to +be notified of changes to the [struct@GioUnix.MountPoint] list. - Deprecated alias for g_unix_mount_monitor_get(). + Deprecated alias for [func@GioUnix.MountMonitor.get]. This function was never a true constructor, which is why it was renamed. - Use g_unix_mount_monitor_get() instead. + Use [func@GioUnix.MountMonitor.get] instead. - a #GUnixMountMonitor. + a [class@GioUnix.MountMonitor] - Gets the #GUnixMountMonitor for the current thread-default main + Gets the [class@GioUnix.MountMonitor] for the current thread-default main context. The mount monitor can be used to monitor for changes to the list of mounted filesystems as well as the list of mount points (ie: fstab entries). -You must only call g_object_unref() on the return value from under -the same main context as you called this function. +You must only call [method@GObject.Object.unref] on the return value from +under the same main context as you called this function. - the #GUnixMountMonitor. + the [class@GioUnix.MountMonitor] @@ -84315,30 +84329,29 @@ rate at which events would be reported under some uncommon circumstances. Since @mount_monitor is a singleton, it also meant that calling this function would have side effects for other users of the monitor. - This function does nothing. Don't call it. + This function does nothing. Don’t call it. - a #GUnixMountMonitor + a [class@GioUnix.MountMonitor] - a integer with the limit in milliseconds to - poll for changes. + 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 mount entries have changed. @@ -84349,19 +84362,19 @@ the monitor. Defines a Unix mount point (e.g. `/dev`). 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, -or less than @mount2, respectively. + `1`, `0` or `-1` if @mount1 is greater than, equal to, + or less than @mount2, respectively - a #GUnixMount. + a [struct@GioUnix.MountPoint] - a #GUnixMount. + a [struct@GioUnix.MountPoint] @@ -84369,37 +84382,37 @@ or less than @mount2, respectively. Makes a copy of @mount_point. - a new #GUnixMountPoint + a new [struct@GioUnix.MountPoint] - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] - Frees a unix mount point. + Frees a Unix mount point. - unix mount point to free. + Unix mount point to free. - Gets the device path for a unix mount point. + Gets the device path for a Unix mount point. - a string containing the device path. + a string containing the device path - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] @@ -84407,25 +84420,25 @@ or less than @mount2, respectively. Gets the file system type for the mount point. - a string containing the file system type. + a string containing the file system type - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] - Gets the mount path for a unix mount point. + Gets the mount path for a Unix mount point. - a string containing the mount path. + a string containing the mount path - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] @@ -84433,12 +84446,12 @@ or less than @mount2, respectively. Gets the options for the mount point. - a string containing the options. + a string containing the options - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] @@ -84446,12 +84459,12 @@ or less than @mount2, respectively. Guesses whether a Unix mount point can be ejected. - %TRUE if @mount_point is deemed to be ejectable. + true if @mount_point is deemed to be ejectable; false otherwise - a #GUnixMountPoint + a [struct@GioUnix.MountPoint] @@ -84459,27 +84472,27 @@ or less than @mount2, respectively. Guesses the icon of a Unix mount point. - a #GIcon + a [iface@Gio.Icon] - a #GUnixMountPoint + a [struct@GioUnix.MountPoint] 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 newly allocated translated string - a #GUnixMountPoint + a [struct@GioUnix.MountPoint] @@ -84487,74 +84500,76 @@ The result is a translated string. Guesses the symbolic icon of a Unix mount point. - a #GIcon + a [iface@Gio.Icon] - a #GUnixMountPoint + a [struct@GioUnix.MountPoint] - Checks if a unix mount point is a loopback device. + Checks if a Unix mount point is a loopback device. - %TRUE if the mount point is a loopback. %FALSE otherwise. + true if the mount point is a loopback device; false otherwise - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] - Checks if a unix mount point is read only. + Checks if a Unix mount point is read only. - %TRUE if a mount point is read only. + true if a mount point is read only; false otherwise - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] - Checks if a unix mount point is mountable by the user. + Checks if a Unix mount point is mountable by the user. - %TRUE if the mount point is user mountable. + true if the mount point is user mountable; false otherwise - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] - Gets a #GUnixMountPoint for a given mount path. If @time_read is set, it -will be filled with a unix timestamp for checking if the mount points have -changed since with g_unix_mount_points_changed_since(). + Gets a [struct@GioUnix.MountPoint] for a given mount path. + +If @time_read is set, it will be filled with a Unix timestamp for checking if +the mount points have changed since with +[func@GioUnix.mount_points_changed_since]. If more mount points have the same mount path, the last matching mount point is returned. - a #GUnixMountPoint, or %NULL if no match -is found. + a [struct@GioUnix.MountPoint], or `NULL` + if no match is found - path for a possible unix mount point. + path for a possible Unix mount point - guint64 to contain a timestamp. + return location for a timestamp @@ -91272,12 +91287,14 @@ this function has returned. Determines if @mount_path is considered an implementation of the -OS. This is primarily used for hiding mountable and mounted volumes +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 - of the OS. + true if @mount_path is considered an implementation detail + of the OS; false otherwise @@ -91289,15 +91306,17 @@ casual user. 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, -appear in a GUI. For example, the Linux `/proc` filesystem. +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, 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 - the OS. + true if @device_path is considered an implementation detail of + the OS; false otherwise @@ -91309,14 +91328,17 @@ The list of device paths considered ‘system’ ones may change over 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, -appear in a GUI. For example, the Linux `/proc` filesystem. +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, 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; + false otherwise @@ -91327,92 +91349,106 @@ The list of file system types considered ‘system’ ones may change - 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_mount_entries_changed_since(). + Gets a [struct@GioUnix.MountEntry] 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 +[func@GioUnix.mount_entries_changed_since]. If more mounts have the same mount path, the last matching mount is returned. -This will return %NULL if there is no mount point at @mount_path. - Use g_unix_mount_entry_at() instead. +This will return `NULL` if there is no mount point at @mount_path. + Use [func@GioUnix.MountEntry.at] instead. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - path for a possible unix mount. + path for a possible Unix mount - guint64 to contain a timestamp. + return location for a timestamp - Compares two unix mounts. - Use g_unix_mount_entry_compare() instead. + Compares two Unix mounts. + Use [func@GioUnix.MountEntry.compare] instead. - 1, 0 or -1 if @mount1 is greater than, equal to, -or less than @mount2, respectively. + `1`, `0` or `-1` if @mount1 is greater than, equal to, + or less than @mount2, respectively - first #GUnixMountEntry to compare. + first [struct@GioUnix.MountEntry] to compare - second #GUnixMountEntry to compare. + second [struct@GioUnix.MountEntry] to compare Makes a copy of @mount_entry. - Use g_unix_mount_entry_copy() instead. + Use [func@GioUnix.MountEntry.copy] instead. - a new #GUnixMountEntry + a new [struct@GioUnix.MountEntry] - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - Checks if the unix mounts have changed since a given unix time. + Checks if the Unix mounts have changed since a given Unix time. + +This can only work reliably if a [class@GioUnix.MountMonitor] is running in +the process, otherwise changes in the mount entries file (such as +`/proc/self/mountinfo` on Linux) cannot be detected and, as a result, this +function has to conservatively always return `TRUE`. + +It is more efficient to use [signal@GioUnix.MountMonitor::mounts-changed] to +be signalled of changes to the mount entries, rather than polling using this +function. This function is more appropriate for infrequently determining +cache validity. - %TRUE if the mounts have changed since @time. + true if the mounts have changed since @time; false otherwise Since 2.84 - guint64 to contain a timestamp. + a timestamp - 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_mount_entries_changed_since(). + Gets a list of [struct@GioUnix.MountEntry] instances representing 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 +[func@GioUnix.mount_entries_changed_since]. - - a #GList of the UNIX mounts. + a list of the + Unix mounts - guint64 to contain a timestamp, or %NULL + return location for a timestamp @@ -91421,10 +91457,10 @@ with g_unix_mount_entries_changed_since(). Gets an array of [struct@Gio.UnixMountEntry]s containing the Unix mounts listed in @table_path. -This is a generalized version of g_unix_mount_entries_get(), mainly intended for -internal testing use. Note that g_unix_mount_entries_get() may parse multiple -hierarchical table files, so this function is not a direct superset of its -functionality. +This is a generalized version of [func@GioUnix.mount_entries_get], mainly +intended for internal testing use. Note that [func@GioUnix.mount_entries_get] +may parse multiple hierarchical table files, so this function is not a direct +superset of its functionality. If there is an error reading or parsing the file, `NULL` will be returned and both out parameters will be set to `0`. @@ -91453,150 +91489,157 @@ and both out parameters will be set to `0`. - 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_mount_entries_changed_since(). + Gets a [struct@GioUnix.MountEntry] 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 +[func@GioUnix.mount_entries_changed_since]. If more mounts have the same mount path, the last matching mount is returned. -This will return %NULL if there is no mount point at @mount_path. +This will return `NULL` if there is no mount point at @mount_path. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - path for a possible unix mount. + path for a possible Unix mount - guint64 to contain a timestamp. + return location for a timestamp - 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_mount_entries_changed_since(). + Gets a [struct@GioUnix.MountEntry] 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 +[func@GioUnix.mount_entries_changed_since]. If more mounts have the same mount path, the last matching mount is returned. -This will return %NULL if looking up the mount entry fails, if +This will return `NULL` if looking up the mount entry fails, if @file_path doesn’t exist or there is an I/O error. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - file path on some unix mount. + file path on some Unix mount - guint64 to contain a timestamp. + return location for a timestamp - 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_mount_entries_changed_since(). + Gets a [struct@GioUnix.MountEntry] 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 +[func@GioUnix.mount_entries_changed_since]. If more mounts have the same mount path, the last matching mount is returned. -This will return %NULL if looking up the mount entry fails, if +This will return `NULL` if looking up the mount entry fails, if @file_path doesn’t exist or there is an I/O error. - Use g_unix_mount_entry_for() instead. + Use [func@GioUnix.MountEntry.for] instead. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - file path on some unix mount. + file path on some Unix mount - guint64 to contain a timestamp. + return location for a timestamp - Frees a unix mount. - Use g_unix_mount_entry_free() instead. + Frees a Unix mount. + Use [func@GioUnix.MountEntry.free] instead. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - Gets the device path for a unix mount. - Use g_unix_mount_entry_get_device_path() instead. + Gets the device path for a Unix mount. + Use [func@GioUnix.MountEntry.get_device_path] instead. - a string containing the device path. + a string containing the device path - a #GUnixMount. + a [struct@GioUnix.MountEntry] - Gets the filesystem type for the unix mount. - Use g_unix_mount_entry_get_fs_type() instead. + Gets the filesystem type for the Unix mount. + Use [func@GioUnix.MountEntry.get_fs_type] instead. - a string containing the file system type. + a string containing the file system type - a #GUnixMount. + a [struct@GioUnix.MountEntry] - Gets the mount path for a unix mount. - Use g_unix_mount_entry_get_mount_path() instead. + Gets the mount path for a Unix mount. + Use [func@GioUnix.MountEntry.get_mount_path] instead. - the mount path for @mount_entry. + the mount path for @mount_entry - input #GUnixMountEntry to get the mount path for. + a [struct@GioUnix.MountEntry] to get the mount path for - Gets a comma-separated list of mount options for the unix mount. For example, -`rw,relatime,seclabel,data=ordered`. + Gets a comma separated list of mount options for the Unix mount. -This is similar to g_unix_mount_point_get_options(), but it takes -a #GUnixMountEntry as an argument. - Use g_unix_mount_entry_get_options() instead. +For example: `rw,relatime,seclabel,data=ordered`. + +This is similar to [func@GioUnix.MountPoint.get_options], but it takes +a [struct@GioUnix.MountEntry] as an argument. + Use [func@GioUnix.MountEntry.get_options] instead. - a string containing the options, or %NULL if not -available. + a string containing the options, or `NULL` if not + available. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] @@ -91605,177 +91648,193 @@ available. 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 -"mount /dev/sda1 /mnt/foo" and "/bar" for -"mount --bind /mnt/foo/bar /mnt/bar". - Use g_unix_mount_entry_get_root_path() instead. +For example, the root path is equal to `/` for a mount created by +`mount /dev/sda1 /mnt/foo` and `/bar` for +`mount --bind /mnt/foo/bar /mnt/bar`. + Use [func@GioUnix.MountEntry.get_root_path] instead. - a string containing the root, or %NULL if not supported. + a string containing the root, or `NULL` if not supported - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - Guesses whether a Unix mount can be ejected. - Use g_unix_mount_entry_guess_can_eject() instead. + Guesses whether a Unix mount entry can be ejected. + Use [func@GioUnix.MountEntry.guess_can_eject] instead. - %TRUE if @mount_entry is deemed to be ejectable. + true if @mount_entry is deemed to be ejectable; false otherwise - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses the icon of a Unix mount. - Use g_unix_mount_entry_guess_icon() instead. + Guesses the icon of a Unix mount entry. + Use [func@GioUnix.MountEntry.guess_icon] instead. - a #GIcon + a [iface@Gio.Icon] - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses the name of a Unix mount. + Guesses the name of a Unix mount entry. + The result is a translated string. - Use g_unix_mount_entry_guess_name() instead. + Use [func@GioUnix.MountEntry.guess_name] instead. - A newly allocated string that must - be freed with g_free() + a newly allocated translated string - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses whether a Unix mount should be displayed in the UI. - Use g_unix_mount_entry_guess_should_display() instead. + Guesses whether a Unix mount entry should be displayed in the UI. + Use [func@GioUnix.MountEntry.guess_should_display] instead. - %TRUE if @mount_entry is deemed to be displayable. + true if @mount_entry is deemed to be displayable; false otherwise - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses the symbolic icon of a Unix mount. - Use g_unix_mount_entry_guess_symbolic_icon() instead. + Guesses the symbolic icon of a Unix mount entry. + Use [func@GioUnix.MountEntry.guess_symbolic_icon] instead. - a #GIcon + a [iface@Gio.Icon] - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Checks if a unix mount is mounted read only. - Use g_unix_mount_entry_is_readonly() instead. + Checks if a Unix mount is mounted read only. + Use [func@GioUnix.MountEntry.is_readonly] instead. - %TRUE if @mount_entry is read only. + true if @mount_entry is read only; false otherwise - a #GUnixMount. + a [struct@GioUnix.MountEntry] - 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. + Checks if a Unix mount is a system mount. + +This is the Boolean OR of +[func@GioUnix.is_system_fs_type], [func@GioUnix.is_system_device_path] and +[func@GioUnix.is_mount_path_system_internal] on @mount_entry’s properties. The definition of what a ‘system’ mount entry is may change over time as new file system types and device paths are ignored. - Use g_unix_mount_entry_is_system_internal() instead. + Use [func@GioUnix.MountEntry.is_system_internal] instead. - %TRUE if the unix mount is for a system path. + true if the Unix mount is for a system path; false otherwise - a #GUnixMount. + a [struct@GioUnix.MountEntry] - Gets a #GUnixMountPoint for a given mount path. If @time_read is set, it -will be filled with a unix timestamp for checking if the mount points have -changed since with g_unix_mount_points_changed_since(). + Gets a [struct@GioUnix.MountPoint] for a given mount path. + +If @time_read is set, it will be filled with a Unix timestamp for checking if +the mount points have changed since with +[func@GioUnix.mount_points_changed_since]. If more mount points have the same mount path, the last matching mount point is returned. - a #GUnixMountPoint, or %NULL if no match -is found. + a [struct@GioUnix.MountPoint], or `NULL` + if no match is found - path for a possible unix mount point. + path for a possible Unix mount point - guint64 to contain a timestamp. + return location for a timestamp - 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. + +Unlike [func@GioUnix.mount_entries_changed_since], this function can work +reliably without a [class@GioUnix.MountMonitor] running, as it accesses the +static mount point information (such as `/etc/fstab` on Linux), which has a +valid modification time. + +It is more efficient to use [signal@GioUnix.MountMonitor::mountpoints-changed] +to be signalled of changes to the mount points, rather than polling using +this function. This function is more appropriate for infrequently determining +cache validity. - %TRUE if the mount points have changed since @time. + true if the mount points have changed since @time; false otherwise - guint64 to contain a timestamp. + a timestamp - 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(). + Gets a list of [struct@GioUnix.MountPoint] instances representing 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 +[func@GioUnix.mount_points_changed_since]. - - a #GList of the UNIX mountpoints. + a list of the Unix + mount points - guint64 to contain a timestamp. + return location for a timestamp @@ -91784,10 +91843,10 @@ g_unix_mount_points_changed_since(). Gets an array of [struct@Gio.UnixMountPoint]s containing the Unix mount points listed in @table_path. -This is a generalized version of g_unix_mount_points_get(), mainly intended -for internal testing use. Note that g_unix_mount_points_get() may parse -multiple hierarchical table files, so this function is not a direct superset -of its functionality. +This is a generalized version of [func@GioUnix.mount_points_get], mainly +intended for internal testing use. Note that [func@GioUnix.mount_points_get] +may parse multiple hierarchical table files, so this function is not a direct +superset of its functionality. If there is an error reading or parsing the file, `NULL` will be returned and both out parameters will be set to `0`. @@ -91816,35 +91875,37 @@ and both out parameters will be set to `0`. - Checks if the unix mounts have changed since a given unix time. - Use g_unix_mount_entry_free() instead. + Checks if the Unix mounts have changed since a given Unix time. + Use [func@GioUnix.mount_entries_changed_since] instead. - %TRUE if the mounts have changed since @time. + true if the mounts have changed since @time; false otherwise - guint64 to contain a timestamp. + a timestamp - 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_mount_entries_changed_since(). - Use g_unix_mount_entries_get() instead. + Gets a list of [struct@GioUnix.MountEntry] instances representing 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 +[func@GioUnix.mount_entries_changed_since]. + Use [func@GioUnix.mount_entries_get] instead. - - a #GList of the UNIX mounts. + a list of the + Unix mounts - guint64 to contain a timestamp, or %NULL + return location for a timestamp @@ -91853,14 +91914,14 @@ with g_unix_mount_entries_changed_since(). Gets an array of [struct@Gio.UnixMountEntry]s containing the Unix mounts listed in @table_path. -This is a generalized version of g_unix_mount_entries_get(), mainly intended for -internal testing use. Note that g_unix_mount_entries_get() may parse multiple -hierarchical table files, so this function is not a direct superset of its -functionality. +This is a generalized version of [func@GioUnix.mount_entries_get], mainly +intended for internal testing use. Note that [func@GioUnix.mount_entries_get] +may parse multiple hierarchical table files, so this function is not a direct +superset of its functionality. If there is an error reading or parsing the file, `NULL` will be returned and both out parameters will be set to `0`. - Use g_unix_mount_entries_get_from_file() instead. + Use [func@GioUnix.mount_entries_get_from_file] instead. mount entries, or `NULL` if there was an error loading them diff --git a/GioUnix-2.0.gir b/GioUnix-2.0.gir index e181b183..941bc1c7 100644 --- a/GioUnix-2.0.gir +++ b/GioUnix-2.0.gir @@ -8,13 +8,13 @@ and/or use gtk-doc annotations. --> - - - - - - + + + + + + @@ -1174,43 +1174,45 @@ when the stream is closed. Defines a Unix mount entry (e.g. `/media/cdrom`). This corresponds roughly to a mtab entry. - 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_mount_entries_changed_since(). + Gets a [struct@GioUnix.MountEntry] 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 +[func@GioUnix.mount_entries_changed_since]. If more mounts have the same mount path, the last matching mount is returned. -This will return %NULL if there is no mount point at @mount_path. +This will return `NULL` if there is no mount point at @mount_path. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - path for a possible unix mount. + path for a possible Unix mount - guint64 to contain a timestamp. + return location for a timestamp - Compares two unix mounts. + Compares two Unix mounts. - 1, 0 or -1 if @mount1 is greater than, equal to, -or less than @mount2, respectively. + `1`, `0` or `-1` if @mount1 is greater than, equal to, + or less than @mount2, respectively - first #GUnixMountEntry to compare. + first [struct@GioUnix.MountEntry] to compare - second #GUnixMountEntry to compare. + second [struct@GioUnix.MountEntry] to compare @@ -1218,106 +1220,109 @@ or less than @mount2, respectively. Makes a copy of @mount_entry. - a new #GUnixMountEntry + a new [struct@GioUnix.MountEntry] - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - 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_mount_entries_changed_since(). + Gets a [struct@GioUnix.MountEntry] 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 +[func@GioUnix.mount_entries_changed_since]. If more mounts have the same mount path, the last matching mount is returned. -This will return %NULL if looking up the mount entry fails, if +This will return `NULL` if looking up the mount entry fails, if @file_path doesn’t exist or there is an I/O error. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - file path on some unix mount. + file path on some Unix mount - guint64 to contain a timestamp. + return location for a timestamp - Frees a unix mount. + Frees a Unix mount. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - 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 [struct@GioUnix.MountEntry] - 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 [struct@GioUnix.MountEntry] - 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. + a [struct@GioUnix.MountEntry] to get the mount path for - Gets a comma-separated list of mount options for the unix mount. For example, -`rw,relatime,seclabel,data=ordered`. + Gets a comma separated list of mount options for the Unix mount. -This is similar to g_unix_mount_point_get_options(), but it takes -a #GUnixMountEntry as an argument. +For example: `rw,relatime,seclabel,data=ordered`. + +This is similar to [func@GioUnix.MountPoint.get_options], but it takes +a [struct@GioUnix.MountEntry] as an argument. - a string containing the options, or %NULL if not -available. + a string containing the options, or `NULL` if not + available. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] @@ -1326,144 +1331,153 @@ available. 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 -"mount /dev/sda1 /mnt/foo" and "/bar" for -"mount --bind /mnt/foo/bar /mnt/bar". +For example, the root path is equal to `/` for a mount created by +`mount /dev/sda1 /mnt/foo` and `/bar` for +`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 [struct@GioUnix.MountEntry] - Guesses whether a Unix mount can be ejected. + Guesses whether a Unix mount entry can be ejected. - %TRUE if @mount_entry is deemed to be ejectable. + true if @mount_entry is deemed to be ejectable; false otherwise - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses the icon of a Unix mount. + Guesses the icon of a Unix mount entry. - a #GIcon + a [iface@Gio.Icon] - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses the name of a Unix mount. + Guesses the name of a Unix mount entry. + The result is a translated string. - A newly allocated string that must - be freed with g_free() + a newly allocated translated string - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses whether a Unix mount should be displayed in the UI. + Guesses whether a Unix mount entry should be displayed in the UI. - %TRUE if @mount_entry is deemed to be displayable. + true if @mount_entry is deemed to be displayable; false otherwise - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses the symbolic icon of a Unix mount. + Guesses the symbolic icon of a Unix mount entry. - a #GIcon + a [iface@Gio.Icon] - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - 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; false otherwise - a #GUnixMount. + a [struct@GioUnix.MountEntry] - 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. + Checks if a Unix mount is a system mount. + +This is the Boolean OR of +[func@GioUnix.is_system_fs_type], [func@GioUnix.is_system_device_path] and +[func@GioUnix.is_mount_path_system_internal] on @mount_entry’s properties. The definition of what a ‘system’ mount entry is may change over time as new 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; false otherwise - a #GUnixMount. + a [struct@GioUnix.MountEntry] - Watches #GUnixMounts for changes. + Watches for changes to the set of mount entries and mount points in the +system. + +Connect to the [signal@GioUnix.MountMonitor::mounts-changed] signal to be +notified of changes to the [struct@GioUnix.MountEntry] list. + +Connect to the [signal@GioUnix.MountMonitor::mountpoints-changed] signal to +be notified of changes to the [struct@GioUnix.MountPoint] list. - Deprecated alias for g_unix_mount_monitor_get(). + Deprecated alias for [func@GioUnix.MountMonitor.get]. This function was never a true constructor, which is why it was renamed. - Use g_unix_mount_monitor_get() instead. + Use [func@GioUnix.MountMonitor.get] instead. - a #GUnixMountMonitor. + a [class@GioUnix.MountMonitor] - Gets the #GUnixMountMonitor for the current thread-default main + Gets the [class@GioUnix.MountMonitor] for the current thread-default main context. The mount monitor can be used to monitor for changes to the list of mounted filesystems as well as the list of mount points (ie: fstab entries). -You must only call g_object_unref() on the return value from under -the same main context as you called this function. +You must only call [method@GObject.Object.unref] on the return value from +under the same main context as you called this function. - the #GUnixMountMonitor. + the [class@GioUnix.MountMonitor] @@ -1475,30 +1489,29 @@ rate at which events would be reported under some uncommon circumstances. Since @mount_monitor is a singleton, it also meant that calling this function would have side effects for other users of the monitor. - This function does nothing. Don't call it. + This function does nothing. Don’t call it. - a #GUnixMountMonitor + a [class@GioUnix.MountMonitor] - a integer with the limit in milliseconds to - poll for changes. + 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 mount entries have changed. @@ -1509,42 +1522,44 @@ the monitor. Defines a Unix mount point (e.g. `/dev`). This corresponds roughly to a fstab entry. - Gets a #GUnixMountPoint for a given mount path. If @time_read is set, it -will be filled with a unix timestamp for checking if the mount points have -changed since with g_unix_mount_points_changed_since(). + Gets a [struct@GioUnix.MountPoint] for a given mount path. + +If @time_read is set, it will be filled with a Unix timestamp for checking if +the mount points have changed since with +[func@GioUnix.mount_points_changed_since]. If more mount points have the same mount path, the last matching mount point is returned. - a #GUnixMountPoint, or %NULL if no match -is found. + a [struct@GioUnix.MountPoint], or `NULL` + if no match is found - path for a possible unix mount point. + path for a possible Unix mount point - guint64 to contain a timestamp. + return location for a timestamp - Compares two unix mount points. + Compares two Unix mount points. - 1, 0 or -1 if @mount1 is greater than, equal to, -or less than @mount2, respectively. + `1`, `0` or `-1` if @mount1 is greater than, equal to, + or less than @mount2, respectively - a #GUnixMount. + a [struct@GioUnix.MountPoint] - a #GUnixMount. + a [struct@GioUnix.MountPoint] @@ -1552,37 +1567,37 @@ or less than @mount2, respectively. Makes a copy of @mount_point. - a new #GUnixMountPoint + a new [struct@GioUnix.MountPoint] - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] - Frees a unix mount point. + Frees a Unix mount point. - unix mount point to free. + Unix mount point to free. - Gets the device path for a unix mount point. + Gets the device path for a Unix mount point. - a string containing the device path. + a string containing the device path - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] @@ -1590,25 +1605,25 @@ or less than @mount2, respectively. Gets the file system type for the mount point. - a string containing the file system type. + a string containing the file system type - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] - Gets the mount path for a unix mount point. + Gets the mount path for a Unix mount point. - a string containing the mount path. + a string containing the mount path - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] @@ -1616,12 +1631,12 @@ or less than @mount2, respectively. Gets the options for the mount point. - a string containing the options. + a string containing the options - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] @@ -1629,12 +1644,12 @@ or less than @mount2, respectively. Guesses whether a Unix mount point can be ejected. - %TRUE if @mount_point is deemed to be ejectable. + true if @mount_point is deemed to be ejectable; false otherwise - a #GUnixMountPoint + a [struct@GioUnix.MountPoint] @@ -1642,27 +1657,27 @@ or less than @mount2, respectively. Guesses the icon of a Unix mount point. - a #GIcon + a [iface@Gio.Icon] - a #GUnixMountPoint + a [struct@GioUnix.MountPoint] 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 newly allocated translated string - a #GUnixMountPoint + a [struct@GioUnix.MountPoint] @@ -1670,51 +1685,51 @@ The result is a translated string. Guesses the symbolic icon of a Unix mount point. - a #GIcon + a [iface@Gio.Icon] - a #GUnixMountPoint + a [struct@GioUnix.MountPoint] - Checks if a unix mount point is a loopback device. + Checks if a Unix mount point is a loopback device. - %TRUE if the mount point is a loopback. %FALSE otherwise. + true if the mount point is a loopback device; false otherwise - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] - Checks if a unix mount point is read only. + Checks if a Unix mount point is read only. - %TRUE if a mount point is read only. + true if a mount point is read only; false otherwise - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] - Checks if a unix mount point is mountable by the user. + Checks if a Unix mount point is mountable by the user. - %TRUE if the mount point is user mountable. + true if the mount point is user mountable; false otherwise - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] @@ -1913,12 +1928,14 @@ directly. Applications should use Determines if @mount_path is considered an implementation of the -OS. This is primarily used for hiding mountable and mounted volumes +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 - of the OS. + true if @mount_path is considered an implementation detail + of the OS; false otherwise @@ -1930,15 +1947,17 @@ casual user. 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, -appear in a GUI. For example, the Linux `/proc` filesystem. +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, 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 - the OS. + true if @device_path is considered an implementation detail of + the OS; false otherwise @@ -1950,14 +1969,17 @@ The list of device paths considered ‘system’ ones may change over 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, -appear in a GUI. For example, the Linux `/proc` filesystem. +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, 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; + false otherwise @@ -1968,92 +1990,106 @@ The list of file system types considered ‘system’ ones may change - 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_mount_entries_changed_since(). + Gets a [struct@GioUnix.MountEntry] 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 +[func@GioUnix.mount_entries_changed_since]. If more mounts have the same mount path, the last matching mount is returned. -This will return %NULL if there is no mount point at @mount_path. - Use g_unix_mount_entry_at() instead. +This will return `NULL` if there is no mount point at @mount_path. + Use [func@GioUnix.MountEntry.at] instead. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - path for a possible unix mount. + path for a possible Unix mount - guint64 to contain a timestamp. + return location for a timestamp - Compares two unix mounts. - Use g_unix_mount_entry_compare() instead. + Compares two Unix mounts. + Use [func@GioUnix.MountEntry.compare] instead. - 1, 0 or -1 if @mount1 is greater than, equal to, -or less than @mount2, respectively. + `1`, `0` or `-1` if @mount1 is greater than, equal to, + or less than @mount2, respectively - first #GUnixMountEntry to compare. + first [struct@GioUnix.MountEntry] to compare - second #GUnixMountEntry to compare. + second [struct@GioUnix.MountEntry] to compare Makes a copy of @mount_entry. - Use g_unix_mount_entry_copy() instead. + Use [func@GioUnix.MountEntry.copy] instead. - a new #GUnixMountEntry + a new [struct@GioUnix.MountEntry] - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - Checks if the unix mounts have changed since a given unix time. + Checks if the Unix mounts have changed since a given Unix time. + +This can only work reliably if a [class@GioUnix.MountMonitor] is running in +the process, otherwise changes in the mount entries file (such as +`/proc/self/mountinfo` on Linux) cannot be detected and, as a result, this +function has to conservatively always return `TRUE`. + +It is more efficient to use [signal@GioUnix.MountMonitor::mounts-changed] to +be signalled of changes to the mount entries, rather than polling using this +function. This function is more appropriate for infrequently determining +cache validity. - %TRUE if the mounts have changed since @time. + true if the mounts have changed since @time; false otherwise Since 2.84 - guint64 to contain a timestamp. + a timestamp - 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_mount_entries_changed_since(). + Gets a list of [struct@GioUnix.MountEntry] instances representing 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 +[func@GioUnix.mount_entries_changed_since]. - - a #GList of the UNIX mounts. + a list of the + Unix mounts - guint64 to contain a timestamp, or %NULL + return location for a timestamp @@ -2062,10 +2098,10 @@ with g_unix_mount_entries_changed_since(). Gets an array of [struct@Gio.UnixMountEntry]s containing the Unix mounts listed in @table_path. -This is a generalized version of g_unix_mount_entries_get(), mainly intended for -internal testing use. Note that g_unix_mount_entries_get() may parse multiple -hierarchical table files, so this function is not a direct superset of its -functionality. +This is a generalized version of [func@GioUnix.mount_entries_get], mainly +intended for internal testing use. Note that [func@GioUnix.mount_entries_get] +may parse multiple hierarchical table files, so this function is not a direct +superset of its functionality. If there is an error reading or parsing the file, `NULL` will be returned and both out parameters will be set to `0`. @@ -2094,43 +2130,45 @@ and both out parameters will be set to `0`. - 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_mount_entries_changed_since(). + Gets a [struct@GioUnix.MountEntry] 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 +[func@GioUnix.mount_entries_changed_since]. If more mounts have the same mount path, the last matching mount is returned. -This will return %NULL if there is no mount point at @mount_path. +This will return `NULL` if there is no mount point at @mount_path. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - path for a possible unix mount. + path for a possible Unix mount - guint64 to contain a timestamp. + return location for a timestamp - Compares two unix mounts. + Compares two Unix mounts. - 1, 0 or -1 if @mount1 is greater than, equal to, -or less than @mount2, respectively. + `1`, `0` or `-1` if @mount1 is greater than, equal to, + or less than @mount2, respectively - first #GUnixMountEntry to compare. + first [struct@GioUnix.MountEntry] to compare - second #GUnixMountEntry to compare. + second [struct@GioUnix.MountEntry] to compare @@ -2138,106 +2176,109 @@ or less than @mount2, respectively. Makes a copy of @mount_entry. - a new #GUnixMountEntry + a new [struct@GioUnix.MountEntry] - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - 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_mount_entries_changed_since(). + Gets a [struct@GioUnix.MountEntry] 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 +[func@GioUnix.mount_entries_changed_since]. If more mounts have the same mount path, the last matching mount is returned. -This will return %NULL if looking up the mount entry fails, if +This will return `NULL` if looking up the mount entry fails, if @file_path doesn’t exist or there is an I/O error. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - file path on some unix mount. + file path on some Unix mount - guint64 to contain a timestamp. + return location for a timestamp - Frees a unix mount. + Frees a Unix mount. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - 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 [struct@GioUnix.MountEntry] - 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 [struct@GioUnix.MountEntry] - 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. + a [struct@GioUnix.MountEntry] to get the mount path for - Gets a comma-separated list of mount options for the unix mount. For example, -`rw,relatime,seclabel,data=ordered`. + Gets a comma separated list of mount options for the Unix mount. -This is similar to g_unix_mount_point_get_options(), but it takes -a #GUnixMountEntry as an argument. +For example: `rw,relatime,seclabel,data=ordered`. + +This is similar to [func@GioUnix.MountPoint.get_options], but it takes +a [struct@GioUnix.MountEntry] as an argument. - a string containing the options, or %NULL if not -available. + a string containing the options, or `NULL` if not + available. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] @@ -2246,214 +2287,219 @@ available. 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 -"mount /dev/sda1 /mnt/foo" and "/bar" for -"mount --bind /mnt/foo/bar /mnt/bar". +For example, the root path is equal to `/` for a mount created by +`mount /dev/sda1 /mnt/foo` and `/bar` for +`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 [struct@GioUnix.MountEntry] - Guesses whether a Unix mount can be ejected. + Guesses whether a Unix mount entry can be ejected. - %TRUE if @mount_entry is deemed to be ejectable. + true if @mount_entry is deemed to be ejectable; false otherwise - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses the icon of a Unix mount. + Guesses the icon of a Unix mount entry. - a #GIcon + a [iface@Gio.Icon] - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses the name of a Unix mount. + Guesses the name of a Unix mount entry. + The result is a translated string. - A newly allocated string that must - be freed with g_free() + a newly allocated translated string - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses whether a Unix mount should be displayed in the UI. + Guesses whether a Unix mount entry should be displayed in the UI. - %TRUE if @mount_entry is deemed to be displayable. + true if @mount_entry is deemed to be displayable; false otherwise - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses the symbolic icon of a Unix mount. + Guesses the symbolic icon of a Unix mount entry. - a #GIcon + a [iface@Gio.Icon] - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - 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; false otherwise - a #GUnixMount. + a [struct@GioUnix.MountEntry] - 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. + Checks if a Unix mount is a system mount. + +This is the Boolean OR of +[func@GioUnix.is_system_fs_type], [func@GioUnix.is_system_device_path] and +[func@GioUnix.is_mount_path_system_internal] on @mount_entry’s properties. The definition of what a ‘system’ mount entry is may change over time as new 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; false otherwise - a #GUnixMount. + a [struct@GioUnix.MountEntry] - 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_mount_entries_changed_since(). + Gets a [struct@GioUnix.MountEntry] 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 +[func@GioUnix.mount_entries_changed_since]. If more mounts have the same mount path, the last matching mount is returned. -This will return %NULL if looking up the mount entry fails, if +This will return `NULL` if looking up the mount entry fails, if @file_path doesn’t exist or there is an I/O error. - Use g_unix_mount_entry_for() instead. + Use [func@GioUnix.MountEntry.for] instead. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - file path on some unix mount. + file path on some Unix mount - guint64 to contain a timestamp. + return location for a timestamp - Frees a unix mount. - Use g_unix_mount_entry_free() instead. + Frees a Unix mount. + Use [func@GioUnix.MountEntry.free] instead. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - Gets the device path for a unix mount. - Use g_unix_mount_entry_get_device_path() instead. + Gets the device path for a Unix mount. + Use [func@GioUnix.MountEntry.get_device_path] instead. - a string containing the device path. + a string containing the device path - a #GUnixMount. + a [struct@GioUnix.MountEntry] - Gets the filesystem type for the unix mount. - Use g_unix_mount_entry_get_fs_type() instead. + Gets the filesystem type for the Unix mount. + Use [func@GioUnix.MountEntry.get_fs_type] instead. - a string containing the file system type. + a string containing the file system type - a #GUnixMount. + a [struct@GioUnix.MountEntry] - Gets the mount path for a unix mount. - Use g_unix_mount_entry_get_mount_path() instead. + Gets the mount path for a Unix mount. + Use [func@GioUnix.MountEntry.get_mount_path] instead. - the mount path for @mount_entry. + the mount path for @mount_entry - input #GUnixMountEntry to get the mount path for. + a [struct@GioUnix.MountEntry] to get the mount path for - Gets a comma-separated list of mount options for the unix mount. For example, -`rw,relatime,seclabel,data=ordered`. + Gets a comma separated list of mount options for the Unix mount. -This is similar to g_unix_mount_point_get_options(), but it takes -a #GUnixMountEntry as an argument. - Use g_unix_mount_entry_get_options() instead. +For example: `rw,relatime,seclabel,data=ordered`. + +This is similar to [func@GioUnix.MountPoint.get_options], but it takes +a [struct@GioUnix.MountEntry] as an argument. + Use [func@GioUnix.MountEntry.get_options] instead. - a string containing the options, or %NULL if not -available. + a string containing the options, or `NULL` if not + available. - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] @@ -2462,163 +2508,167 @@ available. 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 -"mount /dev/sda1 /mnt/foo" and "/bar" for -"mount --bind /mnt/foo/bar /mnt/bar". - Use g_unix_mount_entry_get_root_path() instead. +For example, the root path is equal to `/` for a mount created by +`mount /dev/sda1 /mnt/foo` and `/bar` for +`mount --bind /mnt/foo/bar /mnt/bar`. + Use [func@GioUnix.MountEntry.get_root_path] instead. - a string containing the root, or %NULL if not supported. + a string containing the root, or `NULL` if not supported - a #GUnixMountEntry. + a [struct@GioUnix.MountEntry] - Guesses whether a Unix mount can be ejected. - Use g_unix_mount_entry_guess_can_eject() instead. + Guesses whether a Unix mount entry can be ejected. + Use [func@GioUnix.MountEntry.guess_can_eject] instead. - %TRUE if @mount_entry is deemed to be ejectable. + true if @mount_entry is deemed to be ejectable; false otherwise - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses the icon of a Unix mount. - Use g_unix_mount_entry_guess_icon() instead. + Guesses the icon of a Unix mount entry. + Use [func@GioUnix.MountEntry.guess_icon] instead. - a #GIcon + a [iface@Gio.Icon] - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses the name of a Unix mount. + Guesses the name of a Unix mount entry. + The result is a translated string. - Use g_unix_mount_entry_guess_name() instead. + Use [func@GioUnix.MountEntry.guess_name] instead. - A newly allocated string that must - be freed with g_free() + a newly allocated translated string - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses whether a Unix mount should be displayed in the UI. - Use g_unix_mount_entry_guess_should_display() instead. + Guesses whether a Unix mount entry should be displayed in the UI. + Use [func@GioUnix.MountEntry.guess_should_display] instead. - %TRUE if @mount_entry is deemed to be displayable. + true if @mount_entry is deemed to be displayable; false otherwise - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Guesses the symbolic icon of a Unix mount. - Use g_unix_mount_entry_guess_symbolic_icon() instead. + Guesses the symbolic icon of a Unix mount entry. + Use [func@GioUnix.MountEntry.guess_symbolic_icon] instead. - a #GIcon + a [iface@Gio.Icon] - a #GUnixMountEntry + a [struct@GioUnix.MountEntry] - Checks if a unix mount is mounted read only. - Use g_unix_mount_entry_is_readonly() instead. + Checks if a Unix mount is mounted read only. + Use [func@GioUnix.MountEntry.is_readonly] instead. - %TRUE if @mount_entry is read only. + true if @mount_entry is read only; false otherwise - a #GUnixMount. + a [struct@GioUnix.MountEntry] - 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. + Checks if a Unix mount is a system mount. + +This is the Boolean OR of +[func@GioUnix.is_system_fs_type], [func@GioUnix.is_system_device_path] and +[func@GioUnix.is_mount_path_system_internal] on @mount_entry’s properties. The definition of what a ‘system’ mount entry is may change over time as new file system types and device paths are ignored. - Use g_unix_mount_entry_is_system_internal() instead. + Use [func@GioUnix.MountEntry.is_system_internal] instead. - %TRUE if the unix mount is for a system path. + true if the Unix mount is for a system path; false otherwise - a #GUnixMount. + a [struct@GioUnix.MountEntry] - Gets a #GUnixMountPoint for a given mount path. If @time_read is set, it -will be filled with a unix timestamp for checking if the mount points have -changed since with g_unix_mount_points_changed_since(). + Gets a [struct@GioUnix.MountPoint] for a given mount path. + +If @time_read is set, it will be filled with a Unix timestamp for checking if +the mount points have changed since with +[func@GioUnix.mount_points_changed_since]. If more mount points have the same mount path, the last matching mount point is returned. - a #GUnixMountPoint, or %NULL if no match -is found. + a [struct@GioUnix.MountPoint], or `NULL` + if no match is found - path for a possible unix mount point. + path for a possible Unix mount point - guint64 to contain a timestamp. + return location for a timestamp - Compares two unix mount points. + Compares two Unix mount points. - 1, 0 or -1 if @mount1 is greater than, equal to, -or less than @mount2, respectively. + `1`, `0` or `-1` if @mount1 is greater than, equal to, + or less than @mount2, respectively - a #GUnixMount. + a [struct@GioUnix.MountPoint] - a #GUnixMount. + a [struct@GioUnix.MountPoint] @@ -2626,37 +2676,37 @@ or less than @mount2, respectively. Makes a copy of @mount_point. - a new #GUnixMountPoint + a new [struct@GioUnix.MountPoint] - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] - Frees a unix mount point. + Frees a Unix mount point. - unix mount point to free. + Unix mount point to free. - Gets the device path for a unix mount point. + Gets the device path for a Unix mount point. - a string containing the device path. + a string containing the device path - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] @@ -2664,25 +2714,25 @@ or less than @mount2, respectively. Gets the file system type for the mount point. - a string containing the file system type. + a string containing the file system type - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] - Gets the mount path for a unix mount point. + Gets the mount path for a Unix mount point. - a string containing the mount path. + a string containing the mount path - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] @@ -2690,12 +2740,12 @@ or less than @mount2, respectively. Gets the options for the mount point. - a string containing the options. + a string containing the options - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] @@ -2703,12 +2753,12 @@ or less than @mount2, respectively. Guesses whether a Unix mount point can be ejected. - %TRUE if @mount_point is deemed to be ejectable. + true if @mount_point is deemed to be ejectable; false otherwise - a #GUnixMountPoint + a [struct@GioUnix.MountPoint] @@ -2716,27 +2766,27 @@ or less than @mount2, respectively. Guesses the icon of a Unix mount point. - a #GIcon + a [iface@Gio.Icon] - a #GUnixMountPoint + a [struct@GioUnix.MountPoint] 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 newly allocated translated string - a #GUnixMountPoint + a [struct@GioUnix.MountPoint] @@ -2744,83 +2794,95 @@ The result is a translated string. Guesses the symbolic icon of a Unix mount point. - a #GIcon + a [iface@Gio.Icon] - a #GUnixMountPoint + a [struct@GioUnix.MountPoint] - Checks if a unix mount point is a loopback device. + Checks if a Unix mount point is a loopback device. - %TRUE if the mount point is a loopback. %FALSE otherwise. + true if the mount point is a loopback device; false otherwise - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] - Checks if a unix mount point is read only. + Checks if a Unix mount point is read only. - %TRUE if a mount point is read only. + true if a mount point is read only; false otherwise - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] - Checks if a unix mount point is mountable by the user. + Checks if a Unix mount point is mountable by the user. - %TRUE if the mount point is user mountable. + true if the mount point is user mountable; false otherwise - a #GUnixMountPoint. + a [struct@GioUnix.MountPoint] - 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. + +Unlike [func@GioUnix.mount_entries_changed_since], this function can work +reliably without a [class@GioUnix.MountMonitor] running, as it accesses the +static mount point information (such as `/etc/fstab` on Linux), which has a +valid modification time. + +It is more efficient to use [signal@GioUnix.MountMonitor::mountpoints-changed] +to be signalled of changes to the mount points, rather than polling using +this function. This function is more appropriate for infrequently determining +cache validity. - %TRUE if the mount points have changed since @time. + true if the mount points have changed since @time; false otherwise - guint64 to contain a timestamp. + a timestamp - 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(). + Gets a list of [struct@GioUnix.MountPoint] instances representing 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 +[func@GioUnix.mount_points_changed_since]. - - a #GList of the UNIX mountpoints. + a list of the Unix + mount points - guint64 to contain a timestamp. + return location for a timestamp @@ -2829,10 +2891,10 @@ g_unix_mount_points_changed_since(). Gets an array of [struct@Gio.UnixMountPoint]s containing the Unix mount points listed in @table_path. -This is a generalized version of g_unix_mount_points_get(), mainly intended -for internal testing use. Note that g_unix_mount_points_get() may parse -multiple hierarchical table files, so this function is not a direct superset -of its functionality. +This is a generalized version of [func@GioUnix.mount_points_get], mainly +intended for internal testing use. Note that [func@GioUnix.mount_points_get] +may parse multiple hierarchical table files, so this function is not a direct +superset of its functionality. If there is an error reading or parsing the file, `NULL` will be returned and both out parameters will be set to `0`. @@ -2861,35 +2923,37 @@ and both out parameters will be set to `0`. - Checks if the unix mounts have changed since a given unix time. - Use g_unix_mount_entry_free() instead. + Checks if the Unix mounts have changed since a given Unix time. + Use [func@GioUnix.mount_entries_changed_since] instead. - %TRUE if the mounts have changed since @time. + true if the mounts have changed since @time; false otherwise - guint64 to contain a timestamp. + a timestamp - 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_mount_entries_changed_since(). - Use g_unix_mount_entries_get() instead. + Gets a list of [struct@GioUnix.MountEntry] instances representing 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 +[func@GioUnix.mount_entries_changed_since]. + Use [func@GioUnix.mount_entries_get] instead. - - a #GList of the UNIX mounts. + a list of the + Unix mounts - guint64 to contain a timestamp, or %NULL + return location for a timestamp @@ -2898,14 +2962,14 @@ with g_unix_mount_entries_changed_since(). Gets an array of [struct@Gio.UnixMountEntry]s containing the Unix mounts listed in @table_path. -This is a generalized version of g_unix_mount_entries_get(), mainly intended for -internal testing use. Note that g_unix_mount_entries_get() may parse multiple -hierarchical table files, so this function is not a direct superset of its -functionality. +This is a generalized version of [func@GioUnix.mount_entries_get], mainly +intended for internal testing use. Note that [func@GioUnix.mount_entries_get] +may parse multiple hierarchical table files, so this function is not a direct +superset of its functionality. If there is an error reading or parsing the file, `NULL` will be returned and both out parameters will be set to `0`. - Use g_unix_mount_entries_get_from_file() instead. + Use [func@GioUnix.mount_entries_get_from_file] instead. mount entries, or `NULL` if there was an error loading them diff --git a/Gtk-4.0.gir b/Gtk-4.0.gir index a3a83587..13f93bd8 100644 --- a/Gtk-4.0.gir +++ b/Gtk-4.0.gir @@ -398,8 +398,7 @@ set or retrieved. - The `GtkAboutDialog` offers a simple way to display information about -a program. + A simple way to display information about a program. The shown information includes the programs' logo, name, copyright, website and license. It is also possible to give credits to the authors, @@ -419,14 +418,14 @@ To specify a person with an email address, use a string like `Edgar Allan Poe <edgar@poe.com>`. To specify a website with a title, use a string like `GTK team https://www.gtk.org`. -To make constructing a `GtkAboutDialog` as convenient as possible, you can +To make constructing an about dialog as convenient as possible, you can use the function [func@Gtk.show_about_dialog] which constructs and shows a dialog and keeps it around so that it can be shown again. Note that GTK sets a default title of `_("About %s")` on the dialog window (where `%s` is replaced by the name of the application, but in order to ensure proper translation of the title, applications should -set the title property explicitly when constructing a `GtkAboutDialog`, +set the title property explicitly when constructing an about dialog, as shown in the following example: ```c @@ -471,7 +470,7 @@ class `.aboutdialog`. - A `GtkAboutDialog` + an about dialog @@ -479,7 +478,7 @@ class `.aboutdialog`. - The people who belong to that section + the people who belong to that section @@ -498,7 +497,7 @@ in the credits page. - a `GtkAboutDialog` + an about dialog @@ -515,7 +514,7 @@ in the credits page. - a `GtkAboutDialog` + an about dialog @@ -528,7 +527,7 @@ in the credits page. - a `GtkAboutDialog` + an about dialog @@ -541,7 +540,7 @@ in the credits page. - a `GtkAboutDialog` + an about dialog @@ -558,7 +557,7 @@ in the credits page. - a `GtkAboutDialog` + an about dialog @@ -571,7 +570,7 @@ in the credits page. - a `GtkAboutDialog` + an about dialog @@ -584,7 +583,7 @@ in the credits page. - a `GtkAboutDialog` + an about dialog @@ -599,7 +598,7 @@ in the credits page. - a `GtkAboutDialog` + an about dialog @@ -613,7 +612,7 @@ in the credits page. - a `GtkAboutDialog` + an about dialog @@ -621,12 +620,12 @@ in the credits page. Returns the program name displayed in the about dialog. - The program name + the program name - a `GtkAboutDialog` + an about dialog @@ -639,7 +638,7 @@ in the credits page. - a `GtkAboutDialog` + an about dialog @@ -653,7 +652,7 @@ in the credits page. - a `GtkAboutDialog` + an about dialog @@ -666,7 +665,7 @@ in the credits page. - a `GtkAboutDialog` + an about dialog @@ -679,7 +678,7 @@ in the credits page. - a `GtkAboutDialog` + an about dialog @@ -692,7 +691,7 @@ in the credits page. - a `GtkAboutDialog` + an about dialog @@ -706,7 +705,7 @@ automatically wrapped. - a `GtkAboutDialog` + an about dialog @@ -719,7 +718,7 @@ in the "Credits" page. - a `GtkAboutDialog` + an about dialog @@ -739,7 +738,7 @@ in the "Credits" page of the about dialog. - a `GtkAboutDialog` + an about dialog @@ -759,7 +758,7 @@ This should be a short string of one or two lines. - a `GtkAboutDialog` + an about dialog @@ -777,7 +776,7 @@ This should be a short string of one or two lines. - a `GtkAboutDialog` + an about dialog @@ -794,7 +793,7 @@ in the "Credits" page. - a `GtkAboutDialog` + an about dialog @@ -816,7 +815,7 @@ If `license` is `NULL`, the license page is hidden. - a `GtkAboutDialog` + an about dialog @@ -826,8 +825,8 @@ If `license` is `NULL`, the license page is hidden. - Sets the license of the application showing the about dialog from a -list of known licenses. + Sets the license of the application showing the about dialog +from a list of known licenses. This function overrides the license set using [method@Gtk.AboutDialog.set_license]. @@ -836,7 +835,7 @@ This function overrides the license set using - a `GtkAboutDialog` + an about dialog @@ -852,7 +851,7 @@ This function overrides the license set using - a `GtkAboutDialog` + an about dialog @@ -868,7 +867,7 @@ This function overrides the license set using - a `GtkAboutDialog` + an about dialog @@ -887,7 +886,7 @@ by `g_get_application_name()` is used. - a `GtkAboutDialog` + an about dialog @@ -909,7 +908,7 @@ See [property@Gtk.AboutDialog:system-information]. - a `GtkAboutDialog` + an about dialog @@ -942,7 +941,7 @@ is untranslated and omit translator credits. - a `GtkAboutDialog` + an about dialog @@ -958,7 +957,7 @@ is untranslated and omit translator credits. - a `GtkAboutDialog` + an about dialog @@ -974,7 +973,7 @@ is untranslated and omit translator credits. - a `GtkAboutDialog` + an about dialog @@ -990,7 +989,7 @@ is untranslated and omit translator credits. - a `GtkAboutDialog` + an about dialog @@ -1007,7 +1006,7 @@ automatically wrapped. - a `GtkAboutDialog` + an about dialog @@ -1017,8 +1016,7 @@ automatically wrapped. - The people who contributed artwork to the program, as a `NULL`-terminated -array of strings. + The people who contributed artwork to the program. Each string may contain email addresses and URLs, which will be displayed as links. @@ -1027,7 +1025,7 @@ as links. - The authors of the program, as a `NULL`-terminated array of strings. + The authors of the program. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details. @@ -1048,7 +1046,7 @@ not a detailed list of features. - The people documenting the program, as a `NULL`-terminated array of strings. + The people documenting the program. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details. @@ -1066,7 +1064,7 @@ otherwise the text itself must contain the intended linebreaks. When setting this property to a non-`NULL` value, the [property@Gtk.AboutDialog:license-type] property is set to -`GTK_LICENSE_CUSTOM` as a side effect. +[enum@Gtk.License.custom] as a side effect. The text may contain links in this format `<http://www.some.place/>` and email references in the form `<mail-to@some.body>`, and these will @@ -1080,15 +1078,15 @@ The `GtkAboutDialog` will automatically fill out a standard disclaimer and link the user to the appropriate online resource for the license text. -If `GTK_LICENSE_UNKNOWN` is used, the link used will be the same +If [enum@Gtk.License.unknown] is used, the link used will be the same specified in the [property@Gtk.AboutDialog:website] property. -If `GTK_LICENSE_CUSTOM` is used, the current contents of the +If [enum@Gtk.License.custom] is used, the current contents of the [property@Gtk.AboutDialog:license] property are used. For any other [enum@Gtk.License] value, the contents of the -[property@Gtk.AboutDialog:license] property are also set by this property as -a side effect. +[property@Gtk.AboutDialog:license] property are also set by +this property as a side effect. @@ -1108,7 +1106,7 @@ This property overrides the [property@Gtk.AboutDialog:logo] property. The name of the program. If this is not set, it defaults to the value returned by -`g_get_application_name()`. +[func@GLib.get_application_name]. @@ -1168,8 +1166,7 @@ which is to call [method@Gtk.FileLauncher.launch]. - `GtkAccessible` is an interface for describing UI elements for -Assistive Technologies. + An interface for describing UI elements for Assistive Technologies. Every accessible implementation has: @@ -1207,20 +1204,20 @@ This function returns `NULL` for top level widgets. - a `GtkAccessible` + an accessible object - Retrieves the accessible implementation for the given `GtkAccessible`. + Retrieves the implementation for the given accessible object. the accessible implementation object - a `GtkAccessible` + an accessible object @@ -1237,7 +1234,7 @@ child widget. - a `GtkAccessible` + an accessible object @@ -1285,20 +1282,18 @@ child widget. - Query a platform state, such as focus. - -See gtk_accessible_platform_changed(). + Queries a platform state, such as focus. This functionality can be overridden by `GtkAccessible` implementations, e.g. to get platform state from an ignored child widget, as is the case for `GtkText` wrappers. - the value of @state for the accessible + the value of state for the accessible - a `GtkAccessible` + an accessible object @@ -1322,7 +1317,7 @@ does not interrupts the user's current screen reader output. - a `GtkAccessible` + an accessible object @@ -1345,7 +1340,7 @@ This function returns `NULL` for top level widgets. - a `GtkAccessible` + an accessible object @@ -1364,14 +1359,14 @@ This function returns `NULL` for top level widgets. - Retrieves the accessible implementation for the given `GtkAccessible`. + Retrieves the implementation for the given accessible object. the accessible implementation object - a `GtkAccessible` + an accessible object @@ -1388,7 +1383,7 @@ child widget. - a `GtkAccessible` + an accessible object @@ -1436,20 +1431,18 @@ child widget. - Query a platform state, such as focus. - -See gtk_accessible_platform_changed(). + Queries a platform state, such as focus. This functionality can be overridden by `GtkAccessible` implementations, e.g. to get platform state from an ignored child widget, as is the case for `GtkText` wrappers. - the value of @state for the accessible + the value of state for the accessible - a `GtkAccessible` + an accessible object @@ -1459,49 +1452,49 @@ child widget, as is the case for `GtkText` wrappers. - Resets the accessible @property to its default value. + Resets the accessible property to its default value. - a `GtkAccessible` + an accessible object - a `GtkAccessibleProperty` + the accessible property - Resets the accessible @relation to its default value. + Resets the accessible relation to its default value. - a `GtkAccessible` + an accessible object - a `GtkAccessibleRelation` + the accessible relation - Resets the accessible @state to its default value. + Resets the accessible state to its default value. - a `GtkAccessible` + an accessible object - a `GtkAccessibleState` + the accessible state @@ -1535,16 +1528,16 @@ object is the container widget. - Updates the next accessible sibling of @self. + Updates the next accessible sibling. -That might be useful when a new child of a custom `GtkAccessible` +That might be useful when a new child of a custom accessible is created, and it needs to be linked to a previous child. - a `GtkAccessible` + an accessible object @@ -1575,11 +1568,11 @@ gtk_accessible_update_property (GTK_ACCESSIBLE (spin_button), - a `GtkAccessible` + an accessible object - the first `GtkAccessibleProperty` + the first accessible property @@ -1600,7 +1593,7 @@ This function is meant to be used by language bindings. - a `GtkAccessible` + an accessible object @@ -1608,7 +1601,7 @@ This function is meant to be used by language bindings. - an array of `GtkAccessibleProperty` + an array of accessible properties @@ -1628,7 +1621,7 @@ This function should be called by `GtkWidget` types whenever an accessible relation change must be communicated to assistive technologies. If the [enum@Gtk.AccessibleRelation] requires a list of references, -you should pass each reference individually, followed by %NULL, e.g. +you should pass each reference individually, followed by `NULL`, e.g. ```c gtk_accessible_update_relation (accessible, @@ -1643,11 +1636,11 @@ gtk_accessible_update_relation (accessible, - a `GtkAccessible` + an accessible object - the first `GtkAccessibleRelation` + the first accessible relation @@ -1668,7 +1661,7 @@ This function is meant to be used by language bindings. - a `GtkAccessible` + an accessible object @@ -1676,7 +1669,7 @@ This function is meant to be used by language bindings. - an array of `GtkAccessibleRelation` + an array of accessible relations @@ -1690,11 +1683,14 @@ This function is meant to be used by language bindings. - Updates a list of accessible states. See the [enum@Gtk.AccessibleState] -documentation for the value types of accessible states. + Updates a list of accessible states. -This function should be called by `GtkWidget` types whenever an accessible -state change must be communicated to assistive technologies. +See the [enum@Gtk.AccessibleState] documentation for the +value types of accessible states. + +This function should be called by `GtkWidget` types whenever +an accessible state change must be communicated to assistive +technologies. Example: @@ -1709,11 +1705,11 @@ gtk_accessible_update_state (GTK_ACCESSIBLE (check_button), - a `GtkAccessible` + an accessible object - the first `GtkAccessibleState` + the first accessible state @@ -1734,7 +1730,7 @@ This function is meant to be used by language bindings. - a `GtkAccessible` + an accessible objedct @@ -1742,7 +1738,7 @@ This function is meant to be used by language bindings. - an array of `GtkAccessibleState` + an array of accessible states @@ -1821,7 +1817,7 @@ accessible property. - a `GtkAccessible` + an accessible object @@ -1831,12 +1827,12 @@ accessible property. retrieve the accessible state - the value of @state for the accessible + the value of state for the accessible - a `GtkAccessible` + an accessible object @@ -1854,7 +1850,7 @@ accessible property. - a `GtkAccessible` + an accessible object @@ -1896,7 +1892,7 @@ accessible property. - a `GtkAccessible` + an accessible object @@ -1942,34 +1938,35 @@ as %FALSE and %TRUE. A boxed type which wraps a list of references to GtkAccessible objects. - Allocates a new list of accessible instances. + Allocates a new list of accessible objects. - the newly created list of accessible instances + the newly created list of accessible objects - array of GtkAccessible + array of accessible objects - length of @accessibles array + length of the @accessibles array - Allocates a new `GtkAccessibleList`, doing a shallow copy of the -passed list of `GtkAccessible` instances. + Allocates a new `GtkAccessibleList`, doing a shallow copy +of the passed list of accessible objects - the list of accessible instances + the list of accessible objects - a reference to a `GList` containing a list of accessible values + a list + of accessible objects @@ -1977,9 +1974,10 @@ passed list of `GtkAccessible` instances. - Gets the list of objects this boxed type holds + Gets the list of objects this boxed type holds. - a shallow copy of the objects + a shallow copy + of the objects @@ -3760,7 +3758,7 @@ on the given widget upon activation. - `GtkAdjustment` is a model for a numeric value. + A model for a numeric value. The `GtkAdjustment` has an associated lower and upper bound. It also contains step and page increments, and a page size. @@ -3825,8 +3823,8 @@ it is left up to the owner of the `GtkAdjustment` to control the value. - Updates the value property to ensure that the range -between @lower and @upper is in the current page. + Updates the value of the adjustment to ensure that the +given range is contained in the current page. The current page goes from `value` to `value` + `page-size`. If the range is larger than the page size, then only the @@ -3839,7 +3837,7 @@ if the value is changed. - a `GtkAdjustment` + an adjustment @@ -3865,7 +3863,7 @@ way of compressing multiple emissions of - a `GtkAdjustment` + an adjustment @@ -3897,12 +3895,12 @@ way of compressing multiple emissions of Retrieves the minimum value of the adjustment. - The current minimum value of the adjustment + the minimum value - a `GtkAdjustment` + an adjustment @@ -3910,12 +3908,12 @@ way of compressing multiple emissions of Gets the smaller of step increment and page increment. - the minimum increment of @adjustment + the minimum increment - a `GtkAdjustment` + an adjustment @@ -3923,12 +3921,12 @@ way of compressing multiple emissions of Retrieves the page increment of the adjustment. - The current page increment of the adjustment + the page increment - a `GtkAdjustment` + an adjustment @@ -3936,12 +3934,12 @@ way of compressing multiple emissions of Retrieves the page size of the adjustment. - The current page size of the adjustment + the page size - a `GtkAdjustment` + an adjustment @@ -3949,12 +3947,12 @@ way of compressing multiple emissions of Retrieves the step increment of the adjustment. - The current step increment of the adjustment. + the step increment - a `GtkAdjustment` + an adjustment @@ -3962,12 +3960,12 @@ way of compressing multiple emissions of Retrieves the maximum value of the adjustment. - The current maximum value of the adjustment + the maximum value - a `GtkAdjustment` + an adjustment @@ -3975,12 +3973,12 @@ way of compressing multiple emissions of Gets the current value of the adjustment. - The current value of the adjustment + the current value - a `GtkAdjustment` + an adjustment @@ -4004,7 +4002,7 @@ to change, or using [method@Gtk.Adjustment.configure] has the same effect. - a `GtkAdjustment` + an adjustment @@ -4024,7 +4022,7 @@ signal when setting multiple adjustment properties. - a `GtkAdjustment` + an adjustment @@ -4044,7 +4042,7 @@ signal when setting multiple adjustment properties. - a `GtkAdjustment` + an adjustment @@ -4064,7 +4062,7 @@ signal when setting multiple adjustment properties. - a `GtkAdjustment` + an adjustment @@ -4087,7 +4085,7 @@ signal when setting multiple adjustment properties. - a `GtkAdjustment` + an adjustment @@ -4111,7 +4109,7 @@ the effective range of allowed values goes from - a `GtkAdjustment` + an adjustment @@ -19327,7 +19325,7 @@ since 2.10 - `GtkCenterBox` arranges three children in a row, keeping the middle child + Arranges three children in a row, keeping the middle child centered as well as possible. ![An example GtkCenterBox](centerbox.png) @@ -19358,9 +19356,10 @@ bottom. # Accessibility -Until GTK 4.10, `GtkCenterBox` used the `GTK_ACCESSIBLE_ROLE_GROUP` role. +Until GTK 4.10, `GtkCenterBox` used the [enum@Gtk.AccessibleRole.group] role. -Starting from GTK 4.12, `GtkCenterBox` uses the `GTK_ACCESSIBLE_ROLE_GENERIC` role. +Starting from GTK 4.12, `GtkCenterBox` uses the [enum@Gtk.AccessibleRole.generic] +role. @@ -19368,71 +19367,73 @@ Starting from GTK 4.12, `GtkCenterBox` uses the `GTK_ACCESSIBLE_ROLE_GENERIC` ro Creates a new `GtkCenterBox`. - the new `GtkCenterBox`. + the new `GtkCenterBox` - Gets the value set by gtk_center_box_set_baseline_position(). + Gets the baseline position of the center box. + +See [method@Gtk.CenterBox.set_baseline_position]. the baseline position - a `GtkCenterBox` + a center box - Gets the center widget, or %NULL if there is none. + Gets the center widget. - the center widget. + the center widget - a `GtkCenterBox` + a center box - Gets the end widget, or %NULL if there is none. + Gets the end widget. - the end widget. + the end widget - a `GtkCenterBox` + a center box - Gets whether @self shrinks the center widget after other children. + Gets whether the center widget shrinks after other children. whether to shrink the center widget after others - a `GtkCenterBox` + a center box - Gets the start widget, or %NULL if there is none. + Gets the start widget. - the start widget. + the start widget - a `GtkCenterBox` + a center box @@ -19443,18 +19444,18 @@ Starting from GTK 4.12, `GtkCenterBox` uses the `GTK_ACCESSIBLE_ROLE_GENERIC` ro This affects only horizontal boxes with at least one baseline aligned child. If there is more vertical space available than requested, and the baseline is not allocated by the parent then -@position is used to allocate the baseline wrt. the extra space -available. +@position is used to allocate the baseline with respect to the +extra space available. - a `GtkCenterBox` + a center box - a `GtkBaselinePosition` + the baseline position @@ -19462,13 +19463,13 @@ available. Sets the center widget. -To remove the existing center widget, pass %NULL. +To remove the existing center widget, pass `NULL`. - a `GtkCenterBox` + a center box @@ -19480,13 +19481,13 @@ To remove the existing center widget, pass %NULL. Sets the end widget. -To remove the existing end widget, pass %NULL. +To remove the existing end widget, pass `NULL`. - a `GtkCenterBox` + a center box @@ -19502,14 +19503,14 @@ By default, when there's no space to give all three children their natural widths, the start and end widgets start shrinking and the center child keeps natural width until they reach minimum width. -If set to `FALSE`, start and end widgets keep natural width and the -center widget starts shrinking instead. +If @shrink_center_last is false, start and end widgets keep natural +width and the center widget starts shrinking instead. - a `GtkCenterBox` + a cener box @@ -19521,13 +19522,13 @@ center widget starts shrinking instead. Sets the start widget. -To remove the existing start widget, pass %NULL. +To remove the existing start widget, pass `NULL`. - a `GtkCenterBox` + a center box @@ -19549,7 +19550,7 @@ To remove the existing start widget, pass %NULL. In vertical orientation, the end position is at the bottom. In horizontal orientation, the end position is at the trailing -edge wrt. to the text direction. +edge with respect to the text direction. @@ -19559,7 +19560,7 @@ By default, when there's no space to give all three children their natural widths, the start and end widgets start shrinking and the center child keeps natural width until they reach minimum width. -If set to `FALSE`, start and end widgets keep natural width and the +If false, start and end widgets keep natural width and the center widget starts shrinking instead. @@ -19568,7 +19569,7 @@ center widget starts shrinking instead. In vertical orientation, the start position is at the top. In horizontal orientation, the start position is at the leading -edge wrt. to the text direction. +edge with respect to the text direction. @@ -45527,7 +45528,7 @@ this signal. - `GtkHeaderBar` is a widget for creating custom title bars for windows. + A widget for creating custom title bars for windows. ![An example GtkHeaderBar](headerbar.png) @@ -45597,7 +45598,7 @@ Each of the boxes contains a `windowcontrols` subnode, see # Accessibility -`GtkHeaderBar` uses the %GTK_ACCESSIBLE_ROLE_GROUP role. +`GtkHeaderBar` uses the [enum@Gtk.AccessibleRole.group] role. @@ -45609,14 +45610,14 @@ Each of the boxes contains a `windowcontrols` subnode, see - Gets the decoration layout of the `GtkHeaderBar`. + Gets the decoration layout of the header bar. the decoration layout - a `GtkHeaderBar` + a header bar @@ -45625,67 +45626,65 @@ Each of the boxes contains a `windowcontrols` subnode, see Returns whether this header bar shows the standard window title buttons. - %TRUE if title buttons are shown + true if title buttons are shown - a `GtkHeaderBar` + a header bar - Retrieves the title widget of the header. + Retrieves the title widget of the header bar. See [method@Gtk.HeaderBar.set_title_widget]. - the title widget of the header + the title widget - a `GtkHeaderBar` + a header bar - Adds @child to @bar, packed with reference to the -end of the @bar. + Adds a child to the header bar, packed with reference to the end. - A `GtkHeaderBar` + A header bar - the `GtkWidget` to be added to @bar + the widget to be added to @bar - Adds @child to @bar, packed with reference to the -start of the @bar. + Adds a child to the header bar, packed with reference to the start. - A `GtkHeaderBar` + A header bar - the `GtkWidget` to be added to @bar + the widget to be added to @bar - Removes a child from the `GtkHeaderBar`. + Removes a child from the header bar. The child must have been added with [method@Gtk.HeaderBar.pack_start], @@ -45696,7 +45695,7 @@ The child must have been added with - a `GtkHeaderBar` + a header bar @@ -45728,11 +45727,11 @@ on the left, and minimize, maximize and close buttons on the right. - a `GtkHeaderBar` + a header bar - a decoration layout, or %NULL to unset the layout + a decoration layout @@ -45745,33 +45744,33 @@ title buttons. - a `GtkHeaderBar` + a header bar - %TRUE to show standard title buttons + true to show standard title buttons - Sets the title for the `GtkHeaderBar`. + Sets the title for the header bar. -When set to %NULL, the headerbar will display the title of +When set to `NULL`, the headerbar will display the title of the window it is contained in. The title should help a user identify the current view. To achieve the same style as the builtin title, use the “title” style class. -You should set the title widget to %NULL, for the window +You should set the title widget to `NULL`, for the window title label to be visible again. - a `GtkHeaderBar` + a header bar @@ -88556,6 +88555,8 @@ text[.read-only] ├── undershoot.left ├── undershoot.right ├── [selection] +├── [cursor-handle[.top] +├── [cursor-handle.bottom] ├── [block-cursor] ├── [cursor-handle[.top/.bottom][.insertion-cursor]] ╰── [window.popup] @@ -88607,13 +88608,13 @@ to accessibility. - the buffer to use for the new `GtkText`. + the buffer to use - Determine the positions of the strong and weak cursors for a + Determines the positions of the strong and weak cursors for a given character position. The position of each cursor is stored as a zero-width rectangle. @@ -89013,8 +89014,8 @@ keyword. Sets the input purpose of the text widget. -This can be used by on-screen keyboards and other -input methods to adjust their behaviour. +The input purpose can be used by on-screen keyboards +and other input methods to adjust their behaviour. @@ -89192,8 +89193,7 @@ to setting visibility to false. Unsets the invisible char. -After calling this, the default invisible -char is used again. +After calling this, the default invisible char is used again. @@ -89389,7 +89389,7 @@ This signal has no default bindings. - Emitted to present the Emoji chooser for the widget. + Emitted to present the Emoji chooser. This is a [keybinding signal](class.SignalAction.html). @@ -89409,8 +89409,8 @@ the viewport to be moved instead. This is a [keybinding signal](class.SignalAction.html). Applications should not connect to it, but may emit it with -g_signal_emit_by_name() if they need to control the cursor -programmatically. +[func@GObject.signal_emit_by_name] if they need to control +the cursor programmatically. The default bindings for this signal come in two variants, the variant with the <kbd>Shift</kbd> modifier extends the @@ -89467,7 +89467,7 @@ connect to this signal. - Emitted to toggle the overwrite mode of the `GtkText`. + Emitted to toggle the overwrite mode. This is a [keybinding signal](class.SignalAction.html). @@ -115109,7 +115109,7 @@ end up with an infinitely growing widget. - A `GtkWindow` is a toplevel window which can contain other widgets. + A toplevel window which can contain other widgets. ![An example GtkWindow](window.png) @@ -115177,9 +115177,9 @@ widget that is added as a titlebar child. # Accessibility -Until GTK 4.10, `GtkWindow` used the `GTK_ACCESSIBLE_ROLE_WINDOW` role. +Until GTK 4.10, `GtkWindow` used the [enum@Gtk.AccessibleRole.window] role. -Since GTK 4.12, `GtkWindow` uses the `GTK_ACCESSIBLE_ROLE_APPLICATION` role. +Since GTK 4.12, `GtkWindow` uses the [enum@Gtk.AccessibleRole.application] role. @@ -115189,18 +115189,18 @@ Since GTK 4.12, `GtkWindow` uses the `GTK_ACCESSIBLE_ROLE_APPLICATION` role. Creates a new `GtkWindow`. -To get an undecorated window (no window borders), use -[method@Gtk.Window.set_decorated]. +To get an undecorated window (without window borders), +use [method@Gtk.Window.set_decorated]. -All top-level windows created by gtk_window_new() are stored +All top-level windows created by this function are stored in an internal top-level window list. This list can be obtained from [func@Gtk.Window.list_toplevels]. Due to GTK keeping a -reference to the window internally, gtk_window_new() does not +reference to the window internally, this function does not return a reference to the caller. To delete a `GtkWindow`, call [method@Gtk.Window.destroy]. - a new `GtkWindow`. + a new `GtkWindow` @@ -115216,7 +115216,7 @@ be modified. It is only valid until the next call to - Returns a list of all existing toplevel windows. + Returns the list of all existing toplevel windows. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets or add new ones, be aware that @@ -115229,7 +115229,7 @@ the list of toplevels will change and emit the "items-changed" signal. - Returns a list of all existing toplevel windows. + Returns the list of all existing toplevel windows. The widgets in the list are not individually referenced. If you want to iterate through the list and perform actions @@ -115247,7 +115247,7 @@ and then unref all the widgets afterwards. Sets whether the window should request startup notification. -By default, after showing the first `GtkWindow`, GTK calls +By default, after showing the first window, GTK calls [method@Gdk.Toplevel.set_startup_id]. Call this function to disable the automatic startup notification. You might do this if your first window is a splash screen, and you want to delay @@ -115262,7 +115262,7 @@ showing the main window would automatically result in notification. - %TRUE to automatically do startup notification + true to automatically do startup notification @@ -115301,7 +115301,7 @@ you should not use this function. - %TRUE to enable interactive debugging + true to enable interactive debugging @@ -115329,8 +115329,9 @@ you should not use this function. - Class handler for the `GtkWindow::close-request` signal. + Class handler for the [signal@Window::close-request] signal. + Whether the window should be destroyed @@ -115379,25 +115380,25 @@ titlebars. - a `GtkWindow` + a window - Drop the internal reference GTK holds on toplevel windows. + Drops the internal reference GTK holds on toplevel windows. - The window to destroy + the window to destroy - Asks to place @window in the fullscreen state. + Asks to place the window in the fullscreen state. Note that you shouldn’t assume the window is definitely fullscreen afterward, because other entities (e.g. the user or window manager) @@ -115412,13 +115413,13 @@ notifications of the [property@Gtk.Window:fullscreened] property. - a `GtkWindow` + a window - Asks to place @window in the fullscreen state on the given @monitor. + Asks to place the window in the fullscreen state on the given monitor. Note that you shouldn't assume the window is definitely fullscreen afterward, or that the windowing system allows fullscreen windows on @@ -115432,7 +115433,7 @@ notifications of the [property@Gtk.Window:fullscreened] property. - a `GtkWindow` + a window @@ -115442,27 +115443,27 @@ notifications of the [property@Gtk.Window:fullscreened] property. - Gets the `GtkApplication` associated with the window. + Gets the application object associated with the window. - a `GtkApplication` + the application - a `GtkWindow` + a window - Gets the child widget of @window. + Gets the child widget of the window. the child widget of @window - a `GtkWindow` + a window @@ -115470,12 +115471,12 @@ notifications of the [property@Gtk.Window:fullscreened] property. Returns whether the window has been set to have decorations. - %TRUE if the window has been set to have decorations + true if the window has been set to have decorations - a `GtkWindow` + a window @@ -115494,7 +115495,7 @@ across restarts of applications](https://developer.gnome.org/documentation/tutor - a `GtkWindow` + a window @@ -115515,7 +115516,7 @@ across restarts of applications](https://developer.gnome.org/documentation/tutor - a `GtkWindow` + a window @@ -115523,12 +115524,12 @@ across restarts of applications](https://developer.gnome.org/documentation/tutor Returns whether the window has been set to have a close button. - %TRUE if the window has been set to have a close button + true if the window has been set to have a close button - a `GtkWindow` + a window @@ -115536,12 +115537,12 @@ across restarts of applications](https://developer.gnome.org/documentation/tutor Returns whether the window will be destroyed with its transient parent. - %TRUE if the window will be destroyed with its transient parent. + true if the window will be destroyed with its transient parent - a `GtkWindow` + a window @@ -115552,14 +115553,14 @@ across restarts of applications](https://developer.gnome.org/documentation/tutor Note that this is the widget that would have the focus if the toplevel window focused; if the toplevel window is not focused then `gtk_widget_has_focus (widget)` will -not be %TRUE for the widget. +not be false for the widget. the currently focused widget - a `GtkWindow` + a window @@ -115567,56 +115568,57 @@ not be %TRUE for the widget. Gets whether “focus rectangles” are supposed to be visible. - %TRUE if “focus rectangles” are supposed to be visible - in this window. + true if “focus rectangles” are supposed to be visible + in this window - a `GtkWindow` + a window - Returns the group for @window. + Returns the group for the window. If the window has no group, then the default group is returned. - the `GtkWindowGroup` for a window + the window group for @window or the default group - a `GtkWindow` + a window - Returns whether this window reacts to F10 key presses by -activating a menubar it contains. + Returns whether this window reacts to <kbd>F10</kbd> +presses by activating a menubar it contains. - %TRUE if the window handles F10 + true if the window handles <kbd>F10</kbd> - a `GtkWindow` + a window - Returns whether the window will be hidden when the close button is clicked. + Returns whether the window will be hidden when the close +button is clicked. - %TRUE if the window will be hidden + true if the window will be hidden - a `GtkWindow` + a window @@ -115629,7 +115631,7 @@ activating a menubar it contains. - a `GtkWindow` + a window @@ -115637,13 +115639,13 @@ activating a menubar it contains. Gets whether mnemonics are supposed to be visible. - %TRUE if mnemonics are supposed to be visible - in this window. + true if mnemonics are supposed to be visible + in this window - a `GtkWindow` + a window @@ -115651,26 +115653,26 @@ activating a menubar it contains. Returns whether the window is modal. - %TRUE if the window is set to be modal and + true if the window is set to be modal and establishes a grab when shown - a `GtkWindow` + a window - Gets the value set by gtk_window_set_resizable(). + Gets whether the user can resize the window. - %TRUE if the user can resize the window + true if the user can resize the window - a `GtkWindow` + a window @@ -115678,26 +115680,26 @@ activating a menubar it contains. Retrieves the title of the window. - the title of the window + the title - a `GtkWindow` + a window - Returns the custom titlebar that has been set with -gtk_window_set_titlebar(). + Returns the titlebar that has been set with +[method@Gtk.Window.set_titlebar]. - the custom titlebar + the titlebar - a `GtkWindow` + a window @@ -115705,25 +115707,25 @@ gtk_window_set_titlebar(). Fetches the transient parent for this window. - the transient parent for this window + the transient parent - a `GtkWindow` + a window - Returns whether @window has an explicit window group. + Returns whether the window has an explicit window group. - %TRUE if @window has an explicit window group. + true if @window has an explicit window group - a `GtkWindow` + a window @@ -115737,18 +115739,18 @@ The return value is %TRUE if the window is active toplevel itself. You might use this function if you wanted to draw a widget differently in an active window from a widget in an inactive window. - %TRUE if the window part of the current active window. + true if the window part of the current active window. - a `GtkWindow` + a window - Retrieves the current fullscreen state of @window. + Retrieves the current fullscreen state of the window. Note that since fullscreening is ultimately handled by the window manager and happens asynchronously to an application request, you @@ -115759,18 +115761,18 @@ immediately (or at all), as an effect of calling If the window isn't yet mapped, the value returned will whether the initial requested state is fullscreen. - whether the window has a fullscreen state. + whether the window is fullscreen - a `GtkWindow` + a window - Retrieves the current maximized state of @window. + Retrieves the current maximized state of the window. Note that since maximization is ultimately handled by the window manager and happens asynchronously to an application request, you @@ -115781,34 +115783,35 @@ immediately (or at all), as an effect of calling If the window isn't yet mapped, the value returned will whether the initial requested state is maximized. - whether the window has a maximized state. + whether the window is maximized - a `GtkWindow` + a window - Retrieves the current suspended state of @window. + Retrieves the current suspended state of the window. -A window being suspended means it's currently not visible to the user, for -example by being on a inactive workspace, minimized, obstructed. +A window being suspended means it's currently not visible +to the user, for example by being on a inactive workspace, +minimized, obstructed. - whether the window is suspended. + whether the window is suspended - a `GtkWindow` + a window - Asks to maximize @window, so that it fills the screen. + Asks to maximize the window, so that it fills the screen. Note that you shouldn’t assume the window is definitely maximized afterward, because other entities (e.g. the user or window manager) @@ -115828,13 +115831,13 @@ property. - a `GtkWindow` + a window - Asks to minimize the specified @window. + Asks to minimize the window. Note that you shouldn’t assume the window is definitely minimized afterward, because the windowing system might not support this @@ -115853,7 +115856,7 @@ You can track result of this operation via the - a `GtkWindow` + a window @@ -115872,7 +115875,7 @@ If @window is hidden, this function also makes it visible. - a `GtkWindow` + a window @@ -115885,13 +115888,13 @@ See [method@Gtk.Window.present] for more details. The timestamp should be gathered when the window was requested to be shown (when clicking a link for example), rather than once the window is ready to be shown. - Use gtk_window_present() + Use [method@Gtk.Window.present] - a `GtkWindow` + a window @@ -115902,11 +115905,11 @@ the window is ready to be shown. - Sets or unsets the `GtkApplication` associated with the window. + Sets or unsets the application object associated with the window. The application will be kept alive for at least as long as it has -any windows associated with it (see g_application_hold() for a way -to keep it alive without windows). +any windows associated with it (see [method@Gio.Application.hold] +for a way to keep it alive without windows). Normally, the connection between the application and the window will remain until the window is destroyed, but you can explicitly remove @@ -115920,23 +115923,23 @@ as relevant. - a `GtkWindow` + a window - a `GtkApplication`, or %NULL to unset + a `GtkApplication` - Sets the child widget of @window. + Sets the child widget of the window. - a `GtkWindow` + a window @@ -115951,7 +115954,7 @@ as relevant. By default, windows are decorated with a title bar, resize controls, etc. Some window managers allow GTK to disable these decorations, creating a borderless window. If you set the decorated -property to %FALSE using this function, GTK will do its best to +property to false using this function, GTK will do its best to convince the window manager not to decorate the window. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling @@ -115964,11 +115967,11 @@ policy involved. - a `GtkWindow` + a window - %TRUE to decorate the window + true to decorate the window @@ -115976,7 +115979,8 @@ policy involved. Sets the default size of a window. -The default size of a window is the size that will be used if no other constraints apply. +The default size of a window is the size that will be used +if no other constraints apply. The default size will be updated whenever the window is resized to reflect the new size, unless the window is forced to a size, @@ -116008,7 +116012,7 @@ or shrinking windows. - a `GtkWindow` + a window @@ -116024,19 +116028,19 @@ or shrinking windows. Sets the default widget. -The default widget is the widget that is activated when the user -presses Enter in a dialog (for example). +The default widget is the widget that is activated +when the user presses <kbd>Enter</kbd> in a dialog +(for example). - a `GtkWindow` + a window - widget to be the default - to unset the default widget for the toplevel + widget to be the default @@ -116046,7 +116050,7 @@ presses Enter in a dialog (for example). By default, windows have a close button in the window frame. Some window managers allow GTK to disable this button. If you -set the deletable property to %FALSE using this function, GTK +set the deletable property to false using this function, GTK will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible, @@ -116059,18 +116063,17 @@ manager policy involved. - a `GtkWindow` + a window - %TRUE to decorate the window as deletable + true to decorate the window as deletable - If @setting is %TRUE, then destroying the transient parent of @window -will also destroy @window itself. + Sets whether to destroy the window when the transient parent is destroyed. This is useful for dialogs that shouldn’t persist beyond the lifetime of the main window they are associated with, for example. @@ -116079,17 +116082,17 @@ of the main window they are associated with, for example. - a `GtkWindow` + a window - whether to destroy @window with its transient parent + whether to destroy the window with its transient parent - Sets the `GdkDisplay` where the @window is displayed. + Sets the display where the window is displayed. If the window is already mapped, it will be unmapped, and then remapped on the new display. @@ -116098,11 +116101,11 @@ and then remapped on the new display. - a `GtkWindow` + a window - a `GdkDisplay` + a display @@ -116120,12 +116123,11 @@ to use [method@Gtk.Widget.grab_focus] instead of this function. - a `GtkWindow` + a window - widget to be the new focus widget, or %NULL to unset - any focus widget for the toplevel window. + the new focus widget @@ -116140,7 +116142,7 @@ and should not be set by applications. - a `GtkWindow` + a window @@ -116150,31 +116152,31 @@ and should not be set by applications. - Sets whether this window should react to F10 key presses -by activating a menubar it contains. + Sets whether this window should react to <kbd>F10</kbd> +presses by activating a menubar it contains. - a `GtkWindow` + a window - %TRUE to make @window handle F10 + true to make @window handle <kbd>F10</kbd> - If @setting is %TRUE, then clicking the close button on the window -will not destroy it, but only hide it. + Sets whether clicking the close button will hide the window instead +of destroying it. - a `GtkWindow` + a window @@ -116196,7 +116198,7 @@ property which is mentioned in the ICCCM. - a `GtkWindow` + a window @@ -116215,7 +116217,7 @@ and should not be set by applications. - a `GtkWindow` + a window @@ -116237,7 +116239,7 @@ dialog below the parent. - a `GtkWindow` + a window @@ -116255,11 +116257,11 @@ Windows are user resizable by default. - a `GtkWindow` + a window - %TRUE if the user can resize this window + true if the user can resize this window @@ -116284,7 +116286,7 @@ This function is only useful on X11, not with other GTK targets. - a `GtkWindow` + a window @@ -116294,7 +116296,7 @@ This function is only useful on X11, not with other GTK targets. - Sets the title of the `GtkWindow`. + Sets the title of the window. The title of a window will be displayed in its title bar; on the X Window System, the title bar is rendered by the window manager @@ -116303,13 +116305,13 @@ user’s exact configuration. The title should help a user distinguish this window from other windows they may have open. A good title might include the application name and current document filename, for example. -Passing %NULL does the same as setting the title to an empty string. +Passing `NULL` does the same as setting the title to an empty string. - a `GtkWindow` + a window @@ -116319,7 +116321,7 @@ Passing %NULL does the same as setting the title to an empty string. - Sets a custom titlebar for @window. + Sets a custom titlebar for the window. A typical widget used here is [class@Gtk.HeaderBar], as it provides various features expected of a titlebar while allowing @@ -116335,7 +116337,7 @@ that is already visible, so you set the titlebar before calling - a `GtkWindow` + a window @@ -116345,14 +116347,16 @@ that is already visible, so you set the titlebar before calling - Dialog windows should be set transient for the main application + Sets a transient parent for the window. + +Dialog windows should be set transient for the main application window they were spawned from. This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window. [ctor@Gtk.Dialog.new_with_buttons] and other -convenience functions in GTK will sometimes call -gtk_window_set_transient_for() on your behalf. +convenience functions in GTK will sometimes call this function on +your behalf. -Passing %NULL for @parent unsets the current transient window. +Passing `NULL` for @parent unsets the current transient window. On Windows, this function puts the child window on top of the parent, much as the window manager would have done on X. @@ -116361,7 +116365,7 @@ much as the window manager would have done on X. - a `GtkWindow` + a window @@ -116371,7 +116375,7 @@ much as the window manager would have done on X. - Asks to remove the fullscreen state for @window, and return to + Asks to remove the fullscreen state for the window, and return to its previous state. Note that you shouldn’t assume the window is definitely not @@ -116389,13 +116393,13 @@ notifications of the [property@Gtk.Window:fullscreened] property. - a `GtkWindow` + a window - Asks to unmaximize @window. + Asks to unmaximize the window. Note that you shouldn’t assume the window is definitely unmaximized afterward, because other entities (e.g. the user or window manager) @@ -116410,13 +116414,13 @@ notifications on the [property@Gtk.Window:maximized] property. - a `GtkWindow` + a window - Asks to unminimize the specified @window. + Asks to unminimize the window. Note that you shouldn’t assume the window is definitely unminimized afterward, because the windowing system might not support this @@ -116431,7 +116435,7 @@ You can track result of this operation via the - a `GtkWindow` + a window @@ -116445,7 +116449,7 @@ for a way to keep it alive without windows). Normally, the connection between the application and the window will remain until the window is destroyed, but you can explicitly -remove it by setting the :application property to %NULL. +remove it by setting the this property to `NULL`. @@ -116502,7 +116506,7 @@ operation was successful. - Whether the window frame should handle F10 for activating + Whether the window frame should handle <kbd>F10</kbd> for activating menubars. @@ -116538,11 +116542,11 @@ and should not be set by applications. - If %TRUE, the window is modal. + If true, the window is modal. - If %TRUE, users can resize the window. + If true, users can resize the window. @@ -116571,8 +116575,7 @@ See [method@Gtk.Window.is_suspended] for details about what suspended means. - Emitted when the user activates the default widget -of @window. + Emitted when the user activates the default widget. This is a [keybinding signal](class.SignalAction.html). @@ -116595,15 +116598,15 @@ The default binding for this signal is <kbd>␣</kbd>. Emitted when the user clicks on the close button of the window. - %TRUE to stop other handlers from being invoked for the signal + true to stop other handlers from being invoked for the signal Emitted when the user enables or disables interactive debugging. -When @toggle is %TRUE, interactive debugging is toggled on or off, -when it is %FALSE, the debugger will be pointed at the widget +When @toggle is true, interactive debugging is toggled on or off, +when it is false, the debugger will be pointed at the widget under the pointer. This is a [keybinding signal](class.SignalAction.html). @@ -116612,7 +116615,7 @@ The default bindings for this signal are <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> and <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>D</kbd>. - %TRUE if the key binding was handled + true if the key binding was handled @@ -116623,10 +116626,10 @@ The default bindings for this signal are - emitted when the set of accelerators or mnemonics that -are associated with @window changes. + Emitted when the set of accelerators or mnemonics that +are associated with the window changes. Use [class@Gtk.Shortcut] and [class@Gtk.EventController] -to implement keyboard shortcuts + to implement keyboard shortcuts @@ -116695,9 +116698,9 @@ to implement keyboard shortcuts - Class handler for the `GtkWindow::close-request` signal. + Whether the window should be destroyed @@ -116714,7 +116717,7 @@ to implement keyboard shortcuts - `GtkWindowControls` shows window frame controls. + A widget that shows window frame controls. Typical window frame controls are minimize, maximize and close buttons, and the window icon. @@ -116758,19 +116761,19 @@ subnodes corresponding to each title button. Which of the title buttons exist and where they are placed exactly depends on the desktop environment and [property@Gtk.WindowControls:decoration-layout] value. -When [property@Gtk.WindowControls:empty] is %TRUE, it gets the .empty +When [property@Gtk.WindowControls:empty] is true, it gets the .empty style class. # Accessibility -`GtkWindowControls` uses the %GTK_ACCESSIBLE_ROLE_GROUP role. +`GtkWindowControls` uses the [enum@Gtk.AccessibleRole.group] role. Creates a new `GtkWindowControls`. - a new `GtkWindowControls`. + a new `GtkWindowControls` @@ -116781,14 +116784,14 @@ style class. - Gets the decoration layout of this `GtkWindowControls`. + Gets the decoration layout of this window controls widget - the decoration layout or %NULL if it is unset + the decoration layout - a `GtkWindowControls` + a window controls widget @@ -116796,25 +116799,25 @@ style class. Gets whether the widget has any window buttons. - %TRUE if the widget has window buttons, otherwise %FALSE + true if the widget has window buttons - a `GtkWindowControls` + a window controls widget - Gets the side to which this `GtkWindowControls` instance belongs. + Gets the side to which this window controls widget belongs. the side - a `GtkWindowControls` + a window controls widget @@ -116833,24 +116836,25 @@ maximize, close and icon (the window icon). For example, “icon:minimize,maximize,close” specifies a icon on the left, and minimize, maximize and close buttons on the right. -If [property@Gtk.WindowControls:side] value is @GTK_PACK_START, @self -will display the part before the colon, otherwise after that. +If [property@Gtk.WindowControls:side] value is [enum@Gtk.PackType.start], +@self will display the part before the colon, otherwise after that. - a `GtkWindowControls` + a window controls widget - a decoration layout, or %NULL to unset the layout + a decoration layout, or `NULL` to unset the layout - Determines which part of decoration layout the `GtkWindowControls` uses. + Determines which part of decoration layout +the window controls widget uses. See [property@Gtk.WindowControls:decoration-layout]. @@ -116858,7 +116862,7 @@ See [property@Gtk.WindowControls:decoration-layout]. - a `GtkWindowControls` + a window controls widget