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

Update GIR files (2024-01-26)

Gdk-3.0.gir

@@ -14773,7 +14773,7 @@ See gdk_keymap_get_caps_lock_state().</doc>
     <constant name="MAX_TIMECOORD_AXES" value="128" c:type="GDK_MAX_TIMECOORD_AXES">
       <type name="gint" c:type="gint"/>
     </constant>
-    <constant name="MICRO_VERSION" value="40" c:type="GDK_MICRO_VERSION">
+    <constant name="MICRO_VERSION" value="42" c:type="GDK_MICRO_VERSION">
       <type name="gint" c:type="gint"/>
     </constant>
     <constant name="MINOR_VERSION" value="24" c:type="GDK_MINOR_VERSION">

Gdk-4.0.gir

@@ -2030,6 +2030,7 @@ See [[email protected]_mime_type_async].</doc>
         <type name="GObject.ObjectClass" c:type="GObjectClass"/>
       </field>
       <field name="content_changed">
+        <doc xml:space="preserve">Signal class closure for `GdkContentProvider::content-changed`</doc>
         <callback name="content_changed">
           <return-value transfer-ownership="none">
             <type name="none" c:type="void"/>
@@ -16370,6 +16371,10 @@ that will make the implementation likely quite slow.</doc>
         <type name="GObject.TypeInterface" c:type="GTypeInterface"/>
       </field>
       <field name="snapshot">
+        <doc xml:space="preserve">Snapshot the paintable. The given @width and @height are
+  guaranteed to be larger than 0.0. The resulting snapshot must modify
+  only the area in the rectangle from (0,0) to (width, height).
+  This is the only function that must be implemented for this interface.</doc>
         <callback name="snapshot">
           <return-value transfer-ownership="none">
             <type name="none" c:type="void"/>
@@ -16395,6 +16400,9 @@ that will make the implementation likely quite slow.</doc>
         </callback>
       </field>
       <field name="get_current_image">
+        <doc xml:space="preserve">return a `GdkPaintable` that does not change over
+  time. This means the `GDK_PAINTABLE_STATIC_SIZE` and
+  `GDK_PAINTABLE_STATIC_CONTENTS` flag are set.</doc>
         <callback name="get_current_image">
           <return-value transfer-ownership="full">
             <doc xml:space="preserve">An immutable paintable for the current
@@ -16410,6 +16418,8 @@ that will make the implementation likely quite slow.</doc>
         </callback>
       </field>
       <field name="get_flags">
+        <doc xml:space="preserve">Get the flags for this instance. See [[email protected]]
+  for details.</doc>
         <callback name="get_flags">
           <return-value transfer-ownership="none">
             <doc xml:space="preserve">The `GdkPaintableFlags` for this paintable</doc>
@@ -16424,6 +16434,9 @@ that will make the implementation likely quite slow.</doc>
         </callback>
       </field>
       <field name="get_intrinsic_width">
+        <doc xml:space="preserve">The preferred width for this object to be
+  snapshot at or 0 if none. This is purely a hint. The object must still
+  be able to render at any size.</doc>
         <callback name="get_intrinsic_width">
           <return-value transfer-ownership="none">
             <doc xml:space="preserve">the intrinsic width of @paintable or 0 if none.</doc>
@@ -16438,6 +16451,9 @@ that will make the implementation likely quite slow.</doc>
         </callback>
       </field>
       <field name="get_intrinsic_height">
+        <doc xml:space="preserve">The preferred height for this object to be
+  snapshot at or 0 if none. This is purely a hint. The object must still
+  be able to render at any size.</doc>
         <callback name="get_intrinsic_height">
           <return-value transfer-ownership="none">
             <doc xml:space="preserve">the intrinsic height of @paintable or 0 if none.</doc>
@@ -16452,6 +16468,10 @@ that will make the implementation likely quite slow.</doc>
         </callback>
       </field>
       <field name="get_intrinsic_aspect_ratio">
+        <doc xml:space="preserve">The preferred aspect ratio for this object
+  or 0 if none. If both [[email protected]_intrinsic_width]
+  and [[email protected]_intrinsic_height] return non-zero
+  values, this function should return the aspect ratio computed from those.</doc>
         <callback name="get_intrinsic_aspect_ratio">
           <return-value transfer-ownership="none">
             <doc xml:space="preserve">the intrinsic aspect ratio of @paintable or 0 if none.</doc>

GdkPixbuf-2.0.gir

@@ -2830,6 +2830,7 @@ A delay time of -1 is possible, indicating "infinite".</doc>
         </parameters>
       </virtual-method>
       <virtual-method name="get_size">
+        <doc xml:space="preserve">fills @width and @height with the frame size of the animation.</doc>
         <return-value transfer-ownership="none">
           <type name="none" c:type="void"/>
         </return-value>
@@ -3043,6 +3044,7 @@ virtual functions.</doc>
         <type name="GObject.ObjectClass" c:type="GObjectClass"/>
       </field>
       <field name="is_static_image">
+        <doc xml:space="preserve">returns whether the given animation is just a static image.</doc>
         <callback name="is_static_image">
           <return-value transfer-ownership="none">
             <doc xml:space="preserve">`TRUE` if the "animation" was really just an image</doc>
@@ -3057,6 +3059,7 @@ virtual functions.</doc>
         </callback>
       </field>
       <field name="get_static_image">
+        <doc xml:space="preserve">returns a static image representing the given animation.</doc>
         <callback name="get_static_image">
           <return-value transfer-ownership="none">
             <doc xml:space="preserve">unanimated image representing the animation</doc>
@@ -3071,6 +3074,7 @@ virtual functions.</doc>
         </callback>
       </field>
       <field name="get_size">
+        <doc xml:space="preserve">fills @width and @height with the frame size of the animation.</doc>
         <callback name="get_size">
           <return-value transfer-ownership="none">
             <type name="none" c:type="void"/>
@@ -3089,6 +3093,7 @@ virtual functions.</doc>
         </callback>
       </field>
       <field name="get_iter">
+        <doc xml:space="preserve">returns an iterator for the given animation.</doc>
         <callback name="get_iter">
           <return-value transfer-ownership="full">
             <doc xml:space="preserve">an iterator to move over the animation</doc>
@@ -3329,6 +3334,8 @@ virtual functions.</doc>
         <type name="GObject.ObjectClass" c:type="GObjectClass"/>
       </field>
       <field name="get_delay_time">
+        <doc xml:space="preserve">returns the time in milliseconds that the current frame
+ should be shown.</doc>
         <callback name="get_delay_time">
           <return-value transfer-ownership="none">
             <doc xml:space="preserve">delay time in milliseconds (thousandths of a second)</doc>
@@ -3343,6 +3350,7 @@ virtual functions.</doc>
         </callback>
       </field>
       <field name="get_pixbuf">
+        <doc xml:space="preserve">returns the current frame.</doc>
         <callback name="get_pixbuf">
           <return-value transfer-ownership="none">
             <doc xml:space="preserve">the pixbuf to be displayed</doc>
@@ -3357,6 +3365,8 @@ virtual functions.</doc>
         </callback>
       </field>
       <field name="on_currently_loading_frame">
+        <doc xml:space="preserve">returns whether the current frame of @iter is
+ being loaded.</doc>
         <callback name="on_currently_loading_frame">
           <return-value transfer-ownership="none">
             <doc xml:space="preserve">`TRUE` if the frame we're on is partially loaded, or the last frame</doc>
@@ -3371,6 +3381,8 @@ virtual functions.</doc>
         </callback>
       </field>
       <field name="advance">
+        <doc xml:space="preserve">advances the iterator to @current_time, possibly changing the
+ current frame.</doc>
         <callback name="advance">
           <return-value transfer-ownership="none">
             <doc xml:space="preserve">`TRUE` if the image may need updating</doc>