Merge pull request #199 from gtk-rs/create-pull-request/patch

Update GIR files (2024-04-25)
gtk-rs · Apr 25, 2024 · 65efc10 · 65efc10
2 parents 71ccb01 + eaa6267
commit 65efc10
Show file tree

Hide file tree

Showing 7 changed files with 102 additions and 24 deletions.
diff --git a/GLib-2.0.gir b/GLib-2.0.gir
@@ -35531,7 +35531,7 @@ Think of this function as an analogue to g_strdup_printf().
 
 The type of the created instance and the arguments that are expected
 by this function are determined by @format_string. See the section on
-[GVariant format strings][gvariant-format-strings]. Please note that
+[GVariant format strings](gvariant-format-strings.html). Please note that
 the syntax of the format string is very likely to be extended in the
 future.
 
@@ -35541,7 +35541,7 @@ function (and not merely passed through it unmodified).
 
 Note that the arguments must be of the correct width for their types
 specified in @format_string. This can be achieved by casting them. See
-the [GVariant varargs documentation][gvariant-varargs].
+the [GVariant varargs documentation](gvariant-format-strings.html#varargs).
 
 |[&lt;!-- language="C" --&gt;
 MyFlags some_flags = FLAG_ONE | FLAG_TWO;
@@ -35971,7 +35971,7 @@ g_variant_new() would have collected.
 
 Note that the arguments must be of the correct width for their types
 specified in @format. This can be achieved by casting them. See
-the [GVariant varargs documentation][gvariant-varargs].
+the [GVariant varargs documentation](gvariant-format-strings.html#varargs).
 
 Consider this simple example:
 |[&lt;!-- language="C" --&gt;
@@ -36022,7 +36022,7 @@ additional references.
 
 Note that the arguments in @app must be of the correct width for their types
 specified in @format when collected into the #va_list. See
-the [GVariant varargs documentation][gvariant-varargs].
+the [GVariant varargs documentation](gvariant-format-strings.html#varargs).
 
 In order to behave correctly in all cases it is necessary for the
 calling function to g_variant_ref_sink() the return result before
@@ -36087,7 +36087,7 @@ g_variant_is_signature() if you're not sure.</doc>
 
 @string must be valid UTF-8, and must not be %NULL. To encode
 potentially-%NULL strings, use g_variant_new() with `ms` as the
-[format string][gvariant-format-strings-maybe-types].</doc>
+[format string](gvariant-format-strings.html#maybe-types).</doc>
         <return-value transfer-ownership="none">
           <doc xml:space="preserve">a floating reference to a new string #GVariant instance</doc>
           <type name="Variant" c:type="GVariant*"/>
@@ -36230,7 +36230,7 @@ pointing to the argument following the last.
 
 Note that the arguments in @app must be of the correct width for their
 types specified in @format_string when collected into the #va_list.
-See the [GVariant varargs documentation][gvariant-varargs].
+See the [GVariant varargs documentation](gvariant-format-strings.html#varargs).
 
 These two generalisations allow mixing of multiple calls to
 g_variant_new_va() and g_variant_get_va() within a single actual
@@ -36557,7 +36557,7 @@ The arguments that are expected by this function are entirely
 determined by @format_string.  @format_string also restricts the
 permissible types of @value.  It is an error to give a value with
 an incompatible type.  See the section on
-[GVariant format strings][gvariant-format-strings].
+[GVariant format strings](gvariant-format-strings.html).
 Please note that the syntax of the format string is very likely to be
 extended in the future.
 
@@ -36825,7 +36825,7 @@ fixed-size, as are tuples containing only other fixed-sized types.
 
 @element_size must be the size of a single element in the array,
 as given by the section on
-[serialized data memory][gvariant-serialized-data-memory].
+[serialized data memory](struct.Variant.html#serialized-data-memory).
 
 In particular, arrays of these fixed-sized types can be interpreted
 as an array of the given C type, with @element_size set to the size
@@ -37461,7 +37461,7 @@ This function is O(1).</doc>
       <method name="print" c:identifier="g_variant_print" version="2.24">
         <doc xml:space="preserve">Pretty-prints @value in the format understood by g_variant_parse().
 
-The format is described [here][gvariant-text].
+The format is described [here](gvariant-text-format.html).
 
 If @type_annotate is %TRUE, then type information is included in
 the output.</doc>
@@ -37850,7 +37850,7 @@ calling g_variant_new() followed by g_variant_builder_add_value().
 
 Note that the arguments must be of the correct width for their types
 specified in @format_string. This can be achieved by casting them. See
-the [GVariant varargs documentation][gvariant-varargs].
+the [GVariant varargs documentation](gvariant-format-strings.html#varargs).
 
 This function might be used as follows:
 
@@ -37900,7 +37900,7 @@ g_variant_builder_add_value().
 
 Note that the arguments must be of the correct width for their types
 specified in @format_string. This can be achieved by casting them. See
-the [GVariant varargs documentation][gvariant-varargs].
+the [GVariant varargs documentation](gvariant-format-strings.html#varargs).
 
 This function might be used as follows:
 

diff --git a/Gdk-4.0.gir b/Gdk-4.0.gir
@@ -20048,7 +20048,7 @@ progress of the gesture.</doc>
         </parameter>
       </parameters>
     </function-macro>
-    <class name="VulkanContext" c:symbol-prefix="vulkan_context" c:type="GdkVulkanContext" parent="DrawContext" abstract="1" glib:type-name="GdkVulkanContext" glib:get-type="gdk_vulkan_context_get_type">
+    <class name="VulkanContext" c:symbol-prefix="vulkan_context" c:type="GdkVulkanContext" deprecated="1" deprecated-version="4.14" parent="DrawContext" abstract="1" glib:type-name="GdkVulkanContext" glib:get-type="gdk_vulkan_context_get_type">
       <doc xml:space="preserve">`GdkVulkanContext` is an object representing the platform-specific
 Vulkan draw context.
 
@@ -20058,6 +20058,8 @@ the characteristics of the surface.
 
 Support for `GdkVulkanContext` is platform-specific and context creation
 can fail, returning %NULL context.</doc>
+      <doc-deprecated xml:space="preserve">GTK does not expose any Vulkan internals. This
+  struct is a leftover that was accidentally exposed.</doc-deprecated>
       <implements name="Gio.Initable"/>
       <glib:signal name="images-updated" when="last">
         <doc xml:space="preserve">Emitted when the images managed by this context have changed.

diff --git a/GdkPixbuf-2.0.gir b/GdkPixbuf-2.0.gir
@@ -316,7 +316,7 @@ interpolation is just as fast and results in higher quality.</doc>
 "0.8.2" for example.</doc>
       <type name="gint" c:type="gint"/>
     </constant>
-    <constant name="PIXBUF_MICRO" value="11" c:type="GDK_PIXBUF_MICRO">
+    <constant name="PIXBUF_MICRO" value="12" c:type="GDK_PIXBUF_MICRO">
       <doc xml:space="preserve">Micro version of gdk-pixbuf library, that is the "2" in
 "0.8.2" for example.</doc>
       <type name="gint" c:type="gint"/>
@@ -344,7 +344,7 @@ interpolation is just as fast and results in higher quality.</doc>
         </parameter>
       </parameters>
     </function-macro>
-    <constant name="PIXBUF_VERSION" value="2.42.11" c:type="GDK_PIXBUF_VERSION">
+    <constant name="PIXBUF_VERSION" value="2.42.12" c:type="GDK_PIXBUF_VERSION">
       <doc xml:space="preserve">Contains the full version of GdkPixbuf as a string.
 
 This is the version being compiled against; contrast with

diff --git a/GdkWayland-4.0.gir b/GdkWayland-4.0.gir
@@ -303,8 +303,10 @@ if no ID has been defined.</doc>
           </parameter>
         </parameters>
       </method>
-      <method name="set_cursor_theme" c:identifier="gdk_wayland_display_set_cursor_theme">
+      <method name="set_cursor_theme" c:identifier="gdk_wayland_display_set_cursor_theme" deprecated="1" deprecated-version="4.16">
         <doc xml:space="preserve">Sets the cursor theme for the given @display.</doc>
+        <doc-deprecated xml:space="preserve">Use the cursor-related properties of
+  [GtkSettings](../gtk4/class.Settings.html) to set the cursor theme</doc-deprecated>
         <return-value transfer-ownership="none">
           <type name="none" c:type="void"/>
         </return-value>

diff --git a/GdkX11-4.0.gir b/GdkX11-4.0.gir
@@ -492,7 +492,7 @@ gdk_x11_display_grab()/gdk_x11_display_ungrab() calls can be nested.</doc>
           </instance-parameter>
         </parameters>
       </method>
-      <method name="set_cursor_theme" c:identifier="gdk_x11_display_set_cursor_theme">
+      <method name="set_cursor_theme" c:identifier="gdk_x11_display_set_cursor_theme" deprecated="1" deprecated-version="4.16">
         <doc xml:space="preserve">Sets the cursor theme from which the images for cursor
 should be taken.
 
@@ -502,6 +502,8 @@ change. Custom cursors constructed with [ctor@Gdk.Cursor.new_from_texture]
 will have to be handled by the application (GTK applications can learn
 about cursor theme changes by listening for change notification
 for the corresponding `GtkSetting`).</doc>
+        <doc-deprecated xml:space="preserve">Use the cursor-related properties of
+  [GtkSettings](../gtk4/class.Settings.html) to set the cursor theme</doc-deprecated>
         <return-value transfer-ownership="none">
           <type name="none" c:type="void"/>
         </return-value>

diff --git a/Gio-2.0.gir b/Gio-2.0.gir
@@ -692,7 +692,7 @@ See g_action_map_add_action_entries() for an example.</doc>
       </field>
       <field name="state" writable="1">
         <doc xml:space="preserve">the initial state for this action, given in
-        [GVariant text format][gvariant-text].  The state is parsed
+        [GVariant text format](gvariant-text-format.html).  The state is parsed
         with no extra type information, so type tags must be added to
         the string if they are necessary.  Stateless actions should
         give %NULL here.</doc>
@@ -40277,8 +40277,8 @@ Functionality for manipulating basic metadata for files. `GFileInfo`
 implements methods for getting information that all files should
 contain, and allows for manipulation of extended attributes.
 
-See [file-attributes.html](file attributes) for more information on how GIO
-handles file attributes.
+See the [file attributes](file-attributes.html) document for more
+information on how GIO handles file attributes.
 
 To obtain a `GFileInfo` for a [iface@Gio.File], use
 [method@Gio.File.query_info] (or its async variant). To obtain a `GFileInfo`

diff --git a/Gtk-4.0.gir b/Gtk-4.0.gir
@@ -7448,7 +7448,7 @@ See gtk_assistant_commit() for details.</doc>
  add its own buttons through gtk_assistant_add_action_widget().</doc>
       </member>
     </enumeration>
-    <constant name="BINARY_AGE" value="1500" c:type="GTK_BINARY_AGE">
+    <constant name="BINARY_AGE" value="1501" c:type="GTK_BINARY_AGE">
       <doc xml:space="preserve">Like [func@get_binary_age], but from the headers used at
 application compile time, rather than from the library linked
 against at application run time.</doc>
@@ -42133,6 +42133,18 @@ will have more or less fields set.</doc>
         <doc xml:space="preserve">Select a font and font features</doc>
       </member>
     </enumeration>
+    <enumeration name="FontRendering" version="4.16" glib:type-name="GtkFontRendering" glib:get-type="gtk_font_rendering_get_type" c:type="GtkFontRendering">
+      <doc xml:space="preserve">Values for the [property@Gtk.Settings:gtk-font-rendering] setting
+that influence how GTK renders fonts.</doc>
+      <member name="automatic" value="0" c:identifier="GTK_FONT_RENDERING_AUTOMATIC" glib:nick="automatic" glib:name="GTK_FONT_RENDERING_AUTOMATIC">
+        <doc xml:space="preserve">Set up font rendering automatically,
+  taking factors like screen resolution and scale into account</doc>
+      </member>
+      <member name="manual" value="1" c:identifier="GTK_FONT_RENDERING_MANUAL" glib:nick="manual" glib:name="GTK_FONT_RENDERING_MANUAL">
+        <doc xml:space="preserve">Follow low-level font-related settings
+  when configuring font rendering</doc>
+      </member>
+    </enumeration>
     <class name="Frame" c:symbol-prefix="frame" c:type="GtkFrame" parent="Widget" glib:type-name="GtkFrame" glib:get-type="gtk_frame_get_type" glib:type-struct="FrameClass">
       <doc xml:space="preserve">`GtkFrame` is a widget that surrounds its child with a decorative
 frame and an optional label.
@@ -44931,7 +44943,7 @@ The GTK inspector provides a visual debugging tool for graphics offload.</doc>
       <implements name="ConstraintTarget"/>
       <constructor name="new" c:identifier="gtk_graphics_offload_new" version="4.14">
         <doc xml:space="preserve">Creates a new GtkGraphicsOffload widget.</doc>
-        <return-value transfer-ownership="full">
+        <return-value transfer-ownership="none">
           <doc xml:space="preserve">the new widget</doc>
           <type name="Widget" c:type="GtkWidget*"/>
         </return-value>
@@ -44942,6 +44954,21 @@ The GTK inspector provides a visual debugging tool for graphics offload.</doc>
           </parameter>
         </parameters>
       </constructor>
+      <method name="get_black_background" c:identifier="gtk_graphics_offload_get_black_background" glib:get-property="black-background" version="4.16">
+        <doc xml:space="preserve">Returns whether the widget draws a black background.
+
+See [method@Gtk.GraphicsOffload.set_black_background].</doc>
+        <return-value transfer-ownership="none">
+          <doc xml:space="preserve">`TRUE` if black background is drawn</doc>
+          <type name="gboolean" c:type="gboolean"/>
+        </return-value>
+        <parameters>
+          <instance-parameter name="self" transfer-ownership="none">
+            <doc xml:space="preserve">a `GtkGraphicsOffload`</doc>
+            <type name="GraphicsOffload" c:type="GtkGraphicsOffload*"/>
+          </instance-parameter>
+        </parameters>
+      </method>
       <method name="get_child" c:identifier="gtk_graphics_offload_get_child" glib:get-property="child" version="4.14">
         <doc xml:space="preserve">Gets the child of @self.</doc>
         <return-value transfer-ownership="none" nullable="1">
@@ -44968,6 +44995,35 @@ The GTK inspector provides a visual debugging tool for graphics offload.</doc>
           </instance-parameter>
         </parameters>
       </method>
+      <method name="set_black_background" c:identifier="gtk_graphics_offload_set_black_background" glib:set-property="black-background" version="4.16">
+        <doc xml:space="preserve">Sets whether this GtkGraphicsOffload widget will draw a black
+background.
+
+A main use case for this is **_letterboxing_** where black bars are
+visible next to the content if the aspect ratio of the content does
+not match the dimensions of the monitor.
+
+Using this property for letterboxing instead of CSS allows compositors
+to show content with maximum efficiency, using direct scanout to avoid
+extra copies in the compositor.
+
+On Wayland, this is implemented using the
+[single-pixel buffer](https://wayland.app/protocols/single-pixel-buffer-v1)
+protocol.</doc>
+        <return-value transfer-ownership="none">
+          <type name="none" c:type="void"/>
+        </return-value>
+        <parameters>
+          <instance-parameter name="self" transfer-ownership="none">
+            <doc xml:space="preserve">a `GtkGraphicsOffload`</doc>
+            <type name="GraphicsOffload" c:type="GtkGraphicsOffload*"/>
+          </instance-parameter>
+          <parameter name="value" transfer-ownership="none">
+            <doc xml:space="preserve">whether to draw a black background behind the content</doc>
+            <type name="gboolean" c:type="gboolean"/>
+          </parameter>
+        </parameters>
+      </method>
       <method name="set_child" c:identifier="gtk_graphics_offload_set_child" glib:set-property="child" version="4.14">
         <doc xml:space="preserve">Sets the child of @self.</doc>
         <return-value transfer-ownership="none">
@@ -45001,6 +45057,9 @@ to offload the content of its child widget.</doc>
           </parameter>
         </parameters>
       </method>
+      <property name="black-background" writable="1" transfer-ownership="none" setter="set_black_background" getter="get_black_background" default-value="FALSE">
+        <type name="gboolean" c:type="gboolean"/>
+      </property>
       <property name="child" version="4.14" writable="1" transfer-ownership="none" setter="set_child" getter="get_child">
         <attribute name="org.gtk.Property.get" value="gtk_graphics_offload_get_child"/>
         <attribute name="org.gtk.Property.set" value="gtk_graphics_offload_set_child"/>
@@ -59836,7 +59895,7 @@ against at application run time.</doc>
         </parameter>
       </parameters>
     </function-macro>
-    <constant name="MICRO_VERSION" value="0" c:type="GTK_MICRO_VERSION">
+    <constant name="MICRO_VERSION" value="1" c:type="GTK_MICRO_VERSION">
       <doc xml:space="preserve">Like [func@get_micro_version], but from the headers used at
 application compile time, rather than from the library linked
 against at application run time.</doc>
@@ -81504,7 +81563,7 @@ manager that is usually part of the desktop environment, along with
 utilities that let the user change these settings.
 
 On Wayland, the settings are obtained either via a settings portal,
-or by reading desktop settings from DConf.
+or by reading desktop settings from [class@Gio.Settings].
 
 On macOS, the settings are obtained from `NSUserDefaults`.
 
@@ -81740,11 +81799,24 @@ ways, such as flashing the window or similar visual effects.</doc>
 GTK uses the family name and size from this string.</doc>
         <type name="utf8" c:type="gchar*"/>
       </property>
+      <property name="gtk-font-rendering" version="4.16" writable="1" transfer-ownership="none" default-value="GTK_FONT_RENDERING_AUTOMATIC">
+        <doc xml:space="preserve">How GTK font rendering is set up.
+
+When set to [enum@Gtk.FontRendering.MANUAL], GTK respects the low-level
+font-related settings ([property@Gtk.Settings:gtk-hint-font-metrics],
+[property@Gtk.Settings:gtk-xft-antialias], [property@Gtk.Settings:gtk-xft-hinting],
+[property@Gtk.Settings:gtk-xft-hintstyle] and [property@Gtk.Settings:gtk-xft-rgba])
+as much as practical.
+
+When set to [enum@Gtk.FontRendering.AUTOMATIC], GTK will consider factors such
+as screen resolution and scale in deciding how to render fonts.</doc>
+        <type name="FontRendering"/>
+      </property>
       <property name="gtk-fontconfig-timestamp" writable="1" transfer-ownership="none" default-value="0">
         <doc xml:space="preserve">Timestamp of the current fontconfig configuration.</doc>
         <type name="guint" c:type="guint"/>
       </property>
-      <property name="gtk-hint-font-metrics" version="4.6" writable="1" transfer-ownership="none" default-value="FALSE">
+      <property name="gtk-hint-font-metrics" version="4.6" writable="1" transfer-ownership="none" default-value="TRUE">
         <doc xml:space="preserve">Whether hinting should be applied to font metrics.
 
 Note that this also turns off subpixel positioning of glyphs,