[gtkmm] Gdk, Gtk: Regenerate docs.xml and .defs files
- From: Kjell Ahlstedt <kjellahl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtkmm] Gdk, Gtk: Regenerate docs.xml and .defs files
- Date: Sat, 22 May 2021 10:06:55 +0000 (UTC)
commit 38e30a5e3f7bfccf5aba32165fca559465eb8a6c
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date: Sat May 22 11:17:19 2021 +0200
Gdk, Gtk: Regenerate docs.xml and .defs files
using gtk files from gtk 4.2.0.
gdk/src/gdk_docs.xml | 5050 ++++----
gdk/src/gdk_methods.defs | 30 +
gdk/src/gdk_signals.defs | 28 +-
gtk/src/gtk_docs.xml | 24975 +++++++++++++++++++++++-----------------
gtk/src/gtk_docs_override.xml | 3 +-
gtk/src/gtk_enums.defs | 2 +
gtk/src/gtk_methods.defs | 94 +-
gtk/src/gtk_signals.defs | 76 +-
8 files changed, 17716 insertions(+), 12542 deletions(-)
---
diff --git a/gdk/src/gdk_docs.xml b/gdk/src/gdk_docs.xml
index a2b895e2..113c5e11 100644
--- a/gdk/src/gdk_docs.xml
+++ b/gdk/src/gdk_docs.xml
@@ -58,6 +58,13 @@ sliding, which should take precedence over resizing.
</parameters>
</enum>
+<property name="GdkAppLaunchContext:display">
+<description>
+The display that the `GdkAppLaunchContext` is on.
+
+</description>
+</property>
+
<enum name="GdkAxisFlags">
<description>
Flags describing the current capabilities of a device/tool.
@@ -113,9 +120,7 @@ Flags describing the current capabilities of a device/tool.
<enum name="GdkAxisUse">
<description>
-An enumeration describing the way in which a device
-axis (valuator) maps onto the predefined valuator
-types that GTK understands.
+Defines how device axes are interpreted by GTK.
Note that the X and Y axes are not really needed; pointer devices
report their location via the x/y members of events regardless. Whether
@@ -180,7 +185,7 @@ X and Y are present as axes depends on the GDK backend.
<signal name="GdkClipboard::changed">
<description>
-The ::changed signal is emitted when the clipboard changes ownership.
+Emitted when the clipboard changes ownership.
</description>
<parameters>
@@ -194,7 +199,7 @@ The ::changed signal is emitted when the clipboard changes ownership.
<property name="GdkClipboard:content">
<description>
-The #GdkContentProvider or %NULL if the clipboard is empty or contents are
+The `GdkContentProvider` or %NULL if the clipboard is empty or contents are
provided otherwise.
</description>
@@ -202,7 +207,7 @@ provided otherwise.
<property name="GdkClipboard:display">
<description>
-The #GdkDisplay that the clipboard belongs to.
+The `GdkDisplay` that the clipboard belongs to.
</description>
</property>
@@ -224,7 +229,9 @@ The possible formats that the clipboard can provide its data in.
<enum name="GdkColorspace">
<description>
This enumeration defines the color spaces that are supported by
-the gdk-pixbuf library. Currently only RGB is supported.
+the gdk-pixbuf library.
+
+Currently only RGB is supported.
</description>
<parameters>
@@ -309,11 +316,50 @@ is synthetic as the pointer didn’t leave the surface.
</parameters>
</enum>
+<property name="GdkCursor:fallback">
+<description>
+Cursor to fall back to if this cursor cannot be displayed.
+
+</description>
+</property>
+
+<property name="GdkCursor:hotspot-x">
+<description>
+X position of the cursor hotspot in the cursor image.
+
+</description>
+</property>
+
+<property name="GdkCursor:hotspot-y">
+<description>
+Y position of the cursor hotspot in the cursor image.
+
+</description>
+</property>
+
+<property name="GdkCursor:name">
+<description>
+Name of this this cursor.
+
+The name will be %NULL if the cursor was created from a texture.
+
+</description>
+</property>
+
+<property name="GdkCursor:texture">
+<description>
+The texture displayed by this cursor.
+
+The texture will be %NULL if the cursor was created from a name.
+
+</description>
+</property>
+
<signal name="GdkDevice::changed">
<description>
-The ::changed signal is emitted either when the #GdkDevice
-has changed the number of either axes or keys. For example
-on X11 this will normally happen when the physical device
+Emitted either when the the number of either axes or keys changes.
+
+On X11 this will normally happen when the physical device
routing events through the logical device changes (for
example, user switches from the USB mouse to a tablet); in
that case the logical device will change to reflect the axes
@@ -322,7 +368,7 @@ and keys on the new physical device.
</description>
<parameters>
<parameter name="device">
-<parameter_description> the #GdkDevice that changed.
+<parameter_description> the `GdkDevice`
</parameter_description>
</parameter>
</parameters>
@@ -331,13 +377,12 @@ and keys on the new physical device.
<signal name="GdkDevice::tool-changed">
<description>
-The ::tool-changed signal is emitted on pen/eraser
-#GdkDevices whenever tools enter or leave proximity.
+Emitted on pen/eraser devices whenever tools enter or leave proximity.
</description>
<parameters>
<parameter name="device">
-<parameter_description> the #GdkDevice that changed.
+<parameter_description> the `GdkDevice`
</parameter_description>
</parameter>
<parameter name="tool">
@@ -348,6 +393,24 @@ The ::tool-changed signal is emitted on pen/eraser
<return></return>
</signal>
+<property name="GdkDevice:caps-lock-state">
+<description>
+Whether Caps Lock is on.
+
+This is only relevant for keyboard devices.
+
+</description>
+</property>
+
+<property name="GdkDevice:direction">
+<description>
+The direction of the current layout.
+
+This is only relevant for keyboard devices.
+
+</description>
+</property>
+
<property name="GdkDevice:display">
<description>
The #GdkDisplay the #GdkDevice pertains to.
@@ -355,6 +418,15 @@ The #GdkDisplay the #GdkDevice pertains to.
</description>
</property>
+<property name="GdkDevice:has-bidi-layouts">
+<description>
+Whether the device has both right-to-left and left-to-right layouts.
+
+This is only relevant for keyboard devices.
+
+</description>
+</property>
+
<property name="GdkDevice:has-cursor">
<description>
Whether the device is represented by a cursor on the screen.
@@ -362,6 +434,15 @@ Whether the device is represented by a cursor on the screen.
</description>
</property>
+<property name="GdkDevice:modifier-state">
+<description>
+The current modifier state of the device.
+
+This is only relevant for keyboard devices.
+
+</description>
+</property>
+
<property name="GdkDevice:n-axes">
<description>
Number of axes in the device.
@@ -376,9 +457,19 @@ The device name.
</description>
</property>
+<property name="GdkDevice:num-lock-state">
+<description>
+Whether Num Lock is on.
+
+This is only relevant for keyboard devices.
+
+</description>
+</property>
+
<property name="GdkDevice:num-touches">
<description>
The maximal number of concurrent touches on a touch device.
+
Will be 0 if the device is not a touch device or if the number
of touches is unknown.
@@ -387,14 +478,25 @@ of touches is unknown.
<property name="GdkDevice:product-id">
<description>
-Product ID of this device, see gdk_device_get_product_id().
+Product ID of this device.
+
+See [method@Gdk.Device.get_product_id].
+
+</description>
+</property>
+
+<property name="GdkDevice:scroll-lock-state">
+<description>
+Whether Scroll Lock is on.
+
+This is only relevant for keyboard devices.
</description>
</property>
<property name="GdkDevice:seat">
<description>
-#GdkSeat of this device.
+`GdkSeat` of this device.
</description>
</property>
@@ -406,9 +508,18 @@ Source type for the device.
</description>
</property>
+<property name="GdkDevice:tool">
+<description>
+The `GdkDeviceTool` that is currently used with this device.
+
+</description>
+</property>
+
<property name="GdkDevice:vendor-id">
<description>
-Vendor ID of this device, see gdk_device_get_vendor_id().
+Vendor ID of this device.
+
+See [method@Gdk.Device.get_vendor_id].
</description>
</property>
@@ -434,6 +545,34 @@ A pad feature.
</parameters>
</enum>
+<property name="GdkDeviceTool:axes">
+<description>
+The axes of the tool.
+
+</description>
+</property>
+
+<property name="GdkDeviceTool:hardware-id">
+<description>
+The hardware ID of the tool.
+
+</description>
+</property>
+
+<property name="GdkDeviceTool:serial">
+<description>
+The serial number of the tool.
+
+</description>
+</property>
+
+<property name="GdkDeviceTool:tool-type">
+<description>
+The type of the tool.
+
+</description>
+</property>
+
<enum name="GdkDeviceToolType">
<description>
Indicates the specific type of tool being used being a tablet. Such as an
@@ -478,8 +617,7 @@ airbrush, pencil, etc.
<signal name="GdkDisplay::closed">
<description>
-The ::closed signal is emitted when the connection to the windowing
-system for @display is closed.
+Emitted when the connection to the windowing system for @display is closed.
</description>
<parameters>
@@ -497,8 +635,7 @@ system for @display is closed.
<signal name="GdkDisplay::opened">
<description>
-The ::opened signal is emitted when the connection to the windowing
-system for @display is opened.
+Emitted when the connection to the windowing system for @display is opened.
</description>
<parameters>
@@ -512,8 +649,7 @@ system for @display is opened.
<signal name="GdkDisplay::seat-added">
<description>
-The ::seat-added signal is emitted whenever a new seat is made
-known to the windowing system.
+Emitted whenever a new seat is made known to the windowing system.
</description>
<parameters>
@@ -531,8 +667,7 @@ known to the windowing system.
<signal name="GdkDisplay::seat-removed">
<description>
-The ::seat-removed signal is emitted whenever a seat is removed
-by the windowing system.
+Emitted whenever a seat is removed by the windowing system.
</description>
<parameters>
@@ -550,8 +685,7 @@ by the windowing system.
<signal name="GdkDisplay::setting-changed">
<description>
-The ::setting-changed signal is emitted whenever a setting
-changes its value.
+Emitted whenever a setting changes its value.
</description>
<parameters>
@@ -570,30 +704,27 @@ changes its value.
<property name="GdkDisplay:composited">
<description>
%TRUE if the display properly composites the alpha channel.
-See gdk_display_is_composited() for details.
</description>
</property>
<property name="GdkDisplay:input-shapes">
<description>
-%TRUE if the display supports input shapes. See
-gdk_display_supports_input_shapes() for details.
+%TRUE if the display supports input shapes.
</description>
</property>
<property name="GdkDisplay:rgba">
<description>
-%TRUE if the display supports an alpha channel. See gdk_display_is_rgba()
-for details.
+%TRUE if the display supports an alpha channel.
</description>
</property>
<signal name="GdkDisplayManager::display-opened">
<description>
-The ::display-opened signal is emitted when a display is opened.
+Emitted when a display is opened.
</description>
<parameters>
@@ -609,9 +740,16 @@ The ::display-opened signal is emitted when a display is opened.
<return></return>
</signal>
+<property name="GdkDisplayManager:default-display">
+<description>
+The default display.
+
+</description>
+</property>
+
<signal name="GdkDrag::cancel">
<description>
-The drag operation was cancelled.
+Emitted when the drag operation is cancelled.
</description>
<parameters>
@@ -629,9 +767,9 @@ The drag operation was cancelled.
<signal name="GdkDrag::dnd-finished">
<description>
-The drag operation was finished, the destination
-finished reading all data. The drag object can now
-free all miscellaneous data.
+Emitted when the destination side has finished reading all data.
+
+The drag object can now free all miscellaneous data.
</description>
<parameters>
@@ -645,7 +783,7 @@ free all miscellaneous data.
<signal name="GdkDrag::drop-performed">
<description>
-The drag operation was performed on an accepting client.
+Emitted when the drop operation is performed on an accepting client.
</description>
<parameters>
@@ -657,23 +795,30 @@ The drag operation was performed on an accepting client.
<return></return>
</signal>
+<property name="GdkDrag:actions">
+<description>
+The possible actions of this drag.
+
+</description>
+</property>
+
<property name="GdkDrag:content">
<description>
-The #GdkContentProvider.
+The `GdkContentProvider`.
</description>
</property>
<property name="GdkDrag:device">
<description>
-The #GdkDevice that is performing the drag.
+The `GdkDevice` that is performing the drag.
</description>
</property>
<property name="GdkDrag:display">
<description>
-The #GdkDisplay that the drag belongs to.
+The `GdkDisplay` that the drag belongs to.
</description>
</property>
@@ -685,9 +830,23 @@ The possible formats that the drag can provide its data in.
</description>
</property>
+<property name="GdkDrag:selected-action">
+<description>
+The currently selected action of the drag.
+
+</description>
+</property>
+
+<property name="GdkDrag:surface">
+<description>
+The surface where the drag originates.
+
+</description>
+</property>
+
<enum name="GdkDragAction">
<description>
-Used in #GdkDrop and #GdkDrag to indicate the actions that the
+Used in `GdkDrop` and `GdkDrag` to indicate the actions that the
destination can and should do with the dropped data.
</description>
@@ -716,7 +875,7 @@ supported on all platforms.
<enum name="GdkDragCancelReason">
<description>
-Used in #GdkDrag to the reason of a cancelled DND operation.
+Used in `GdkDrag` to the reason of a cancelled DND operation.
</description>
<parameters>
@@ -737,14 +896,14 @@ Used in #GdkDrag to the reason of a cancelled DND operation.
<property name="GdkDrawContext:display">
<description>
-The #GdkDisplay used to create the #GdkDrawContext.
+The `GdkDisplay` used to create the `GdkDrawContext`.
</description>
</property>
<property name="GdkDrawContext:surface">
<description>
-The #GdkSurface the context is bound to.
+The `GdkSurface` the context is bound to.
</description>
</property>
@@ -758,21 +917,21 @@ The possible actions for this drop
<property name="GdkDrop:device">
<description>
-The #GdkDevice performing the drop
+The `GdkDevice` performing the drop
</description>
</property>
<property name="GdkDrop:display">
<description>
-The #GdkDisplay that the drop belongs to.
+The `GdkDisplay` that the drop belongs to.
</description>
</property>
<property name="GdkDrop:drag">
<description>
-The #GdkDrag that initiated this drop
+The `GdkDrag` that initiated this drop
</description>
</property>
@@ -786,7 +945,7 @@ The possible formats that the drop can provide its data in.
<property name="GdkDrop:surface">
<description>
-The #GdkSurface the drop happens on
+The `GdkSurface` the drop happens on
</description>
</property>
@@ -925,8 +1084,9 @@ is determined by its phase field.
<signal name="GdkFrameClock::after-paint">
<description>
-This signal ends processing of the frame. Applications
-should generally not handle this signal.
+This signal ends processing of the frame.
+
+Applications should generally not handle this signal.
</description>
<parameters>
@@ -940,8 +1100,9 @@ should generally not handle this signal.
<signal name="GdkFrameClock::before-paint">
<description>
-This signal begins processing of the frame. Applications
-should generally not handle this signal.
+Begins processing of the frame.
+
+Applications should generally not handle this signal.
</description>
<parameters>
@@ -955,9 +1116,10 @@ should generally not handle this signal.
<signal name="GdkFrameClock::flush-events">
<description>
-This signal is used to flush pending motion events that
-are being batched up and compressed together. Applications
-should not handle this signal.
+Used to flush pending motion events that are being batched up and
+compressed together.
+
+Applications should not handle this signal.
</description>
<parameters>
@@ -971,10 +1133,11 @@ should not handle this signal.
<signal name="GdkFrameClock::layout">
<description>
-This signal is emitted as the second step of toolkit and
-application processing of the frame. Any work to update
-sizes and positions of application elements should be
-performed. GTK normally handles this internally.
+Emitted as the second step of toolkit and application processing
+of the frame.
+
+Any work to update sizes and positions of application elements
+should be performed. GTK normally handles this internally.
</description>
<parameters>
@@ -988,11 +1151,12 @@ performed. GTK normally handles this internally.
<signal name="GdkFrameClock::paint">
<description>
-This signal is emitted as the third step of toolkit and
-application processing of the frame. The frame is
-repainted. GDK normally handles this internally and
-emits #GdkSurface::render which are turned into
-#GtkWidget::snapshot signals by GTK.
+Emitted as the third step of toolkit and application processing
+of the frame.
+
+The frame is repainted. GDK normally handles this internally and
+emits [signal@Gdk.Surface::render] signals which are turned into
+[signal@Gtk.Widget::snapshot] signals by GTK.
</description>
<parameters>
@@ -1006,8 +1170,9 @@ emits #GdkSurface::render which are turned into
<signal name="GdkFrameClock::resume-events">
<description>
-This signal is emitted after processing of the frame is
-finished, and is handled internally by GTK to resume normal
+Emitted after processing of the frame is finished.
+
+This signal is handled internally by GTK to resume normal
event processing. Applications should not handle this signal.
</description>
@@ -1022,12 +1187,12 @@ event processing. Applications should not handle this signal.
<signal name="GdkFrameClock::update">
<description>
-This signal is emitted as the first step of toolkit and
-application processing of the frame. Animations should
-be updated using gdk_frame_clock_get_frame_time().
-Applications can connect directly to this signal, or
-use gtk_widget_add_tick_callback() as a more convenient
-interface.
+Emitted as the first step of toolkit and application processing
+of the frame.
+
+Animations should be updated using [method@Gdk.FrameClock.get_frame_time].
+Applications can connect directly to this signal, or use
+[method@Gtk.Widget.add_tick_callback] as a more convenient interface.
</description>
<parameters>
@@ -1041,9 +1206,9 @@ interface.
<enum name="GdkFrameClockPhase">
<description>
-#GdkFrameClockPhase is used to represent the different paint clock
-phases that can be requested. The elements of the enumeration
-correspond to the signals of #GdkFrameClock.
+Used to represent the different paint clock phases that can be requested.
+
+The elements of the enumeration correspond to the signals of `GdkFrameClock`.
</description>
<parameters>
@@ -1084,8 +1249,7 @@ correspond to the signals of #GdkFrameClock.
<enum name="GdkFullscreenMode">
<description>
-Indicates which monitor (in a multi-head setup) a surface should span over
-when in fullscreen mode.
+Indicates which monitor a surface should span over when in fullscreen mode.
</description>
<parameters>
@@ -1102,14 +1266,14 @@ when in fullscreen mode.
<property name="GdkGLContext:shared-context">
<description>
-The #GdkGLContext that this context is sharing data with, or %NULL
+The `GdkGLContext` that this context is sharing data with, or %NULL
</description>
</property>
<enum name="GdkGLError">
<description>
-Error enumeration for #GdkGLContext.
+Error enumeration for `GdkGLContext`.
</description>
<parameters>
@@ -1229,11 +1393,12 @@ rings and strips found in drawing tablets
<enum name="GdkInterpType">
<description>
-This enumeration describes the different interpolation modes that
-can be used with the scaling functions. @GDK_INTERP_NEAREST is
-the fastest scaling method, but has horrible quality when
-scaling down. @GDK_INTERP_BILINEAR is the best choice if you
-aren't sure what to choose, it has a good speed/quality balance.
+Interpolation modes for scaling functions.
+
+The `GDK_INTERP_NEAREST` mode is the fastest scaling method, but has
+horrible quality when scaling down; `GDK_INTERP_BILINEAR` is the best
+choice if you aren't sure what to choose, it has a good speed/quality
+balance.
**Note**: Cubic filtering is missing from the list; hyperbolic
interpolation is just as fast and results in higher quality.
@@ -1278,8 +1443,9 @@ it has a lower quality than the @GDK_INTERP_BILINEAR filter
<enum name="GdkKeyMatch">
<description>
-The possible return values from gdk_key_event_matches()
-describe how well an event matches a given keyval and modifiers.
+Describes how well an event matches a given keyval and modifiers.
+
+`GdkKeyMatch` values are returned by [method@Gdk.KeyEvent.matches].
</description>
<parameters>
@@ -1301,8 +1467,9 @@ describe how well an event matches a given keyval and modifiers.
<signal name="GdkKeymap::direction-changed">
<description>
-The ::direction-changed signal gets emitted when the direction
-of the keymap changes. See gdk_keymap_get_direction().
+Emitted when the direction of the keymap changes.
+
+See gdk_keymap_get_direction().
</description>
<parameters>
@@ -1347,13 +1514,13 @@ See gdk_keymap_get_caps_lock_state().
<enum name="GdkMemoryFormat">
<description>
-#GdkMemoryFormat describes a format that bytes can have in memory.
+`GdkMemoryFormat` describes a format that bytes can have in memory.
It describes formats by listing the contents of the memory passed to it.
So GDK_MEMORY_A8R8G8B8 will be 1 byte (8 bits) of alpha, followed by a
byte each of red, green and blue. It is not endian-dependent, so
-CAIRO_FORMAT_ARGB32 is represented by different #GdkMemoryFormats on
-architectures with different endiannesses.
+CAIRO_FORMAT_ARGB32 is represented by different `GdkMemoryFormats`
+on architectures with different endiannesses.
Its naming is modelled after VkFormat (see
https://www.khronos.org/registry/vulkan/specs/1.0/html/vkspec.html#VkFormat
@@ -1410,9 +1577,11 @@ more formats get added, so do not rely on its concrete integer.
<enum name="GdkModifierType">
<description>
-A set of bit-flags to indicate the state of modifier keys and mouse buttons
-in various event types. Typical modifier keys are Shift, Control, Meta,
-Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.
+Flags to indicate the state of modifier keys and mouse buttons
+in events.
+
+Typical modifier keys are Shift, Control, Meta, Super, Hyper, Alt, Compose,
+Apple, CapsLock or ShiftLock.
Note that GDK may add internal values to events which include values outside
of this enumeration. Your code should preserve and ignore them. You can use
@@ -1476,8 +1645,7 @@ normally it is the Alt key).
<signal name="GdkMonitor::invalidate">
<description>
-The ::invalidate signal gets emitted when the output represented
-by @monitor gets disconnected.
+Emitted when the output represented by @monitor gets disconnected.
</description>
<parameters>
@@ -1489,6 +1657,83 @@ by @monitor gets disconnected.
<return></return>
</signal>
+<property name="GdkMonitor:connector">
+<description>
+The connector name.
+
+</description>
+</property>
+
+<property name="GdkMonitor:display">
+<description>
+The `GdkDisplay` of the monitor.
+
+</description>
+</property>
+
+<property name="GdkMonitor:geometry">
+<description>
+The geometry of the monitor.
+
+</description>
+</property>
+
+<property name="GdkMonitor:height-mm">
+<description>
+The height of the monitor, in millimeters.
+
+</description>
+</property>
+
+<property name="GdkMonitor:manufacturer">
+<description>
+The manufacturer name.
+
+</description>
+</property>
+
+<property name="GdkMonitor:model">
+<description>
+The model name.
+
+</description>
+</property>
+
+<property name="GdkMonitor:refresh-rate">
+<description>
+The refresh rate, in milli-Hertz.
+
+</description>
+</property>
+
+<property name="GdkMonitor:scale-factor">
+<description>
+The scale factor.
+
+</description>
+</property>
+
+<property name="GdkMonitor:subpixel-layout">
+<description>
+The subpixel layout.
+
+</description>
+</property>
+
+<property name="GdkMonitor:valid">
+<description>
+Whether the object is still valid.
+
+</description>
+</property>
+
+<property name="GdkMonitor:width-mm">
+<description>
+The width of the monitor, in millimeters.
+
+</description>
+</property>
+
<enum name="GdkNotifyType">
<description>
Specifies the kind of crossing for enter and leave events.
@@ -1542,7 +1787,7 @@ the icon theme for an icon changing.
</description>
<parameters>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable
+<parameter_description> a `GdkPaintable`
</parameter_description>
</parameter>
</parameters>
@@ -1551,18 +1796,21 @@ the icon theme for an icon changing.
<signal name="GdkPaintable::invalidate-size">
<description>
-Emitted when the intrinsic size of the @paintable changes. This means the values
-reported by at least one of gdk_paintable_get_intrinsic_width(),
-gdk_paintable_get_intrinsic_height() or gdk_paintable_get_intrinsic_aspect_ratio()
+Emitted when the intrinsic size of the @paintable changes.
+
+This means the values reported by at least one of
+[method@Gdk.Paintable.get_intrinsic_width],
+[method@Gdk.Paintable.get_intrinsic_height] or
+[method@Gdk.Paintable.get_intrinsic_aspect_ratio]
has changed.
-Examples for such an event would be a paintable displaying the contents of a toplevel
-surface being resized.
+Examples for such an event would be a paintable displaying
+the contents of a toplevel surface being resized.
</description>
<parameters>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable
+<parameter_description> a `GdkPaintable`
</parameter_description>
</parameter>
</parameters>
@@ -1571,20 +1819,21 @@ surface being resized.
<enum name="GdkPaintableFlags">
<description>
-Flags about this object. Implementations use these for optimizations
-such as caching.
+Flags about a paintable object.
+
+Implementations use these for optimizations such as caching.
</description>
<parameters>
<parameter name="GDK_PAINTABLE_STATIC_SIZE">
<parameter_description> The size is immutable.
-The #GdkPaintable::invalidate-size signal will never be
+The [signal@GdkPaintable::invalidate-size] signal will never be
emitted.
</parameter_description>
</parameter>
<parameter name="GDK_PAINTABLE_STATIC_CONTENTS">
<parameter_description> The content is immutable.
-The #GdkPaintable::invalidate-contents signal will never be
+The [signal@GdkPaintable::invalidate-contents] signal will never be
emitted.
</parameter_description>
</parameter>
@@ -1594,6 +1843,7 @@ emitted.
<signal name="GdkPixbuf::pixel-bytes">
<description>
If set, this pixbuf was created from read-only #GBytes.
+
Replaces GdkPixbuf::pixels.
Since: 2.32
@@ -1607,40 +1857,87 @@ Since: 2.32
<property name="GdkPixbuf:bits-per-sample">
<description>
The number of bits per sample.
+
Currently only 8 bit per sample are supported.
</description>
</property>
+<property name="GdkPixbuf:colorspace">
+<description>
+The color space of the pixbuf.
+
+Currently, only `GDK_COLORSPACE_RGB` is supported.
+
+</description>
+</property>
+
+<property name="GdkPixbuf:has-alpha">
+<description>
+Whether the pixbuf has an alpha channel.
+
+</description>
+</property>
+
+<property name="GdkPixbuf:height">
+<description>
+The number of rows of the pixbuf.
+
+</description>
+</property>
+
<property name="GdkPixbuf:n-channels">
<description>
-The number of samples per pixel.
+The number of samples per pixel.
+
Currently, only 3 or 4 samples per pixel are supported.
</description>
</property>
+<property name="GdkPixbuf:pixels">
+<description>
+A pointer to the pixel data of the pixbuf.
+
+</description>
+</property>
+
<property name="GdkPixbuf:rowstride">
<description>
The number of bytes between the start of a row and
-the start of the next row. This number must (obviously)
-be at least as large as the width of the pixbuf.
+the start of the next row.
+
+This number must (obviously) be at least as large as the
+width of the pixbuf.
+
+</description>
+</property>
+
+<property name="GdkPixbuf:width">
+<description>
+The number of columns of the pixbuf.
</description>
</property>
<enum name="GdkPixbufAlphaMode">
<description>
-These values can be passed to
-gdk_pixbuf_xlib_render_to_drawable_alpha() to control how the alpha
-channel of an image should be handled. This function can create a
-bilevel clipping mask (black and white) and use it while painting
-the image. In the future, when the X Window System gets an alpha
-channel extension, it will be possible to do full alpha
-compositing onto arbitrary drawables. For now both cases fall
-back to a bilevel clipping mask.
+Control the alpha channel for drawables.
+
+These values can be passed to gdk_pixbuf_xlib_render_to_drawable_alpha()
+in gdk-pixbuf-xlib to control how the alpha channel of an image should
+be handled.
+
+This function can create a bilevel clipping mask (black and white) and use
+it while painting the image.
+
+In the future, when the X Window System gets an alpha channel extension,
+it will be possible to do full alpha compositing onto arbitrary drawables.
+For now both cases fall back to a bilevel clipping mask.
-Deprecated: it is unused since 2.42.
+Deprecated: 2.42: There is no user of GdkPixbufAlphaMode in GdkPixbuf,
+and the Xlib utility functions have been split out to their own
+library, gdk-pixbuf-xlib
</description>
<parameters>
@@ -1661,9 +1958,10 @@ In the future it will do full alpha compositing.
<enum name="GdkPixbufError">
<description>
-An error code in the #GDK_PIXBUF_ERROR domain. Many gdk-pixbuf
-operations can cause errors in this domain, or in the #G_FILE_ERROR
-domain.
+An error code in the `GDK_PIXBUF_ERROR` domain.
+
+Many gdk-pixbuf operations can cause errors in this domain, or in
+the `G_FILE_ERROR` domain.
</description>
<parameters>
@@ -1727,9 +2025,11 @@ ignores modules that are not marked as threadsafe. (Since 2.28).
<signal name="GdkPixbufLoader::area-prepared">
<description>
This signal is emitted when the pixbuf loader has allocated the
-pixbuf in the desired size. After this signal is emitted,
-applications can call gdk_pixbuf_loader_get_pixbuf() to fetch
-the partially-loaded pixbuf.
+pixbuf in the desired size.
+
+After this signal is emitted, applications can call
+gdk_pixbuf_loader_get_pixbuf() to fetch the partially-loaded
+pixbuf.
</description>
<parameters>
@@ -1744,9 +2044,12 @@ the partially-loaded pixbuf.
<signal name="GdkPixbufLoader::area-updated">
<description>
This signal is emitted when a significant area of the image being
-loaded has been updated. Normally it means that a complete
-scanline has been read in, but it could be a different area as
-well. Applications can use this signal to know when to repaint
+loaded has been updated.
+
+Normally it means that a complete scanline has been read in, but
+it could be a different area as well.
+
+Applications can use this signal to know when to repaint
areas of an image that is being loaded.
</description>
@@ -1778,6 +2081,7 @@ areas of an image that is being loaded.
<signal name="GdkPixbufLoader::closed">
<description>
This signal is emitted when gdk_pixbuf_loader_close() is called.
+
It can be used by different parts of an application to receive
notification when an image loader is closed by the code that
drives it.
@@ -1796,9 +2100,11 @@ drives it.
<description>
This signal is emitted when the pixbuf loader has been fed the
initial amount of data that is required to figure out the size
-of the image that it will create. Applications can call
-gdk_pixbuf_loader_set_size() in response to this signal to set
-the desired size to which the image should be scaled.
+of the image that it will create.
+
+Applications can call gdk_pixbuf_loader_set_size() in response
+to this signal to set the desired size to which the image
+should be scaled.
</description>
<parameters>
@@ -1821,6 +2127,7 @@ the desired size to which the image should be scaled.
<enum name="GdkPixbufRotation">
<description>
The possible rotations which can be passed to gdk_pixbuf_rotate_simple().
+
To make them easier to use, their numerical values are the actual degrees.
</description>
@@ -1860,7 +2167,9 @@ determine the form of C source to be generated. The three values
@GDK_PIXDATA_DUMP_PIXDATA_STREAM, @GDK_PIXDATA_DUMP_PIXDATA_STRUCT
and @GDK_PIXDATA_DUMP_MACROS are mutually exclusive, as are
@GDK_PIXBUF_DUMP_GTYPES and @GDK_PIXBUF_DUMP_CTYPES. The remaining
-elements are optional flags that can be freely added.
+elements are optional flags that can be freely added.
+
+Deprecated: 2.32
</description>
<parameters>
@@ -1913,7 +2222,9 @@ macro definition to decode run-length encoded image data.
<description>
An enumeration containing three sets of flags for a #GdkPixdata struct:
one for the used colorspace, one for the width of the samples and one
-for the encoding of the pixel data.
+for the encoding of the pixel data.
+
+Deprecated: 2.32
</description>
<parameters>
@@ -1957,6 +2268,20 @@ which must be repeated.
</parameters>
</enum>
+<property name="GdkPopup:autohide">
+<description>
+Whether to hide on outside clicks.
+
+</description>
+</property>
+
+<property name="GdkPopup:parent">
+<description>
+The parent surface.
+
+</description>
+</property>
+
<enum name="GdkScrollDirection">
<description>
Specifies the direction for scroll events.
@@ -1989,8 +2314,7 @@ in scroll events. See gdk_scroll_event_get_deltas()
<signal name="GdkSeat::device-added">
<description>
-The ::device-added signal is emitted when a new input
-device is related to this seat.
+Emitted when a new input device is related to this seat.
</description>
<parameters>
@@ -1999,7 +2323,7 @@ device is related to this seat.
</parameter_description>
</parameter>
<parameter name="device">
-<parameter_description> the newly added #GdkDevice.
+<parameter_description> the newly added `GdkDevice`.
</parameter_description>
</parameter>
</parameters>
@@ -2008,8 +2332,7 @@ device is related to this seat.
<signal name="GdkSeat::device-removed">
<description>
-The ::device-removed signal is emitted when an
-input device is removed (e.g. unplugged).
+Emitted when an input device is removed (e.g. unplugged).
</description>
<parameters>
@@ -2018,7 +2341,7 @@ input device is removed (e.g. unplugged).
</parameter_description>
</parameter>
<parameter name="device">
-<parameter_description> the just removed #GdkDevice.
+<parameter_description> the just removed `GdkDevice`.
</parameter_description>
</parameter>
</parameters>
@@ -2027,10 +2350,11 @@ input device is removed (e.g. unplugged).
<signal name="GdkSeat::tool-added">
<description>
-The ::tool-added signal is emitted whenever a new tool
-is made known to the seat. The tool may later be assigned
-to a device (i.e. on proximity with a tablet). The device
-will emit the #GdkDevice::tool-changed signal accordingly.
+Emitted whenever a new tool is made known to the seat.
+
+The tool may later be assigned to a device (i.e. on
+proximity with a tablet). The device will emit the
+[signalGdkDevice::tool-changed] signal accordingly.
A same tool may be used by several devices.
@@ -2041,7 +2365,7 @@ A same tool may be used by several devices.
</parameter_description>
</parameter>
<parameter name="tool">
-<parameter_description> the new #GdkDeviceTool known to the seat
+<parameter_description> the new `GdkDeviceTool` known to the seat
</parameter_description>
</parameter>
</parameters>
@@ -2050,8 +2374,7 @@ A same tool may be used by several devices.
<signal name="GdkSeat::tool-removed">
<description>
-This signal is emitted whenever a tool is no longer known
-to this @seat.
+Emitted whenever a tool is no longer known to this @seat.
</description>
<parameters>
@@ -2060,7 +2383,7 @@ to this @seat.
</parameter_description>
</parameter>
<parameter name="tool">
-<parameter_description> the just removed #GdkDeviceTool
+<parameter_description> the just removed `GdkDeviceTool`
</parameter_description>
</parameter>
</parameters>
@@ -2069,7 +2392,7 @@ to this @seat.
<property name="GdkSeat:display">
<description>
-#GdkDisplay of this seat.
+`GdkDisplay` of this seat.
</description>
</property>
@@ -2156,7 +2479,7 @@ Emitted when @surface starts being present on the monitor.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> the #GdkSurface
+<parameter_description> the `GdkSurface`
</parameter_description>
</parameter>
<parameter name="monitor">
@@ -2175,7 +2498,7 @@ Emitted when GDK receives an input event for @surface.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> the #GdkSurface
+<parameter_description> the `GdkSurface`
</parameter_description>
</parameter>
<parameter name="event">
@@ -2198,7 +2521,7 @@ Surface size is reported in ”application pixels”, not
</description>
<parameters>
<parameter name="surface">
-<parameter_description> the #GdkSurface
+<parameter_description> the `GdkSurface`
</parameter_description>
</parameter>
<parameter name="width">
@@ -2220,7 +2543,7 @@ Emitted when @surface stops being present on the monitor.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> the #GdkSurface
+<parameter_description> the `GdkSurface`
</parameter_description>
</parameter>
<parameter name="monitor">
@@ -2239,7 +2562,7 @@ Emitted when part of the surface needs to be redrawn.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> the #GdkSurface
+<parameter_description> the `GdkSurface`
</parameter_description>
</parameter>
<parameter name="region">
@@ -2253,16 +2576,49 @@ Emitted when part of the surface needs to be redrawn.
<property name="GdkSurface:cursor">
<description>
-The mouse pointer for a #GdkSurface. See gdk_surface_set_cursor() and
-gdk_surface_get_cursor() for details.
+The mouse pointer for the `GdkSurface`.
</description>
</property>
<property name="GdkSurface:display">
<description>
-The #GdkDisplay connection of the surface. See gdk_surface_get_display()
-for details.
+The `GdkDisplay` connection of the surface.
+
+</description>
+</property>
+
+<property name="GdkSurface:frame-clock">
+<description>
+The `GdkFrameClock` of the surface.
+
+</description>
+</property>
+
+<property name="GdkSurface:height">
+<description>
+The height of the surface, in pixels.
+
+</description>
+</property>
+
+<property name="GdkSurface:mapped">
+<description>
+Whether the surface is mapped.
+
+</description>
+</property>
+
+<property name="GdkSurface:scale-factor">
+<description>
+The scale factor of the surface.
+
+</description>
+</property>
+
+<property name="GdkSurface:width">
+<description>
+The width of the surface in pixels.
</description>
</property>
@@ -2324,39 +2680,129 @@ The width of the texture, in pixels.
<signal name="GdkToplevel::compute-size">
<description>
-Compute the desired size of the toplevel, given the information passed via
-the #GdkToplevelSize object.
+Emitted when the size for the surface needs to be computed, when
+it is present.
-It will normally be emitted during or after gdk_toplevel_present(),
-depending on the configuration received by the windowing system. It may
-also be emitted at any other point in time, in response to the windowing
-system spontaneously changing the configuration.
+It will normally be emitted during or after [method@Gdk.Toplevel.present],
+depending on the configuration received by the windowing system.
+It may also be emitted at any other point in time, in response
+to the windowing system spontaneously changing the configuration.
-It is the responsibility of the GdkToplevel user to handle this signal;
-failing to do so will result in an arbitrary size being used as a result.
+It is the responsibility of the toplevel user to handle this signal
+and compute the desired size of the toplevel, given the information
+passed via the [struct@Gdk.ToplevelSize] object. Failing to do so
+will result in an arbitrary size being used as a result.
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> a #GdkToplevel
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
<parameter name="size">
-<parameter_description> a #GdkToplevelSize
+<parameter_description> a `GdkToplevelSize`
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>
+<property name="GdkToplevel:autohide">
+<description>
+Whether the toplevel should be modal with respect to its parent.
+
+</description>
+</property>
+
+<property name="GdkToplevel:decorated">
+<description>
+Whether the window manager should add decorations.
+
+</description>
+</property>
+
+<property name="GdkToplevel:deletable">
+<description>
+Whether the window manager should allow to close the surface.
+
+</description>
+</property>
+
+<property name="GdkToplevel:fullscreen-mode">
+<description>
+The fullscreen mode of the surface.
+
+</description>
+</property>
+
+<property name="GdkToplevel:icon-list">
+<description>
+A list of textures to use as icon.
+
+</description>
+</property>
+
+<property name="GdkToplevel:modal">
+<description>
+Whether the surface is modal.
+
+</description>
+</property>
+
+<property name="GdkToplevel:parent">
+<description>
+The parent surface of the toplevel.
+
+</description>
+</property>
+
+<property name="GdkToplevel:shortcuts-inhibited">
+<description>
+Whether the surface should inhibit keyboard shortcuts.
+
+</description>
+</property>
+
+<property name="GdkToplevel:startup-id">
+<description>
+The startup ID of the surface.
+
+See [class@Gdk.AppLaunchContext] for more information about
+startup feedback.
+
+</description>
+</property>
+
+<property name="GdkToplevel:state">
+<description>
+The state of the toplevel.
+
+</description>
+</property>
+
+<property name="GdkToplevel:title">
+<description>
+The title of the surface.
+
+</description>
+</property>
+
+<property name="GdkToplevel:transient-for">
+<description>
+The transient parent of the surface.
+
+</description>
+</property>
+
<enum name="GdkToplevelState">
<description>
Specifies the state of a toplevel surface.
-On platforms that support information about individual edges, the %GDK_TOPLEVEL_STATE_TILED
-state will be set whenever any of the individual tiled states is set. On platforms
-that lack that support, the tiled state will give an indication of tiledness without
-any of the per-edge states being set.
+On platforms that support information about individual edges, the
+%GDK_TOPLEVEL_STATE_TILED state will be set whenever any of the individual
+tiled states is set. On platforms that lack that support, the tiled state
+will give an indication of tiledness without any of the per-edge states
+being set.
</description>
<parameters>
@@ -2429,9 +2875,11 @@ any of the per-edge states being set.
<enum name="GdkTouchpadGesturePhase">
<description>
-Specifies the current state of a touchpad gesture. All gestures are
-guaranteed to begin with an event with phase %GDK_TOUCHPAD_GESTURE_PHASE_BEGIN,
-followed by 0 or several events with phase %GDK_TOUCHPAD_GESTURE_PHASE_UPDATE.
+Specifies the current state of a touchpad gesture.
+
+All gestures are guaranteed to begin with an event with phase
+%GDK_TOUCHPAD_GESTURE_PHASE_BEGIN, followed by 0 or several events
+with phase %GDK_TOUCHPAD_GESTURE_PHASE_UPDATE.
A finished gesture may have 2 possible outcomes, an event with phase
%GDK_TOUCHPAD_GESTURE_PHASE_END will be emitted when the gesture is
@@ -2471,8 +2919,9 @@ changes should be undone.
<signal name="GdkVulkanContext::images-updated">
<description>
-This signal is emitted when the images managed by this context have
-changed. Usually this means that the swapchain had to be recreated,
+Emitted when the images managed by this context have changed.
+
+Usually this means that the swapchain had to be recreated,
for example in response to a change of the surface size.
</description>
@@ -2505,13 +2954,13 @@ compiled in.
<function name="gdk_app_launch_context_get_display">
<description>
-Gets the #GdkDisplay that @context is for.
+Gets the `GdkDisplay` that @context is for.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkAppLaunchContext
+<parameter_description> a `GdkAppLaunchContext`
</parameter_description>
</parameter>
</parameters>
@@ -2521,8 +2970,9 @@ Gets the #GdkDisplay that @context is for.
<function name="gdk_app_launch_context_set_desktop">
<description>
-Sets the workspace on which applications will be launched when
-using this context when running under a window manager that
+Sets the workspace on which applications will be launched.
+
+This only works when running under a window manager that
supports multiple workspaces, as described in the
[Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec).
@@ -2533,7 +2983,7 @@ be the current workspace.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkAppLaunchContext
+<parameter_description> a `GdkAppLaunchContext`
</parameter_description>
</parameter>
<parameter name="desktop">
@@ -2552,12 +3002,12 @@ context.
Window Managers can use this information when displaying startup
notification.
-See also gdk_app_launch_context_set_icon_name().
+See also [method@Gdk.AppLaunchContext.set_icon_name].
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkAppLaunchContext
+<parameter_description> a `GdkAppLaunchContext`
</parameter_description>
</parameter>
<parameter name="icon">
@@ -2571,18 +3021,19 @@ See also gdk_app_launch_context_set_icon_name().
<function name="gdk_app_launch_context_set_icon_name">
<description>
Sets the icon for applications that are launched with this context.
+
The @icon_name will be interpreted in the same way as the Icon field
-in desktop files. See also gdk_app_launch_context_set_icon().
+in desktop files. See also [method@Gdk.AppLaunchContext.set_icon()].
If both @icon and @icon_name are set, the @icon_name takes priority.
If neither @icon or @icon_name is set, the icon is taken from either
-the file that is passed to launched application or from the #GAppInfo
+the file that is passed to launched application or from the `GAppInfo`
for the launched application itself.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkAppLaunchContext
+<parameter_description> a `GdkAppLaunchContext`
</parameter_description>
</parameter>
<parameter name="icon_name">
@@ -2595,8 +3046,10 @@ for the launched application itself.
<function name="gdk_app_launch_context_set_timestamp">
<description>
-Sets the timestamp of @context. The timestamp should ideally
-be taken from the event that triggered the launch.
+Sets the timestamp of @context.
+
+The timestamp should ideally be taken from the event that
+triggered the launch.
Window managers can use this information to avoid moving the
focus to the newly launched application when the user is busy
@@ -2606,7 +3059,7 @@ prevention'.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkAppLaunchContext
+<parameter_description> a `GdkAppLaunchContext`
</parameter_description>
</parameter>
<parameter name="timestamp">
@@ -2635,12 +3088,14 @@ Extract the button number from a button event.
<function name="gdk_cairo_context_cairo_create">
<description>
-Retrieves a Cairo context to be used to draw on the #GdkSurface
-of @context. A call to gdk_draw_context_begin_frame() with this
+Retrieves a Cairo context to be used to draw on the `GdkSurface`
+of @context.
+
+A call to [method@Gdk.DrawContext.begin_frame] with this
@context must have been done or this function will return %NULL.
The returned context is guaranteed to be valid until
-gdk_draw_context_end_frame() is called.
+[method@Gdk.DrawContext.end_frame] is called.
</description>
@@ -2651,20 +3106,22 @@ gdk_draw_context_end_frame() is called.
</parameter>
</parameters>
<return> a Cairo context to be used
-to draw the contents of the #GdkSurface. %NULL is returned
+to draw the contents of the `GdkSurface`. %NULL is returned
when @context is not drawing.
</return>
</function>
<function name="gdk_cairo_draw_from_gl">
<description>
-This is the main way to draw GL content in GTK. It takes a render buffer ID
-(@source_type == #GL_RENDERBUFFER) or a texture id (@source_type == #GL_TEXTURE)
-and draws it onto @cr with an OVER operation, respecting the current clip.
-The top left corner of the rectangle specified by @x, @y, @width and @height
-will be drawn at the current (0,0) position of the cairo_t.
+The main way to draw GL content in GTK.
-This will work for *all* cairo_t, as long as @surface is realized, but the
+It takes a render buffer ID (@source_type == #GL_RENDERBUFFER) or a texture
+id (@source_type == #GL_TEXTURE) and draws it onto @cr with an OVER operation,
+respecting the current clip. The top left corner of the rectangle specified
+by @x, @y, @width and @height will be drawn at the current (0,0) position of
+the `cairo_t`.
+
+This will work for *all* `cairo_t`, as long as @surface is realized, but the
fallback implementation that reads back the pixels from the buffer may be
used in the general case. In the case of direct drawing to a surface with
no special effects applied to @cr it will however use a more efficient
@@ -2755,7 +3212,7 @@ Adds the given region to the current path of @cr.
<function name="gdk_cairo_region_create_from_surface">
<description>
-Creates region that describes covers the area where the given
+Creates region that covers the area where the given
@surface is more than 50% opaque.
This function takes into account device offsets that might be
@@ -2769,7 +3226,7 @@ set with cairo_surface_set_device_offset().
</parameter_description>
</parameter>
</parameters>
-<return> A #cairo_region_t; must be freed with cairo_region_destroy()
+<return> A `cairo_region_t`; must be freed with cairo_region_destroy()
</return>
</function>
@@ -2822,15 +3279,16 @@ Sets the specified #GdkRGBA as the source color of @cr.
<function name="gdk_clipboard_get_content">
<description>
-Returns the #GdkContentProvider currently set on @clipboard. If the
-@clipboard is empty or its contents are not owned by the current process,
-%NULL will be returned.
+Returns the `GdkContentProvider` currently set on @clipboard.
+
+If the @clipboard is empty or its contents are not owned by the
+current process, %NULL will be returned.
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
</parameters>
@@ -2841,17 +3299,17 @@ if the clipboard does not maintain any content.
<function name="gdk_clipboard_get_display">
<description>
-Gets the #GdkDisplay that the clipboard was created for.
+Gets the `GdkDisplay` that the clipboard was created for.
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDisplay
+<return> a `GdkDisplay`
</return>
</function>
@@ -2863,7 +3321,7 @@ Gets the formats that the clipboard can provide its current contents in.
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
</parameters>
@@ -2873,17 +3331,19 @@ Gets the formats that the clipboard can provide its current contents in.
<function name="gdk_clipboard_is_local">
<description>
-Returns if the clipboard is local. A clipboard is considered local if it was
-last claimed by the running application.
+Returns if the clipboard is local.
-Note that gdk_clipboard_get_content() may return %NULL even on a local
-clipboard. In this case the clipboard is empty.
+A clipboard is considered local if it was last claimed
+by the running application.
+
+Note that [method@Gdk.Clipboard.get_content] may return %NULL
+even on a local clipboard. In this case the clipboard is empty.
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
</parameters>
@@ -2894,17 +3354,18 @@ clipboard. In this case the clipboard is empty.
<function name="gdk_clipboard_read_async">
<description>
Asynchronously requests an input stream to read the @clipboard's
-contents from. When the operation is finished @callback will be called.
-You can then call gdk_clipboard_read_finish() to get the result of the
-operation.
+contents from.
+
+When the operation is finished @callback will be called. You must then
+call [method@Gdk.Clipboard.read_finish] to get the result of the operation.
The clipboard will choose the most suitable mime type from the given list
-to fulfill the request, preferring the ones listed first.
+to fulfill the request, preferring the ones listed first.
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
<parameter name="mime_types">
@@ -2912,12 +3373,11 @@ to fulfill the request, preferring the ones listed first.
</parameter_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the [I/O priority][io-priority]
-of the request.
+<parameter_description> the I/O priority of the request
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional `GCancellable` object, %NULL to ignore.
</parameter_description>
</parameter>
<parameter name="callback">
@@ -2934,17 +3394,19 @@ of the request.
<function name="gdk_clipboard_read_finish">
<description>
-Finishes an asynchronous clipboard read started with gdk_clipboard_read_async().
+Finishes an asynchronous clipboard read.
+
+See [method@Gdk.Clipboard.read_async].
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult
+<parameter_description> a `GAsyncResult`
</parameter_description>
</parameter>
<parameter name="out_mime_type">
@@ -2953,33 +3415,33 @@ the chosen mime type in or %NULL
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError location to store the error occurring, or %NULL to
-ignore.
+<parameter_description> a `GError` location to store the error occurring, or %NULL to ignore.
</parameter_description>
</parameter>
</parameters>
-<return> a #GInputStream or %NULL on error.
+<return> a `GInputStream` or %NULL on error.
</return>
</function>
<function name="gdk_clipboard_read_text_async">
<description>
Asynchronously request the @clipboard contents converted to a string.
-When the operation is finished @callback will be called. You can then
-call gdk_clipboard_read_text_finish() to get the result.
-This is a simple wrapper around gdk_clipboard_read_value_async(). Use
-that function or gdk_clipboard_read_async() directly if you need more
-control over the operation.
+When the operation is finished @callback will be called. You must then
+call [method@Gdk.Clipboard.read_text_finish] to get the result.
+
+This is a simple wrapper around [method@Gdk.Clipboard.read_value_async].
+Use that function or [method@Gdk.Clipboard.read_async] directly if you
+need more control over the operation.
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional `GCancellable` object, %NULL to ignore
</parameter_description>
</parameter>
<parameter name="callback">
@@ -2996,48 +3458,49 @@ control over the operation.
<function name="gdk_clipboard_read_text_finish">
<description>
-Finishes an asynchronous clipboard read started with
-gdk_clipboard_read_text_async().
+Finishes an asynchronous clipboard read.
+
+See [method@Gdk.Clipboard.read_text_async].
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult
+<parameter_description> a `GAsyncResult`
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError location to store the error occurring, or %NULL to
-ignore.
+<parameter_description> a `GError` location to store the error occurring, or %NULL to ignore
</parameter_description>
</parameter>
</parameters>
-<return> a new string or %NULL on error.
+<return> a new string or %NULL on error
</return>
</function>
<function name="gdk_clipboard_read_texture_async">
<description>
-Asynchronously request the @clipboard contents converted to a #GdkPixbuf.
-When the operation is finished @callback will be called. You can then
-call gdk_clipboard_read_texture_finish() to get the result.
+Asynchronously request the @clipboard contents converted to a `GdkPixbuf`.
+
+When the operation is finished @callback will be called. You must then
+call [method@Gdk.Clipboard.read_texture_finish] to get the result.
-This is a simple wrapper around gdk_clipboard_read_value_async(). Use
-that function or gdk_clipboard_read_async() directly if you need more
-control over the operation.
+This is a simple wrapper around [method@Gdk.Clipboard.read_value_async].
+Use that function or [methos@Gdk.Clipboard.read_async] directly if you
+need more control over the operation.
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional `GCancellable` object, %NULL to ignore.
</parameter_description>
</parameter>
<parameter name="callback">
@@ -3054,54 +3517,54 @@ control over the operation.
<function name="gdk_clipboard_read_texture_finish">
<description>
-Finishes an asynchronous clipboard read started with
-gdk_clipboard_read_texture_async().
+Finishes an asynchronous clipboard read.
+
+See [method@Gdk.Clipboard.read_texture_async].
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult
+<parameter_description> a `GAsyncResult`
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError location to store the error occurring, or %NULL to
-ignore.
+<parameter_description> a `GError` location to store the error occurring, or %NULL to ignore
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkTexture or %NULL on error.
+<return> a new `GdkTexture` or %NULL on error
</return>
</function>
<function name="gdk_clipboard_read_value_async">
<description>
Asynchronously request the @clipboard contents converted to the given
-@type. When the operation is finished @callback will be called.
-You can then call gdk_clipboard_read_value_finish() to get the resulting
-#GValue.
+@type.
-For local clipboard contents that are available in the given #GType, the
-value will be copied directly. Otherwise, GDK will try to use
-gdk_content_deserialize_async() to convert the clipboard's data.
+When the operation is finished @callback will be called. You must then call
+[method@Gdk.Clipboard.read_value_finish] to get the resulting `GValue`.
+
+For local clipboard contents that are available in the given `GType`,
+the value will be copied directly. Otherwise, GDK will try to use
+[func@content_deserialize_async] to convert the clipboard's data.
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
<parameter name="type">
-<parameter_description> a #GType to read
+<parameter_description> a `GType` to read
</parameter_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the [I/O priority][io-priority]
-of the request.
+<parameter_description> the I/O priority of the request
</parameter_description>
</parameter>
<parameter name="cancellable">
@@ -3122,39 +3585,42 @@ of the request.
<function name="gdk_clipboard_read_value_finish">
<description>
-Finishes an asynchronous clipboard read started with
-gdk_clipboard_read_value_async().
+Finishes an asynchronous clipboard read.
+
+See [method@Gdk.Clipboard.read_value_async].
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult
+<parameter_description> a `GAsyncResult`
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError location to store the error occurring, or %NULL to
-ignore.
+<parameter_description> a GError` location to store the error occurring, or %NULL to ignore
</parameter_description>
</parameter>
</parameters>
-<return> a #GValue containing the result.
+<return> a `GValue` containing the result.
</return>
</function>
<function name="gdk_clipboard_set">
<description>
-Sets the clipboard to contain the value collected from the given
-varargs.
+Sets the clipboard to contain the value collected from the given varargs.
+
+```c
+gdk_clipboard_set (clipboard, GTK_TYPE_TEXT_BUFFER, buffer);
+```
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
<parameter name="type">
@@ -3171,9 +3637,10 @@ varargs.
<function name="gdk_clipboard_set_content">
<description>
-Sets a new content provider on @clipboard. The clipboard will claim the
-#GdkDisplay's resources and advertise these new contents to other
-applications.
+Sets a new content provider on @clipboard.
+
+The clipboard will claim the `GdkDisplay`'s resources and advertise
+these new contents to other applications.
In the rare case of a failure, this function will return %FALSE. The
clipboard will then continue reporting its old contents and ignore
@@ -3187,7 +3654,7 @@ transfer the contents and then request that format from @provider.
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
<parameter name="provider">
@@ -3207,7 +3674,7 @@ Puts the given @text into the clipboard.
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
<parameter name="text">
@@ -3225,11 +3692,11 @@ Puts the given @texture into the clipboard.
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
<parameter name="texture">
-<parameter_description> a #GdkTexture to put into the clipboard
+<parameter_description> a `GdkTexture` to put into the clipboard
</parameter_description>
</parameter>
</parameters>
@@ -3238,13 +3705,12 @@ Puts the given @texture into the clipboard.
<function name="gdk_clipboard_set_valist">
<description>
-Sets the clipboard to contain the value collected from the given
-@args.
+Sets the clipboard to contain the value collected from the given @args.
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
<parameter name="type">
@@ -3266,11 +3732,11 @@ Sets the @clipboard to contain the given @value.
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
<parameter name="value">
-<parameter_description> a #GValue to set
+<parameter_description> a `GValue` to set
</parameter_description>
</parameter>
</parameters>
@@ -3279,26 +3745,32 @@ Sets the @clipboard to contain the given @value.
<function name="gdk_clipboard_store_async">
<description>
-Asynchronously instructs the @clipboard to store its contents remotely to
-preserve them for later usage. If the clipboard is not local, this function
-does nothing but report success.
+Asynchronously instructs the @clipboard to store its contents remotely.
+
+If the clipboard is not local, this function does nothing but report success.
-This function is called automatically when gtk_main() or #GtkApplication
-exit, so you likely don't need to call it.
+The @callback must call [method@Gdk.Clipboard.store_finish].
+
+The purpose of this call is to preserve clipboard contents beyond the
+lifetime of an application, so this function is typically called on
+exit. Depending on the platform, the functionality may not be available
+unless a "clipboard manager" is running.
+
+This function is called automatically when a [class@Gtk.Application] is
+shut down, so you likely don't need to call it.
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the [I/O priority][io-priority]
-of the request.
+<parameter_description> the I/O priority of the request.
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional `GCancellable` object, %NULL to ignore.
</parameter_description>
</parameter>
<parameter name="callback">
@@ -3315,22 +3787,23 @@ of the request.
<function name="gdk_clipboard_store_finish">
<description>
-Finishes an asynchronous clipboard store started with gdk_clipboard_store_async().
+Finishes an asynchronous clipboard store.
+
+See [method@Gdk.Clipboard.store_async].
</description>
<parameters>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult
+<parameter_description> a `GAsyncResult`
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError location to store the error occurring, or %NULL to
-ignore.
+<parameter_description> a `GError` location to store the error occurring, or %NULL to ignore.
</parameter_description>
</parameter>
</parameters>
@@ -3341,13 +3814,17 @@ ignore.
<function name="gdk_content_deserialize_async">
<description>
Read content from the given input stream and deserialize it, asynchronously.
-When the operation is finished, @callback will be called. You can then
-call gdk_content_deserialize_finish() to get the result of the operation.
+
+The default I/O priority is %G_PRIORITY_DEFAULT (i.e. 0), and lower numbers
+indicate a higher priority.
+
+When the operation is finished, @callback will be called. You must then
+call [func@content_deserialize_finish] to get the result of the operation.
</description>
<parameters>
<parameter name="stream">
-<parameter_description> a #GInputStream to read the serialized content from
+<parameter_description> a `GInputStream` to read the serialized content from
</parameter_description>
</parameter>
<parameter name="mime_type">
@@ -3359,11 +3836,11 @@ call gdk_content_deserialize_finish() to get the result of the operation.
</parameter_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the io priority of the operation
+<parameter_description> the I/O priority of the operation
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object
+<parameter_description> optional `GCancellable` object
</parameter_description>
</parameter>
<parameter name="callback">
@@ -3386,7 +3863,7 @@ Finishes a content deserialization operation.
</description>
<parameters>
<parameter name="result">
-<parameter_description> the #GAsyncResult
+<parameter_description> the `GAsyncResult`
</parameter_description>
</parameter>
<parameter name="value">
@@ -3398,20 +3875,23 @@ Finishes a content deserialization operation.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the operation was successful. In this case, @value is set.
-%FALSE if an error occurred. In this case, @error is set
+<return> %TRUE if the operation was successful. In this case,
+@value is set. %FALSE if an error occurred. In this case,
+@error is set
</return>
</function>
<function name="gdk_content_deserializer_get_cancellable">
<description>
-Gets the cancellable that was passed to gdk_content_deserialize_async().
+Gets the cancellable for the current operation.
+
+This is the `GCancellable` that was passed to [func@content_deserialize_async].
</description>
<parameters>
<parameter name="deserializer">
-<parameter_description> a #GdkContentDeserializer
+<parameter_description> a `GdkContentDeserializer`
</parameter_description>
</parameter>
</parameters>
@@ -3427,7 +3907,7 @@ Gets the GType to create an instance of.
</description>
<parameters>
<parameter name="deserializer">
-<parameter_description> a #GdkContentDeserializer
+<parameter_description> a `GdkContentDeserializer`
</parameter_description>
</parameter>
</parameters>
@@ -3437,13 +3917,15 @@ Gets the GType to create an instance of.
<function name="gdk_content_deserializer_get_input_stream">
<description>
-Gets the input stream that was passed to gdk_content_deserialize_async().
+Gets the input stream for the current operation.
+
+This is the stream that was passed to [func@content_deserialize_async].
</description>
<parameters>
<parameter name="deserializer">
-<parameter_description> a #GdkContentDeserializer
+<parameter_description> a `GdkContentDeserializer`
</parameter_description>
</parameter>
</parameters>
@@ -3459,7 +3941,7 @@ Gets the mime type to deserialize from.
</description>
<parameters>
<parameter name="deserializer">
-<parameter_description> a #GdkContentDeserializer
+<parameter_description> a `GdkContentDeserializer`
</parameter_description>
</parameter>
</parameters>
@@ -3469,29 +3951,33 @@ Gets the mime type to deserialize from.
<function name="gdk_content_deserializer_get_priority">
<description>
-Gets the io priority that was passed to gdk_content_deserialize_async().
+Gets the I/O priority for the current operation.
+
+This is the priority that was passed to [funccontent_deserialize_async].
</description>
<parameters>
<parameter name="deserializer">
-<parameter_description> a #GdkContentDeserializer
+<parameter_description> a `GdkContentDeserializer`
</parameter_description>
</parameter>
</parameters>
-<return> the io priority for the current operation
+<return> the I/O priority for the current operation
</return>
</function>
<function name="gdk_content_deserializer_get_task_data">
<description>
-Gets the data that was associated with @deserializer via gdk_content_deserializer_set_task_data().
+Gets the data that was associated with the current operation.
+
+See [method@Gdk.ContentDeserializer.set_task_data].
</description>
<parameters>
<parameter name="deserializer">
-<parameter_description> a #GdkContentDeserializer
+<parameter_description> a `GdkContentDeserializer`
</parameter_description>
</parameter>
</parameters>
@@ -3507,7 +3993,7 @@ Gets the user data that was passed when the deserializer was registered.
</description>
<parameters>
<parameter name="deserializer">
-<parameter_description> a #GdkContentDeserializer
+<parameter_description> a `GdkContentDeserializer`
</parameter_description>
</parameter>
</parameters>
@@ -3517,33 +4003,34 @@ Gets the user data that was passed when the deserializer was registered.
<function name="gdk_content_deserializer_get_value">
<description>
-Gets the #GValue to store the deserialized object in.
+Gets the `GValue` to store the deserialized object in.
</description>
<parameters>
<parameter name="deserializer">
-<parameter_description> a #GdkContentDeserializer
+<parameter_description> a `GdkContentDeserializer`
</parameter_description>
</parameter>
</parameters>
-<return> the #GValue for the current operation
+<return> the `GValue` for the current operation
</return>
</function>
<function name="gdk_content_deserializer_return_error">
<description>
Indicate that the deserialization has ended with an error.
+
This function consumes @error.
</description>
<parameters>
<parameter name="deserializer">
-<parameter_description> a #GdkContentDeserializer
+<parameter_description> a `GdkContentDeserializer`
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError
+<parameter_description> a `GError`
</parameter_description>
</parameter>
</parameters>
@@ -3557,7 +4044,7 @@ Indicate that the deserialization has been successfully completed.
</description>
<parameters>
<parameter name="deserializer">
-<parameter_description> a #GdkContentDeserializer
+<parameter_description> a `GdkContentDeserializer`
</parameter_description>
</parameter>
</parameters>
@@ -3571,7 +4058,7 @@ Associate data with the current deserialization operation.
</description>
<parameters>
<parameter name="deserializer">
-<parameter_description> a #GdkContentDeserializer
+<parameter_description> a `GdkContentDeserializer`
</parameter_description>
</parameter>
<parameter name="data">
@@ -3594,7 +4081,7 @@ already exist.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GdkContentFormatsBuilder
+<parameter_description> a `GdkContentFormatsBuilder`
</parameter_description>
</parameter>
<parameter name="formats">
@@ -3607,16 +4094,16 @@ already exist.
<function name="gdk_content_formats_builder_add_gtype">
<description>
-Appends @gtype to @builder if it has not already been added.
+Appends @type to @builder if it has not already been added.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GdkContentFormatsBuilder
+<parameter_description> a `GdkContentFormats`Builder
</parameter_description>
</parameter>
<parameter name="type">
-<parameter_description> a #GType
+<parameter_description> a `GType`
</parameter_description>
</parameter>
</parameters>
@@ -3630,7 +4117,7 @@ Appends @mime_type to @builder if it has not already been added.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GdkContentFormatsBuilder
+<parameter_description> a `GdkContentFormatsBuilder`
</parameter_description>
</parameter>
<parameter name="mime_type">
@@ -3643,33 +4130,34 @@ Appends @mime_type to @builder if it has not already been added.
<function name="gdk_content_formats_builder_free_to_formats">
<description>
-Creates a new #GdkContentFormats from the current state of the
+Creates a new `GdkContentFormats` from the current state of the
given @builder, and frees the @builder instance.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GdkContentFormatsBuilder
+<parameter_description> a `GdkContentFormatsBuilder`
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GdkContentFormats
+<return> the newly created `GdkContentFormats`
with all the formats added to @builder
</return>
</function>
<function name="gdk_content_formats_builder_new">
<description>
-Create a new #GdkContentFormatsBuilder object. The resulting builder
-would create an empty #GdkContentFormats. Use addition functions to add
-types to it.
+Create a new `GdkContentFormatsBuilder` object.
+
+The resulting builder would create an empty `GdkContentFormats`.
+Use addition functions to add types to it.
</description>
<parameters>
</parameters>
-<return> a new #GdkContentFormatsBuilder
+<return> a new `GdkContentFormatsBuilder`
</return>
</function>
@@ -3677,41 +4165,41 @@ types to it.
<description>
Acquires a reference on the given @builder.
-This function is intended primarily for bindings. #GdkContentFormatsBuilder objects
-should not be kept around.
+This function is intended primarily for bindings.
+`GdkContentFormatsBuilder` objects should not be kept around.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GdkContentFormatsBuilder
+<parameter_description> a `GdkContentFormatsBuilder`
</parameter_description>
</parameter>
</parameters>
-<return> the given #GdkContentFormatsBuilder with
-its reference count increased
+<return> the given `GdkContentFormatsBuilder`
+with its reference count increased
</return>
</function>
<function name="gdk_content_formats_builder_to_formats">
<description>
-Creates a new #GdkContentFormats from the given @builder.
+Creates a new `GdkContentFormats` from the given @builder.
-The given #GdkContentFormatsBuilder is reset once this function returns;
+The given `GdkContentFormatsBuilder` is reset once this function returns;
you cannot call this function multiple times on the same @builder instance.
This function is intended primarily for bindings. C code should use
-gdk_content_formats_builder_free_to_formats().
+[method@Gdk.ContentFormatsBuilder.free_to_formats].
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GdkContentFormatsBuilder
+<parameter_description> a `GdkContentFormats`Builder
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GdkContentFormats
+<return> the newly created `GdkContentFormats`
with all the formats added to @builder
</return>
</function>
@@ -3723,7 +4211,7 @@ Releases a reference on the given @builder.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GdkContentFormatsBuilder
+<parameter_description> a `GdkContentFormatsBuilder`
</parameter_description>
</parameter>
</parameters>
@@ -3732,17 +4220,17 @@ Releases a reference on the given @builder.
<function name="gdk_content_formats_contain_gtype">
<description>
-Checks if a given #GType is part of the given @formats.
+Checks if a given `GType` is part of the given @formats.
</description>
<parameters>
<parameter name="formats">
-<parameter_description> a #GdkContentFormats
+<parameter_description> a `GdkContentFormats`
</parameter_description>
</parameter>
<parameter name="type">
-<parameter_description> the #GType to search for
+<parameter_description> the `GType` to search for
</parameter_description>
</parameter>
</parameters>
@@ -3758,7 +4246,7 @@ Checks if a given mime type is part of the given @formats.
</description>
<parameters>
<parameter name="formats">
-<parameter_description> a #GdkContentFormats
+<parameter_description> a `GdkContentFormats`
</parameter_description>
</parameter>
<parameter name="mime_type">
@@ -3772,15 +4260,16 @@ Checks if a given mime type is part of the given @formats.
<function name="gdk_content_formats_get_gtypes">
<description>
-Gets the #GTypes included in @formats. Note that @formats may not
-contain any #GTypes, in particular when they are empty. In that
-case %NULL will be returned.
+Gets the `GTypes` included in @formats.
+
+Note that @formats may not contain any #GTypes, in particular when
+they are empty. In that case %NULL will be returned.
</description>
<parameters>
<parameter name="formats">
-<parameter_description> a #GdkContentFormats
+<parameter_description> a `GdkContentFormats`
</parameter_description>
</parameter>
<parameter name="n_gtypes">
@@ -3797,15 +4286,16 @@ number of #GTypes contained in the return value
<function name="gdk_content_formats_get_mime_types">
<description>
-Gets the mime types included in @formats. Note that @formats may not
-contain any mime types, in particular when they are empty. In that
-case %NULL will be returned.
+Gets the mime types included in @formats.
+
+Note that @formats may not contain any mime types, in particular
+when they are empty. In that case %NULL will be returned.
</description>
<parameters>
<parameter name="formats">
-<parameter_description> a #GdkContentFormats
+<parameter_description> a `GdkContentFormats`
</parameter_description>
</parameter>
<parameter name="n_mime_types">
@@ -3814,7 +4304,7 @@ number of mime types contained in the return value
</parameter_description>
</parameter>
</parameters>
-<return> %NULL-terminated array of
+<return> %NULL-terminated array of
interned strings of mime types included in @formats or %NULL
if none.
</return>
@@ -3828,11 +4318,11 @@ Checks if @first and @second have any matching formats.
</description>
<parameters>
<parameter name="first">
-<parameter_description> the primary #GdkContentFormats to intersect
+<parameter_description> the primary `GdkContentFormats` to intersect
</parameter_description>
</parameter>
<parameter name="second">
-<parameter_description> the #GdkContentFormats to intersect with
+<parameter_description> the `GdkContentFormats` to intersect with
</parameter_description>
</parameter>
</parameters>
@@ -3842,41 +4332,43 @@ Checks if @first and @second have any matching formats.
<function name="gdk_content_formats_match_gtype">
<description>
-Finds the first #GType from @first that is also contained
-in @second. If no matching #GType is found, %G_TYPE_INVALID
-is returned.
+Finds the first `GType` from @first that is also contained
+in @second.
+
+If no matching `GType` is found, %G_TYPE_INVALID is returned.
</description>
<parameters>
<parameter name="first">
-<parameter_description> the primary #GdkContentFormats to intersect
+<parameter_description> the primary `GdkContentFormats` to intersect
</parameter_description>
</parameter>
<parameter name="second">
-<parameter_description> the #GdkContentFormats to intersect with
+<parameter_description> the `GdkContentFormats` to intersect with
</parameter_description>
</parameter>
</parameters>
-<return> The first common #GType or %G_TYPE_INVALID if none.
+<return> The first common `GType` or %G_TYPE_INVALID if none.
</return>
</function>
<function name="gdk_content_formats_match_mime_type">
<description>
Finds the first mime type from @first that is also contained
-in @second. If no matching mime type is found, %NULL is
-returned.
+in @second.
+
+If no matching mime type is found, %NULL is returned.
</description>
<parameters>
<parameter name="first">
-<parameter_description> the primary #GdkContentFormats to intersect
+<parameter_description> the primary `GdkContentFormats` to intersect
</parameter_description>
</parameter>
<parameter name="second">
-<parameter_description> the #GdkContentFormats to intersect with
+<parameter_description> the `GdkContentFormats` to intersect with
</parameter_description>
</parameter>
</parameters>
@@ -3886,11 +4378,11 @@ returned.
<function name="gdk_content_formats_new">
<description>
-Creates a new #GdkContentFormats from an array of mime types.
+Creates a new `GdkContentFormats` from an array of mime types.
The mime types must be valid and different from each other or the
behavior of the return value is undefined. If you cannot guarantee
-this, use #GdkContentFormatsBuilder instead.
+this, use `GdkContentFormatsBuilder` instead.
</description>
@@ -3905,29 +4397,30 @@ array of mime types
</parameter_description>
</parameter>
</parameters>
-<return> the new #GdkContentFormats.
+<return> the new `GdkContentFormats`.
</return>
</function>
<function name="gdk_content_formats_new_for_gtype">
<description>
-Creates a new #GdkContentFormats for a given #GType.
+Creates a new `GdkContentFormats` for a given `GType`.
</description>
<parameters>
<parameter name="type">
-<parameter_description> a $GType
+<parameter_description> a `GType`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkContentFormats
+<return> a new `GdkContentFormats`
</return>
</function>
<function name="gdk_content_formats_print">
<description>
Prints the given @formats into a string for human consumption.
+
This is meant for debugging and logging.
The form of the representation may change at any time and is
@@ -3936,11 +4429,11 @@ not guaranteed to stay identical.
</description>
<parameters>
<parameter name="formats">
-<parameter_description> a #GdkContentFormats
+<parameter_description> a `GdkContentFormats`
</parameter_description>
</parameter>
<parameter name="string">
-<parameter_description> a #GString to print into
+<parameter_description> a `GString` to print into
</parameter_description>
</parameter>
</parameters>
@@ -3949,31 +4442,32 @@ not guaranteed to stay identical.
<function name="gdk_content_formats_ref">
<description>
-Increases the reference count of a #GdkContentFormats by one.
+Increases the reference count of a `GdkContentFormats` by one.
</description>
<parameters>
<parameter name="formats">
-<parameter_description> a #GdkContentFormats
+<parameter_description> a `GdkContentFormats`
</parameter_description>
</parameter>
</parameters>
-<return> the passed in #GdkContentFormats.
+<return> the passed in `GdkContentFormats`.
</return>
</function>
<function name="gdk_content_formats_to_string">
<description>
Prints the given @formats into a human-readable string.
-This is a small wrapper around gdk_content_formats_print() to help
-when debugging.
+
+This is a small wrapper around [method@Gdk.ContentFormats.print]
+to help when debugging.
</description>
<parameters>
<parameter name="formats">
-<parameter_description> a #GdkContentFormats
+<parameter_description> a `GdkContentFormats`
</parameter_description>
</parameter>
</parameters>
@@ -3990,15 +4484,15 @@ they had in @second.
</description>
<parameters>
<parameter name="first">
-<parameter_description> the #GdkContentFormats to merge into
+<parameter_description> the `GdkContentFormats` to merge into
</parameter_description>
</parameter>
<parameter name="second">
-<parameter_description> the #GdkContentFormats to merge from
+<parameter_description> the `GdkContentFormats` to merge from
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkContentFormats
+<return> a new `GdkContentFormats`
</return>
</function>
@@ -4007,12 +4501,12 @@ they had in @second.
Add GTypes for mime types in @formats for which deserializers are
registered.
-Return: a new #GdkContentFormats
+Return: a new `GdkContentFormats`
</description>
<parameters>
<parameter name="formats">
-<parameter_description> a #GdkContentFormats
+<parameter_description> a `GdkContentFormats`
</parameter_description>
</parameter>
</parameters>
@@ -4024,12 +4518,12 @@ Return: a new #GdkContentFormats
Add mime types for GTypes in @formats for which deserializers are
registered.
-Return: a new #GdkContentFormats
+Return: a new `GdkContentFormats`
</description>
<parameters>
<parameter name="formats">
-<parameter_description> a #GdkContentFormats
+<parameter_description> a `GdkContentFormats`
</parameter_description>
</parameter>
</parameters>
@@ -4041,12 +4535,12 @@ Return: a new #GdkContentFormats
Add GTypes for the mime types in @formats for which serializers are
registered.
-Return: a new #GdkContentFormats
+Return: a new `GdkContentFormats`
</description>
<parameters>
<parameter name="formats">
-<parameter_description> a #GdkContentFormats
+<parameter_description> a `GdkContentFormats`
</parameter_description>
</parameter>
</parameters>
@@ -4058,12 +4552,12 @@ Return: a new #GdkContentFormats
Add mime types for GTypes in @formats for which serializers are
registered.
-Return: a new #GdkContentFormats
+Return: a new `GdkContentFormats`
</description>
<parameters>
<parameter name="formats">
-<parameter_description> a #GdkContentFormats
+<parameter_description> a `GdkContentFormats`
</parameter_description>
</parameter>
</parameters>
@@ -4072,13 +4566,14 @@ Return: a new #GdkContentFormats
<function name="gdk_content_formats_unref">
<description>
-Decreases the reference count of a #GdkContentFormats by one.
+Decreases the reference count of a `GdkContentFormats` by one.
+
If the resulting reference count is zero, frees the formats.
</description>
<parameters>
<parameter name="formats">
-<parameter_description> a #GdkContentFormats
+<parameter_description> a `GdkContentFormats`
</parameter_description>
</parameter>
</parameters>
@@ -4087,12 +4582,12 @@ If the resulting reference count is zero, frees the formats.
<function name="gdk_content_provider_content_changed">
<description>
-Emits the #GdkContentProvider::content-changed signal.
+Emits the ::content-changed signal.
</description>
<parameters>
<parameter name="provider">
-<parameter_description> a #GdkContentProvider
+<parameter_description> a `GdkContentProvider`
</parameter_description>
</parameter>
</parameters>
@@ -4103,26 +4598,25 @@ Emits the #GdkContentProvider::content-changed signal.
<description>
Gets the contents of @provider stored in @value.
-The @value will have been initialized to the #GType the value should be
-provided in. This given #GType does not need to be listed in the formats
-returned by gdk_content_provider_ref_formats(). However, if the given
-#GType is not supported, this operation can fail and
+The @value will have been initialized to the `GType` the value should be
+provided in. This given `GType` does not need to be listed in the formats
+returned by [method@Gdk.ContentProvider.ref_formats]. However, if the
+given `GType` is not supported, this operation can fail and
#G_IO_ERROR_NOT_SUPPORTED will be reported.
</description>
<parameters>
<parameter name="provider">
-<parameter_description> a #GdkContentProvider
+<parameter_description> a `GdkContentProvider`
</parameter_description>
</parameter>
<parameter name="value">
-<parameter_description> the #GValue to fill
+<parameter_description> the `GValue` to fill
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError location to store the error occurring, or %NULL to
-ignore.
+<parameter_description> a `GError` location to store the error occurring, or %NULL to ignore
</parameter_description>
</parameter>
</parameters>
@@ -4144,11 +4638,11 @@ the given @mime_type.
</parameter_description>
</parameter>
<parameter name="bytes">
-<parameter_description> a #GBytes with the data for @mime_type
+<parameter_description> a `GBytes` with the data for @mime_type
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkContentProvider
+<return> a new `GdkContentProvider`
</return>
</function>
@@ -4160,11 +4654,11 @@ Create a content provider that provides the given @value.
</description>
<parameters>
<parameter name="value">
-<parameter_description> a #GValue
+<parameter_description> a `GValue`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkContentProvider
+<return> a new `GdkContentProvider`
</return>
</function>
@@ -4188,7 +4682,7 @@ apply as when calling g_object_new() or g_object_set().
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkContentProvider
+<return> a new `GdkContentProvider`
</return>
</function>
@@ -4203,13 +4697,12 @@ be chosen to provide it.
This allows an easy way to support providing data in different formats.
For example, an image may be provided by its file and by the image
contents with a call such as
-|[<!-- language="C" -->
+```c
gdk_content_provider_new_union ((GdkContentProvider *[2]) {
gdk_content_provider_new_typed (G_TYPE_FILE, file),
gdk_content_provider_new_typed (G_TYPE_TEXTURE, texture)
}, 2);
-]|
-
+```
</description>
@@ -4224,7 +4717,7 @@ The #GdkContentProviders to present the union of
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkContentProvider
+<return> a new `GdkContentProvider`
</return>
</function>
@@ -4247,10 +4740,11 @@ Gets the formats that the provider can provide its current contents in.
<function name="gdk_content_provider_ref_storable_formats">
<description>
Gets the formats that the provider suggests other applications to store
-the data in.
+the data in.
+
An example of such an application would be a clipboard manager.
-This can be assumed to be a subset of gdk_content_provider_ref_formats().
+This can be assumed to be a subset of [method@Gdk.ContentProvider.ref_formats].
</description>
@@ -4267,20 +4761,22 @@ This can be assumed to be a subset of gdk_content_provider_ref_formats().
<function name="gdk_content_provider_write_mime_type_async">
<description>
Asynchronously writes the contents of @provider to @stream in the given
-@mime_type. When the operation is finished @callback will be called. You
-can then call gdk_content_provider_write_mime_type_finish() to get the
-result of the operation.
+@mime_type.
+
+When the operation is finished @callback will be called. You must then call
+[method@Gdk.ContentProvider.write_mime_type_finish] to get the result
+of the operation.
The given mime type does not need to be listed in the formats returned by
-gdk_content_provider_ref_formats(). However, if the given #GType is not
-supported, #G_IO_ERROR_NOT_SUPPORTED will be reported.
+[method@Gdk.ContentProvider.ref_formats]. However, if the given `GType` is
+not supported, #G_IO_ERROR_NOT_SUPPORTED will be reported.
The given @stream will not be closed.
</description>
<parameters>
<parameter name="provider">
-<parameter_description> a #GdkContentProvider
+<parameter_description> a `GdkContentProvider`
</parameter_description>
</parameter>
<parameter name="mime_type">
@@ -4288,16 +4784,15 @@ The given @stream will not be closed.
</parameter_description>
</parameter>
<parameter name="stream">
-<parameter_description> the #GOutputStream to write to
+<parameter_description> the `GOutputStream` to write to
</parameter_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the [I/O priority][io-priority]
-of the request.
+<parameter_description> I/O priority of the request.
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional `GCancellable` object, %NULL to ignore.
</parameter_description>
</parameter>
<parameter name="callback">
@@ -4314,23 +4809,23 @@ of the request.
<function name="gdk_content_provider_write_mime_type_finish">
<description>
-Finishes an asynchronous write operation started with
-gdk_content_provider_write_mime_type_async().
+Finishes an asynchronous write operation.
+
+See [method@Gdk.ContentProvider.write_mime_type_async].
</description>
<parameters>
<parameter name="provider">
-<parameter_description> a #GdkContentProvider
+<parameter_description> a `GdkContentProvider`
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult
+<parameter_description> a `GAsyncResult`
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError location to store the error occurring, or %NULL to
-ignore.
+<parameter_description> a `GError` location to store the error occurring, or %NULL to ignore
</parameter_description>
</parameter>
</parameters>
@@ -4341,8 +4836,7 @@ ignore.
<function name="gdk_content_register_deserializer">
<description>
-Registers a function to create objects of a given @type from
-a serialized representation with the given mime type.
+Registers a function to deserialize object of a given type.
</description>
<parameters>
@@ -4372,8 +4866,7 @@ a serialized representation with the given mime type.
<function name="gdk_content_register_serializer">
<description>
-Registers a function to convert objects of the given @type to
-a serialized representation with the given mime type.
+Registers a function to serialize objects of a given type.
</description>
<parameters>
@@ -4404,13 +4897,17 @@ a serialized representation with the given mime type.
<function name="gdk_content_serialize_async">
<description>
Serialize content and write it to the given output stream, asynchronously.
-When the operation is finished, @callback will be called. You can then
-call gdk_content_serialize_finish() to get the result of the operation.
+
+The default I/O priority is %G_PRIORITY_DEFAULT (i.e. 0), and lower numbers
+indicate a higher priority.
+
+When the operation is finished, @callback will be called. You must then
+call [func@content_serialize_finish] to get the result of the operation.
</description>
<parameters>
<parameter name="stream">
-<parameter_description> a #GOutputStream to write the serialized content to
+<parameter_description> a `GOutputStream` to write the serialized content to
</parameter_description>
</parameter>
<parameter name="mime_type">
@@ -4422,7 +4919,7 @@ call gdk_content_serialize_finish() to get the result of the operation.
</parameter_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the io priority of the operation
+<parameter_description> the I/O priority of the operation
</parameter_description>
</parameter>
<parameter name="cancellable">
@@ -4449,7 +4946,7 @@ Finishes a content serialization operation.
</description>
<parameters>
<parameter name="result">
-<parameter_description> the #GAsyncResult
+<parameter_description> the `GAsyncResult`
</parameter_description>
</parameter>
<parameter name="error">
@@ -4464,13 +4961,15 @@ error occurred. In this case, @error is set
<function name="gdk_content_serializer_get_cancellable">
<description>
-Gets the cancellable that was passed to gdk_content_serialize_async().
+Gets the cancellable for the current operation.
+
+This is the `GCancellable` that was passed to [content_serialize_async].
</description>
<parameters>
<parameter name="serializer">
-<parameter_description> a #GdkContentSerializer
+<parameter_description> a `GdkContentSerializer`
</parameter_description>
</parameter>
</parameters>
@@ -4480,17 +4979,17 @@ Gets the cancellable that was passed to gdk_content_serialize_async().
<function name="gdk_content_serializer_get_gtype">
<description>
-Gets the GType to of the object to serialize.
+Gets the `GType` to of the object to serialize.
</description>
<parameters>
<parameter name="serializer">
-<parameter_description> a #GdkContentSerializer
+<parameter_description> a `GdkContentSerializer`
</parameter_description>
</parameter>
</parameters>
-<return> the GType for the current operation
+<return> the `GType` for the current operation
</return>
</function>
@@ -4502,7 +5001,7 @@ Gets the mime type to serialize to.
</description>
<parameters>
<parameter name="serializer">
-<parameter_description> a #GdkContentSerializer
+<parameter_description> a `GdkContentSerializer`
</parameter_description>
</parameter>
</parameters>
@@ -4512,13 +5011,15 @@ Gets the mime type to serialize to.
<function name="gdk_content_serializer_get_output_stream">
<description>
-Gets the output stream that was passed to gdk_content_serialize_async().
+Gets the output stream for the current operation.
+
+This is the stream that was passed to [func@content_serialize_async].
</description>
<parameters>
<parameter name="serializer">
-<parameter_description> a #GdkContentSerializer
+<parameter_description> a `GdkContentSerializer`
</parameter_description>
</parameter>
</parameters>
@@ -4528,29 +5029,33 @@ Gets the output stream that was passed to gdk_content_serialize_async().
<function name="gdk_content_serializer_get_priority">
<description>
-Gets the io priority that was passed to gdk_content_serialize_async().
+Gets the I/O priority for the current operation.
+
+This is the priority that was passed to [func@content_serialize_async].
</description>
<parameters>
<parameter name="serializer">
-<parameter_description> a #GdkContentSerializer
+<parameter_description> a `GdkContentSerializer`
</parameter_description>
</parameter>
</parameters>
-<return> the io priority for the current operation
+<return> the I/O priority for the current operation
</return>
</function>
<function name="gdk_content_serializer_get_task_data">
<description>
-Gets the data that was associated with @serializer via gdk_content_serializer_set_task_data().
+Gets the data that was associated with the current operation.
+
+See [method@Gdk.ContentSerializer.set_task_data].
</description>
<parameters>
<parameter name="serializer">
-<parameter_description> a #GdkContentSerializer
+<parameter_description> a `GdkContentSerializer`
</parameter_description>
</parameter>
</parameters>
@@ -4566,7 +5071,7 @@ Gets the user data that was passed when the serializer was registered.
</description>
<parameters>
<parameter name="serializer">
-<parameter_description> a #GdkContentSerializer
+<parameter_description> a `GdkContentSerializer`
</parameter_description>
</parameter>
</parameters>
@@ -4576,33 +5081,34 @@ Gets the user data that was passed when the serializer was registered.
<function name="gdk_content_serializer_get_value">
<description>
-Gets the #GValue to read the object to serialize from.
+Gets the `GValue` to read the object to serialize from.
</description>
<parameters>
<parameter name="serializer">
-<parameter_description> a #GdkContentSerializer
+<parameter_description> a `GdkContentSerializer`
</parameter_description>
</parameter>
</parameters>
-<return> the #GValue for the current operation
+<return> the `GValue` for the current operation
</return>
</function>
<function name="gdk_content_serializer_return_error">
<description>
Indicate that the serialization has ended with an error.
+
This function consumes @error.
</description>
<parameters>
<parameter name="serializer">
-<parameter_description> a #GdkContentSerializer
+<parameter_description> a `GdkContentSerializer`
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError
+<parameter_description> a `GError`
</parameter_description>
</parameter>
</parameters>
@@ -4616,7 +5122,7 @@ Indicate that the serialization has been successfully completed.
</description>
<parameters>
<parameter name="serializer">
-<parameter_description> a #GdkContentSerializer
+<parameter_description> a `GdkContentSerializer`
</parameter_description>
</parameter>
</parameters>
@@ -4630,7 +5136,7 @@ Associate data with the current serialization operation.
</description>
<parameters>
<parameter name="serializer">
-<parameter_description> a #GdkContentSerializer
+<parameter_description> a `GdkContentSerializer`
</parameter_description>
</parameter>
<parameter name="data">
@@ -4695,41 +5201,42 @@ Extracts the crossing mode from a crossing event.
<function name="gdk_cursor_get_fallback">
<description>
-Returns the fallback for this @cursor. The fallback will be used if this
-cursor is not available on a given #GdkDisplay.
+Returns the fallback for this @cursor.
-For named cursors, this can happen when using nonstandard names or when
-using an incomplete cursor theme.
-For textured cursors, this can happen when the texture is too large or
-when the #GdkDisplay it is used on does not support textured cursors.
+The fallback will be used if this cursor is not available on a given
+`GdkDisplay`. For named cursors, this can happen when using nonstandard
+names or when using an incomplete cursor theme. For textured cursors,
+this can happen when the texture is too large or when the `GdkDisplay`
+it is used on does not support textured cursors.
</description>
<parameters>
<parameter name="cursor">
-<parameter_description> a #GdkCursor.
+<parameter_description> a `GdkCursor`
</parameter_description>
</parameter>
</parameters>
-<return> the fallback of the cursor or %NULL to use
-the default cursor as fallback.
+<return> the fallback of the cursor or %NULL
+to use the default cursor as fallback.
</return>
</function>
<function name="gdk_cursor_get_hotspot_x">
<description>
-Returns the horizontal offset of the hotspot. The hotspot indicates the
-pixel that will be directly above the cursor.
+Returns the horizontal offset of the hotspot.
+
+The hotspot indicates the pixel that will be directly above the cursor.
Note that named cursors may have a nonzero hotspot, but this function
will only return the hotspot position for cursors created with
-gdk_cursor_new_from_texture().
+[ctor@Gdk.Cursor.new_from_texture].
</description>
<parameters>
<parameter name="cursor">
-<parameter_description> a #GdkCursor.
+<parameter_description> a `GdkCursor`
</parameter_description>
</parameter>
</parameters>
@@ -4739,18 +5246,19 @@ gdk_cursor_new_from_texture().
<function name="gdk_cursor_get_hotspot_y">
<description>
-Returns the vertical offset of the hotspot. The hotspot indicates the
-pixel that will be directly above the cursor.
+Returns the vertical offset of the hotspot.
+
+The hotspot indicates the pixel that will be directly above the cursor.
Note that named cursors may have a nonzero hotspot, but this function
will only return the hotspot position for cursors created with
-gdk_cursor_new_from_texture().
+[ctor@Gdk.Cursor.new_from_texture].
</description>
<parameters>
<parameter name="cursor">
-<parameter_description> a #GdkCursor.
+<parameter_description> a `GdkCursor`
</parameter_description>
</parameter>
</parameters>
@@ -4760,26 +5268,28 @@ gdk_cursor_new_from_texture().
<function name="gdk_cursor_get_name">
<description>
-Returns the name of the cursor. If the cursor is not a named cursor, %NULL
-will be returned.
+Returns the name of the cursor.
+
+If the cursor is not a named cursor, %NULL will be returned.
</description>
<parameters>
<parameter name="cursor">
-<parameter_description> a #GdkCursor.
+<parameter_description> a `GdkCursor`
</parameter_description>
</parameter>
</parameters>
-<return> the name of the cursor or %NULL if it is not
-a named cursor
+<return> the name of the cursor or %NULL
+if it is not a named cursor
</return>
</function>
<function name="gdk_cursor_get_texture">
<description>
-Returns the texture for the cursor. If the cursor is a named cursor, %NULL
-will be returned.
+Returns the texture for the cursor.
+
+If the cursor is a named cursor, %NULL will be returned.
</description>
@@ -4789,8 +5299,8 @@ will be returned.
</parameter_description>
</parameter>
</parameters>
-<return> the texture for cursor or %NULL if it is a
-named cursor
+<return> the texture for cursor or %NULL
+if it is a named cursor
</return>
</function>
@@ -4801,42 +5311,18 @@ theme.
A recommended set of cursor names that will work across different
platforms can be found in the CSS specification:
-- "none"
--  "default"
--  "help"
--  "pointer"
--  "context-menu"
--  "progress"
--  "wait"
--  "cell"
--  "crosshair"
--  "text"
--  "vertical-text"
--  "alias"
--  "copy"
--  "no-drop"
--  "move"
--  "not-allowed"
--  "grab"
--  "grabbing"
--  "all-scroll"
--  "col-resize"
--  "row-resize"
--  "n-resize"
--  "e-resize"
--  "s-resize"
--  "w-resize"
--  "ne-resize"
--  "nw-resize"
--  "sw-resize"
--  "se-resize"
--  "ew-resize"
--  "ns-resize"
--  "nesw-resize"
--  "nwse-resize"
--  "zoom-in"
--  "zoom-out"
+| | | | |
+| --- | --- | ---- | --- |
+| "none" |  "default" |  "help" |
 "pointer" |
+|  "context-menu" |  "progress" |
 "wait" |  "cell" |
+|  "crosshair" |  "text" |
 "vertical-text" |  "alias" |
+|  "copy" |  "no-drop" | 
"move" |  "not-allowed" |
+|  "grab" |  "grabbing" |
 "all-scroll" |  "col-resize" |
+|  "row-resize" |  "n-resize" |
 "e-resize" |  "s-resize" |
+|  "w-resize" |  "ne-resize" |
 "nw-resize" |  "sw-resize" |
+|  "se-resize" |  "ew-resize" |
 "ns-resize" |  "nesw-resize" |
+|  "nwse-resize" |  "zoom-in" |
 "zoom-out" | |
</description>
@@ -4846,19 +5332,19 @@ platforms can be found in the CSS specification:
</parameter_description>
</parameter>
<parameter name="fallback">
-<parameter_description> %NULL or the #GdkCursor to fall back to when
+<parameter_description> %NULL or the `GdkCursor` to fall back to when
this one cannot be supported
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkCursor, or %NULL if there is no
+<return> a new `GdkCursor`, or %NULL if there is no
cursor with the given name
</return>
</function>
<function name="gdk_cursor_new_from_texture">
<description>
-Creates a new cursor from a #GdkTexture.
+Creates a new cursor from a `GdkTexture`.
</description>
@@ -4876,12 +5362,12 @@ Creates a new cursor from a #GdkTexture.
</parameter_description>
</parameter>
<parameter name="fallback">
-<parameter_description> %NULL or the #GdkCursor to fall back to when
+<parameter_description> %NULL or the `GdkCursor` to fall back to when
this one cannot be supported
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkCursor.
+<return> a new `GdkCursor`
</return>
</function>
@@ -4893,28 +5379,29 @@ Returns the axis use for @index_.
</description>
<parameters>
<parameter name="device">
-<parameter_description> a pointer #GdkDevice.
+<parameter_description> a pointer `GdkDevice`
</parameter_description>
</parameter>
<parameter name="index_">
-<parameter_description> the index of the axis.
+<parameter_description> the index of the axi.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkAxisUse specifying how the axis is used.
+<return> a `GdkAxisUse` specifying how the axis is used.
</return>
</function>
<function name="gdk_device_get_caps_lock_state">
<description>
-Retrieves whether the Caps Lock modifier of the
-keyboard is locked, if @device is a keyboard device.
+Retrieves whether the Caps Lock modifier of the keyboard is locked.
+
+This is only relevant for keyboard devices.
</description>
<parameters>
<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter_description> a `GdkDevice`
</parameter_description>
</parameter>
</parameters>
@@ -4924,33 +5411,34 @@ keyboard is locked, if @device is a keyboard device.
<function name="gdk_device_get_device_tool">
<description>
-Retrieves the #GdkDeviceTool associated to @device.
+Retrieves the current tool for @device.
</description>
<parameters>
<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter_description> a `GdkDevice`
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkDeviceTool
+<return> the `GdkDeviceTool`, or %NULL
</return>
</function>
<function name="gdk_device_get_direction">
<description>
-Returns the direction of effective layout of the keyboard,
-if @device is a keyboard device.
+Returns the direction of effective layout of the keyboard.
+
+This is only relevant for keyboard devices.
The direction of a layout is the direction of the majority
-of its symbols. See pango_unichar_direction().
+of its symbols. See [func@Pango.unichar_direction].
</description>
<parameters>
<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter_description> a `GdkDevice`
</parameter_description>
</parameter>
</parameters>
@@ -4962,24 +5450,24 @@ otherwise
<function name="gdk_device_get_display">
<description>
-Returns the #GdkDisplay to which @device pertains.
+Returns the `GdkDisplay` to which @device pertains.
</description>
<parameters>
<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter_description> a `GdkDevice`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDisplay. This memory is owned
-by GTK, and must not be freed or unreffed.
+<return> a `GdkDisplay`
</return>
</function>
<function name="gdk_device_get_has_cursor">
<description>
Determines whether the pointer follows device motion.
+
This is not meaningful for keyboard devices, which
don't have a pointer.
@@ -4987,7 +5475,7 @@ don't have a pointer.
</description>
<parameters>
<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter_description> a `GdkDevice`
</parameter_description>
</parameter>
</parameters>
@@ -4997,14 +5485,15 @@ don't have a pointer.
<function name="gdk_device_get_modifier_state">
<description>
-Retrieves the current modifier state of the keyboard,
-if @device is a keyboard device.
+Retrieves the current modifier state of the keyboard.
+
+This is only relevant for keyboard devices.
</description>
<parameters>
<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter_description> a `GdkDevice`
</parameter_description>
</parameter>
</parameters>
@@ -5014,14 +5503,13 @@ if @device is a keyboard device.
<function name="gdk_device_get_name">
<description>
-Determines the name of the device, suitable
-for showing in a user interface.
+The name of the device, suitable for showing in a user interface.
</description>
<parameters>
<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter_description> a GdkDevice`
</parameter_description>
</parameter>
</parameters>
@@ -5031,14 +5519,15 @@ for showing in a user interface.
<function name="gdk_device_get_num_lock_state">
<description>
-Retrieves whether the Num Lock modifier of the
-keyboard is locked, if @device is a keyboard device.
+Retrieves whether the Num Lock modifier of the keyboard is locked.
+
+This is only relevant for keyboard devices.
</description>
<parameters>
<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter_description> a ``GdkDevice`
</parameter_description>
</parameter>
</parameters>
@@ -5054,7 +5543,7 @@ Retrieves the number of touch points associated to @device.
</description>
<parameters>
<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter_description> a `GdkDevice`
</parameter_description>
</parameter>
</parameters>
@@ -5064,15 +5553,16 @@ Retrieves the number of touch points associated to @device.
<function name="gdk_device_get_product_id">
<description>
-Returns the product ID of this device, or %NULL if this information couldn't
-be obtained. This ID is retrieved from the device, and is thus constant for
-it. See gdk_device_get_vendor_id() for more information.
+Returns the product ID of this device.
+
+This ID is retrieved from the device, and does not change.
+See [method@Gdk.Device.get_vendor_id] for more information.
</description>
<parameters>
<parameter name="device">
-<parameter_description> a physical #GdkDevice
+<parameter_description> a physical `GdkDevice`
</parameter_description>
</parameter>
</parameters>
@@ -5082,14 +5572,15 @@ it. See gdk_device_get_vendor_id() for more information.
<function name="gdk_device_get_scroll_lock_state">
<description>
-Retrieves whether the Scroll Lock modifier of the
-keyboard is locked, if @device is a keyboard device.
+Retrieves whether the Scroll Lock modifier of the keyboard is locked.
+
+This is only relevant for keyboard devices.
</description>
<parameters>
<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter_description> a `GdkDevice`
</parameter_description>
</parameter>
</parameters>
@@ -5099,7 +5590,7 @@ keyboard is locked, if @device is a keyboard device.
<function name="gdk_device_get_seat">
<description>
-Returns the #GdkSeat the device belongs to.
+Returns the `GdkSeat` the device belongs to.
</description>
@@ -5109,7 +5600,7 @@ Returns the #GdkSeat the device belongs to.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkSeat
+<return> a `GdkSeat`
</return>
</function>
@@ -5121,25 +5612,24 @@ Determines the type of the device.
</description>
<parameters>
<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter_description> a `GdkDevice`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkInputSource
+<return> a `GdkInputSource`
</return>
</function>
<function name="gdk_device_get_surface_at_position">
<description>
-Obtains the surface underneath @device, returning the location of the device in @win_x and @win_y in
-double precision. Returns %NULL if the surface tree under @device is not known to GDK (for example,
-belongs to another application).
+Obtains the surface underneath @device, returning the location of the
+device in @win_x and @win_y
</description>
<parameters>
<parameter name="device">
-<parameter_description> pointer #GdkDevice to query info to.
+<parameter_description> pointer `GdkDevice` to query info to
</parameter_description>
</parameter>
<parameter name="win_x">
@@ -5153,21 +5643,45 @@ relative to the surface origin, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkSurface under the
-device position, or %NULL.
+<return> the `GdkSurface` under the
+device position, or %NULL
+</return>
+</function>
+
+<function name="gdk_device_get_timestamp">
+<description>
+Returns the timestamp of the last activity for this device.
+
+In practice, this means the timestamp of the last event that was
+received from the OS for this device. (GTK may occasionally produce
+events for a device that are not received from the OS, and will not
+update the timestamp).
+
+Since: 4.2
+
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a `GdkDevice`
+</parameter_description>
+</parameter>
+</parameters>
+<return> the timestamp of the last activity for this device
+
</return>
</function>
<function name="gdk_device_get_vendor_id">
<description>
-Returns the vendor ID of this device, or %NULL if this information couldn't
-be obtained. This ID is retrieved from the device, and is thus constant for
-it.
+Returns the vendor ID of this device.
-This function, together with gdk_device_get_product_id(), can be used to eg.
-compose #GSettings paths to store settings for this device.
+This ID is retrieved from the device, and does not change.
-|[<!-- language="C" -->
+This function, together with [method@Gdk.Device.get_product_id],
+can be used to eg. compose `GSettings` paths to store settings
+for this device.
+
+```c
static GSettings *
get_device_settings (GdkDevice *device)
{
@@ -5185,13 +5699,13 @@ g_free (path);
return settings;
}
-]|
+```
</description>
<parameters>
<parameter name="device">
-<parameter_description> a physical #GdkDevice
+<parameter_description> a physical `GdkDevice`
</parameter_description>
</parameter>
</parameters>
@@ -5201,15 +5715,16 @@ return settings;
<function name="gdk_device_has_bidi_layouts">
<description>
-Determines if keyboard layouts for both right-to-left and
-left-to-right languages are in use on the keyboard, if
-@device is a keyboard device.
+Determines if layouts for both right-to-left and
+left-to-right languages are in use on the keyboard.
+
+This is only relevant for keyboard devices.
</description>
<parameters>
<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter_description> a `GdkDevice`
</parameter_description>
</parameter>
</parameters>
@@ -5220,14 +5735,15 @@ left-to-right languages are in use on the keyboard, if
<function name="gdk_device_pad_get_feature_group">
<description>
-Returns the group the given @feature and @idx belong to,
-or -1 if feature/index do not exist in @pad.
+Returns the group the given @feature and @idx belong to.
+
+f the feature or index do not exist in @pad, -1 is returned.
</description>
<parameters>
<parameter name="pad">
-<parameter_description> a #GdkDevicePad
+<parameter_description> a `GdkDevicePad`
</parameter_description>
</parameter>
<parameter name="feature">
@@ -5251,7 +5767,7 @@ Returns the number of modes that @group may have.
</description>
<parameters>
<parameter name="pad">
-<parameter_description> a #GdkDevicePad
+<parameter_description> a `GdkDevicePad`
</parameter_description>
</parameter>
<parameter name="group_idx">
@@ -5271,7 +5787,7 @@ Returns the number of features a tablet pad has.
</description>
<parameters>
<parameter name="pad">
-<parameter_description> a #GdkDevicePad
+<parameter_description> a `GdkDevicePad`
</parameter_description>
</parameter>
<parameter name="feature">
@@ -5285,8 +5801,9 @@ Returns the number of features a tablet pad has.
<function name="gdk_device_pad_get_n_groups">
<description>
-Returns the number of groups this pad device has. Pads have
-at least one group. A pad group is a subcollection of
+Returns the number of groups this pad device has.
+
+Pads have at least one group. A pad group is a subcollection of
buttons/strip/rings that is affected collectively by a same
current mode.
@@ -5294,7 +5811,7 @@ current mode.
</description>
<parameters>
<parameter name="pad">
-<parameter_description> a #GdkDevicePad
+<parameter_description> a `GdkDevicePad`
</parameter_description>
</parameter>
</parameters>
@@ -5310,7 +5827,7 @@ Gets the axes of the tool.
</description>
<parameters>
<parameter name="tool">
-<parameter_description> a #GdkDeviceTool
+<parameter_description> a `GdkDeviceTool`
</parameter_description>
</parameter>
</parameters>
@@ -5320,21 +5837,23 @@ Gets the axes of the tool.
<function name="gdk_device_tool_get_hardware_id">
<description>
-Gets the hardware ID of this tool, or 0 if it's not known. When
-non-zero, the identificator is unique for the given tool model,
+Gets the hardware ID of this tool, or 0 if it's not known.
+
+When non-zero, the identificator is unique for the given tool model,
meaning that two identical tools will share the same @hardware_id,
-but will have different serial numbers (see gdk_device_tool_get_serial()).
+but will have different serial numbers (see
+[method@Gdk.DeviceTool.get_serial]).
This is a more concrete (and device specific) method to identify
-a #GdkDeviceTool than gdk_device_tool_get_tool_type(), as a tablet
-may support multiple devices with the same #GdkDeviceToolType,
-but having different hardware identificators.
+a `GdkDeviceTool` than [method@Gdk.DeviceTool.get_tool_type],
+as a tablet may support multiple devices with the same
+`GdkDeviceToolType`, but different hardware identificators.
</description>
<parameters>
<parameter name="tool">
-<parameter_description> a #GdkDeviceTool
+<parameter_description> a `GdkDeviceTool`
</parameter_description>
</parameter>
</parameters>
@@ -5344,14 +5863,16 @@ but having different hardware identificators.
<function name="gdk_device_tool_get_serial">
<description>
-Gets the serial of this tool, this value can be used to identify a
-physical tool (eg. a tablet pen) across program executions.
+Gets the serial number of this tool.
+
+This value can be used to identify a physical tool
+(eg. a tablet pen) across program executions.
</description>
<parameters>
<parameter name="tool">
-<parameter_description> a #GdkDeviceTool
+<parameter_description> a `GdkDeviceTool`
</parameter_description>
</parameter>
</parameters>
@@ -5361,18 +5882,19 @@ physical tool (eg. a tablet pen) across program executions.
<function name="gdk_device_tool_get_tool_type">
<description>
-Gets the #GdkDeviceToolType of the tool.
+Gets the `GdkDeviceToolType` of the tool.
</description>
<parameters>
<parameter name="tool">
-<parameter_description> a #GdkDeviceTool
+<parameter_description> a `GdkDeviceTool`
</parameter_description>
</parameter>
</parameters>
-<return> The physical type for this tool. This can be used to figure out what
-sort of pen is being used, such as an airbrush or a pencil.
+<return> The physical type for this tool. This can be used to
+figure out what sort of pen is being used, such as an airbrush
+or a pencil.
</return>
</function>
@@ -5383,7 +5905,7 @@ Emits a short beep on @display
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -5392,13 +5914,14 @@ Emits a short beep on @display
<function name="gdk_display_close">
<description>
-Closes the connection to the windowing system for the given display,
-and cleans up associated resources.
+Closes the connection to the windowing system for the given display.
+
+This cleans up associated resources.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -5413,11 +5936,11 @@ Returns %TRUE if there is an ongoing grab on @device for @display.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter_description> a `GdkDevice`
</parameter_description>
</parameter>
</parameters>
@@ -5427,10 +5950,11 @@ Returns %TRUE if there is an ongoing grab on @device for @display.
<function name="gdk_display_flush">
<description>
-Flushes any requests queued for the windowing system; this happens automatically
-when the main loop blocks waiting for new events, but if your application
-is drawing without returning control to the main loop, you may need
-to call this function explicitly. A common case where this function
+Flushes any requests queued for the windowing system.
+
+This happens automatically when the main loop blocks waiting for new events,
+but if your application is drawing without returning control to the main loop,
+you may need to call this function explicitly. A common case where this function
needs to be called is when an application is executing drawing commands
from a thread other than the thread where the main loop is running.
@@ -5440,7 +5964,7 @@ handled synchronously, this function will do nothing.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -5449,18 +5973,18 @@ handled synchronously, this function will do nothing.
<function name="gdk_display_get_app_launch_context">
<description>
-Returns a #GdkAppLaunchContext suitable for launching
+Returns a `GdkAppLaunchContext` suitable for launching
applications on the given display.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkAppLaunchContext for @display.
+<return> a new `GdkAppLaunchContext` for @display.
Free with g_object_unref() when done
</return>
</function>
@@ -5473,7 +5997,7 @@ Gets the clipboard used for copy/paste operations.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -5483,22 +6007,23 @@ Gets the clipboard used for copy/paste operations.
<function name="gdk_display_get_default">
<description>
-Gets the default #GdkDisplay. This is a convenience
-function for:
+Gets the default `GdkDisplay`.
+
+This is a convenience function for:
`gdk_display_manager_get_default_display (gdk_display_manager_get ())`.
</description>
<parameters>
</parameters>
-<return> a #GdkDisplay, or %NULL if
-there is no default display.
+<return> a `GdkDisplay`, or %NULL if
+there is no default display
</return>
</function>
<function name="gdk_display_get_default_seat">
<description>
-Returns the default #GdkSeat for this display.
+Returns the default `GdkSeat` for this display.
Note that a display may not have a seat. In this case,
this function will return %NULL.
@@ -5507,7 +6032,7 @@ this function will return %NULL.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -5523,7 +6048,7 @@ Returns the #GdkKeymap attached to @display.
</description>
<parameters>
<parameter name="display">
-<parameter_description> the #GdkDisplay
+<parameter_description> the `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -5534,22 +6059,22 @@ Returns the #GdkKeymap attached to @display.
<function name="gdk_display_get_monitor_at_surface">
<description>
Gets the monitor in which the largest area of @surface
-resides, or a monitor close to @surface if it is outside
-of all monitors.
+resides.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
</parameters>
-<return> the monitor with the largest overlap with @surface
+<return> the monitor with the largest
+overlap with @surface
</return>
</function>
@@ -5557,21 +6082,21 @@ of all monitors.
<description>
Gets the list of monitors associated with this display.
-Subsequent calls to this function will always return the same list for the
-same display.
+Subsequent calls to this function will always return the
+same list for the same display.
-You can listen to the GListModel::items-changed signal on this list
-to monitor changes to the monitor of this display.
+You can listen to the GListModel::items-changed signal on
+this list to monitor changes to the monitor of this display.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
-<return> a #GListModel of #GdkMonitor
+<return> a #GListModel of `GdkMonitor`
</return>
</function>
@@ -5583,7 +6108,7 @@ Gets the name of the display.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -5594,15 +6119,16 @@ by GDK and should not be modified or freed.
<function name="gdk_display_get_primary_clipboard">
<description>
-Gets the clipboard used for the primary selection. On backends where the
-primary clipboard is not supported natively, GDK emulates this clipboard
-locally.
+Gets the clipboard used for the primary selection.
+
+On backends where the primary clipboard is not supported natively,
+GDK emulates this clipboard locally.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -5619,7 +6145,7 @@ for the @display.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
<parameter name="name">
@@ -5645,7 +6171,7 @@ if no ID has been defined.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -5661,7 +6187,7 @@ Finds out if the display has been closed.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -5672,9 +6198,10 @@ Finds out if the display has been closed.
<function name="gdk_display_is_composited">
<description>
Returns whether surfaces can reasonably be expected to have
-their alpha channel drawn correctly on the screen. Check
-gdk_display_is_rgba() for whether the display supports an
-alpha channel.
+their alpha channel drawn correctly on the screen.
+
+Check [method@Gdk.Display.is_rgba] for whether the display
+supports an alpha channel.
On X11 this function returns whether a compositing manager is
compositing on @display.
@@ -5685,12 +6212,13 @@ On modern displays, this value is always %TRUE.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
-<return> Whether surfaces with RGBA visuals can reasonably be
-expected to have their alpha channels drawn correctly on the screen.
+<return> Whether surfaces with RGBA visuals can reasonably
+be expected to have their alpha channels drawn correctly
+on the screen.
</return>
</function>
@@ -5703,7 +6231,7 @@ Even if a %TRUE is returned, it is possible that the
surface’s alpha channel won’t be honored when displaying the
surface on the screen: in particular, for X an appropriate
windowing manager and compositing manager must be running to
-provide appropriate display. Use gdk_display_is_composited()
+provide appropriate display. Use [method@Gdk.Display.is_composited]
to check if that is the case.
On modern displays, this value is always %TRUE.
@@ -5712,7 +6240,7 @@ On modern displays, this value is always %TRUE.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -5729,46 +6257,48 @@ Returns the list of seats known to @display.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
<return> the
-list of seats known to the #GdkDisplay
+list of seats known to the `GdkDisplay`
</return>
</function>
<function name="gdk_display_manager_get">
<description>
-Gets the singleton #GdkDisplayManager object.
+Gets the singleton `GdkDisplayManager` object.
When called for the first time, this function consults the
-`GDK_BACKEND` environment variable to find out which
-of the supported GDK backends to use (in case GDK has been compiled
-with multiple backends). Applications can use gdk_set_allowed_backends()
-to limit what backends can be used.
+`GDK_BACKEND` environment variable to find out which of the
+supported GDK backends to use (in case GDK has been compiled
+with multiple backends).
+
+Applications can use [func@set_allowed_backends] to limit what
+backends wil be used.
</description>
<parameters>
</parameters>
-<return> The global #GdkDisplayManager singleton
+<return> The global `GdkDisplayManager` singleton
</return>
</function>
<function name="gdk_display_manager_get_default_display">
<description>
-Gets the default #GdkDisplay.
+Gets the default `GdkDisplay`.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GdkDisplayManager
+<parameter_description> a `GdkDisplayManager`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDisplay, or %NULL if
+<return> a `GdkDisplay`, or %NULL if
there is no default display.
</return>
</function>
@@ -5781,12 +6311,12 @@ List all currently open displays.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GdkDisplayManager
+<parameter_description> a `GdkDisplayManager`
</parameter_description>
</parameter>
</parameters>
<return> a newly
-allocated #GSList of #GdkDisplay objects. Free with g_slist_free()
+allocated `GSList` of `GdkDisplay` objects. Free with g_slist_free()
when you are done with it.
</return>
</function>
@@ -5799,7 +6329,7 @@ Opens a display.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GdkDisplayManager
+<parameter_description> a `GdkDisplayManager`
</parameter_description>
</parameter>
<parameter name="name">
@@ -5807,8 +6337,8 @@ Opens a display.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDisplay, or %NULL if the
-display could not be opened
+<return> a `GdkDisplay`, or %NULL
+if the display could not be opened
</return>
</function>
@@ -5819,11 +6349,11 @@ Sets @display as the default display.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GdkDisplayManager
+<parameter_description> a `GdkDisplayManager`
</parameter_description>
</parameter>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -5832,8 +6362,9 @@ Sets @display as the default display.
<function name="gdk_display_map_keycode">
<description>
-Returns the keyvals bound to @keycode. The Nth #GdkKeymapKey
-in @keys is bound to the Nth keyval in @keyvals.
+Returns the keyvals bound to @keycode.
+
+The Nth `GdkKeymapKey` in @keys is bound to the Nth keyval in @keyvals.
When a keycode is pressed by the user, the keyval from
this list of entries is selected by considering the effective
@@ -5845,7 +6376,7 @@ Free the returned arrays with g_free().
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
<parameter name="keycode">
@@ -5854,7 +6385,7 @@ Free the returned arrays with g_free().
</parameter>
<parameter name="keys">
<parameter_description> return
-location for array of #GdkKeymapKey, or %NULL
+location for array of `GdkKeymapKey`, or %NULL
</parameter_description>
</parameter>
<parameter name="keyvals">
@@ -5874,16 +6405,17 @@ location for array of keyvals, or %NULL
<function name="gdk_display_map_keyval">
<description>
Obtains a list of keycode/group/level combinations that will
-generate @keyval. Groups and levels are two kinds of keyboard mode;
-in general, the level determines whether the top or bottom symbol
-on a key is used, and the group determines whether the left or
-right symbol is used.
+generate @keyval.
+
+Groups and levels are two kinds of keyboard mode; in general, the level
+determines whether the top or bottom symbol on a key is used, and the
+group determines whether the left or right symbol is used.
On US keyboards, the shift key changes the keyboard level, and there
are no groups. A group switch key might convert a keyboard between
Hebrew to English modes, for example.
-#GdkEventKey contains a %group field that indicates the active
+`GdkEventKey` contains a %group field that indicates the active
keyboard group. The level is computed from the modifier mask.
The returned array should be freed with g_free().
@@ -5892,7 +6424,7 @@ The returned array should be freed with g_free().
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
<parameter name="keyval">
@@ -5901,7 +6433,7 @@ The returned array should be freed with g_free().
</parameter>
<parameter name="keys">
<parameter_description> return location
-for an array of #GdkKeymapKey
+for an array of `GdkKeymapKey`
</parameter_description>
</parameter>
<parameter name="n_keys">
@@ -5918,15 +6450,15 @@ for an array of #GdkKeymapKey
Indicates to the GUI environment that the application has
finished loading, using a given identifier.
-GTK will call this function automatically for #GtkWindow
+GTK will call this function automatically for [class@Gtk.Window]
with custom startup-notification identifier unless
-gtk_window_set_auto_startup_notification() is called to
-disable that feature.
+[method@Gtk.Window.set_auto_startup_notification]
+is called to disable that feature.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
<parameter name="startup_id">
@@ -5950,7 +6482,7 @@ Opens a display.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDisplay, or %NULL if the
+<return> a `GdkDisplay`, or %NULL if the
display could not be opened
</return>
</function>
@@ -5966,11 +6498,11 @@ and should not be used by applications.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter_description> a `GdkEvent`
</parameter_description>
</parameter>
</parameters>
@@ -5979,7 +6511,9 @@ and should not be used by applications.
<function name="gdk_display_supports_input_shapes">
<description>
-Returns %TRUE if gdk_surface_set_input_region() can
+Returns %TRUE if the display supports input shapes.
+
+This means that [method@Gdk.Surface.set_input_region] can
be used to modify the input shape of surfaces on @display.
On modern displays, this value is always %TRUE.
@@ -5988,7 +6522,7 @@ On modern displays, this value is always %TRUE.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -5999,11 +6533,12 @@ On modern displays, this value is always %TRUE.
<function name="gdk_display_sync">
<description>
Flushes any requests queued for the windowing system and waits until all
-requests have been handled. This is often used for making sure that the
-display is synchronized with the current state of the program. Calling
-gdk_display_sync() before gdk_x11_display_error_trap_pop() makes sure
-that any errors generated from earlier requests are handled before the
-error trap is removed.
+requests have been handled.
+
+This is often used for making sure that the display is synchronized
+with the current state of the program. Calling [method Gdk Display sync]
+before [method@GdkX11.Display.error_trap_pop] makes sure that any errors
+generated from earlier requests are handled before the error trap is removed.
This is most useful for X11. On windowing systems where requests are
handled synchronously, this function will do nothing.
@@ -6011,7 +6546,7 @@ handled synchronously, this function will do nothing.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -6020,29 +6555,31 @@ handled synchronously, this function will do nothing.
<function name="gdk_display_translate_key">
<description>
-Translates the contents of a #GdkEventKey (ie @keycode, @state, and @group)
-into a keyval, effective group, and level. Modifiers that affected the
-translation and are thus unavailable for application use are returned in
-@consumed_modifiers.
+Translates the contents of a `GdkEventKey` into a keyval, effective group,
+and level.
-The @effective_group is the group that was actually used for the translation;
-some keys such as Enter are not affected by the active keyboard group.
-The @level is derived from @state.
+Modifiers that affected the translation and are thus unavailable for
+application use are returned in @consumed_modifiers.
-@consumed_modifiers gives modifiers that should be masked outfrom @state
-when comparing this key press to a keyboard shortcut. For instance, on a US
-keyboard, the `plus` symbol is shifted, so when comparing a key press to a
-`<Control>plus` accelerator `<Shift>` should be masked out.
+The @effective_group is the group that was actually used for the
+translation; some keys such as Enter are not affected by the active
+keyboard group. The @level is derived from @state.
+
+@consumed_modifiers gives modifiers that should be masked out
+from @state when comparing this key press to a keyboard shortcut.
+For instance, on a US keyboard, the `plus` symbol is shifted, so
+when comparing a key press to a `<Control>plus` accelerator `<Shift>`
+should be masked out.
-This function should rarely be needed, since #GdkEventKey already contains
-the translated keyval. It is exported for the benefit of virtualized test
-environments.
+This function should rarely be needed, since `GdkEventKey` already
+contains the translated keyval. It is exported for the benefit of
+virtualized test environments.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
<parameter name="keycode">
@@ -6082,7 +6619,7 @@ that were used to determine the group or level, or %NULL
<function name="gdk_dnd_event_get_drop">
<description>
-Gets the #GdkDrop from a DND event.
+Gets the `GdkDrop` object from a DND event.
</description>
@@ -6098,8 +6635,8 @@ Gets the #GdkDrop from a DND event.
<function name="gdk_drag_action_is_unique">
<description>
-Checks if @action represents a single action or if it
-includes multiple flags that can be selected from.
+Checks if @action represents a single action or includes
+multiple actions.
When @action is 0 - ie no action was given, %TRUE
is returned.
@@ -6108,7 +6645,7 @@ is returned.
</description>
<parameters>
<parameter name="action">
-<parameter_description> a #GdkDragAction
+<parameter_description> a `GdkDragAction`
</parameter_description>
</parameter>
</parameters>
@@ -6122,15 +6659,16 @@ Starts a drag and creates a new drag context for it.
This function is called by the drag source. After this call, you
probably want to set up the drag icon using the surface returned
-by gdk_drag_get_drag_surface().
+by [method Gdk Drag.get_drag_surface].
-This function returns a reference to the GdkDrag object, but GTK
-keeps its own reference as well, as long as the DND operation is
-going on.
+This function returns a reference to the [class Gdk Drag] object,
+but GTK keeps its own reference as well, as long as the DND operation
+is going on.
Note: if @actions include %GDK_ACTION_MOVE, you need to listen for
-the #GdkDrag::dnd-finished signal and delete the data at the source
-if gdk_drag_get_selected_action() returns %GDK_ACTION_MOVE.
+the [signal Gdk Drag::dnd-finished] signal and delete the data at
+the source if [method Gdk Drag.get_selected_action] returns
+%GDK_ACTION_MOVE.
</description>
@@ -6160,28 +6698,29 @@ if gdk_drag_get_selected_action() returns %GDK_ACTION_MOVE.
</parameter_description>
</parameter>
</parameters>
-<return> a newly created #GdkDrag or
-%NULL on error.
+<return> a newly created [class Gdk Drag]
+or %NULL on error
</return>
</function>
<function name="gdk_drag_drop_done">
<description>
-Inform GDK if the drop ended successfully. Passing %FALSE
-for @success may trigger a drag cancellation animation.
+Informs GDK that the drop ended.
-This function is called by the drag source, and should
-be the last call before dropping the reference to the
-@drag.
+Passing %FALSE for @success may trigger a drag cancellation
+animation.
-The #GdkDrag will only take the first gdk_drag_drop_done()
+This function is called by the drag source, and should be the
+last call before dropping the reference to the @drag.
+
+The `GdkDrag` will only take the first [method Gdk Drag.drop_done]
call as effective, if this function is called multiple times,
all subsequent calls will be ignored.
</description>
<parameters>
<parameter name="drag">
-<parameter_description> a #GdkDrag
+<parameter_description> a `GdkDrag`
</parameter_description>
</parameter>
<parameter name="success">
@@ -6200,76 +6739,77 @@ Determines the bitmask of possible actions proposed by the source.
</description>
<parameters>
<parameter name="drag">
-<parameter_description> a #GdkDrag
+<parameter_description> a `GdkDrag`
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkDragAction flags
+<return> the `GdkDragAction` flags
</return>
</function>
<function name="gdk_drag_get_content">
<description>
-Returns the #GdkContentProvider associated to the GdkDrag object.
+Returns the `GdkContentProvider` associated to the `GdkDrag` object.
</description>
<parameters>
<parameter name="drag">
-<parameter_description> a #GdkDrag
+<parameter_description> a `GdkDrag`
</parameter_description>
</parameter>
</parameters>
-<return> The #GdkContentProvider associated to @drag.
+<return> The `GdkContentProvider` associated to @drag.
</return>
</function>
<function name="gdk_drag_get_device">
<description>
-Returns the #GdkDevice associated to the GdkDrag object.
+Returns the `GdkDevice` associated to the `GdkDrag` object.
</description>
<parameters>
<parameter name="drag">
-<parameter_description> a #GdkDrag
+<parameter_description> a `GdkDrag`
</parameter_description>
</parameter>
</parameters>
-<return> The #GdkDevice associated to @drag.
+<return> The `GdkDevice` associated to @drag.
</return>
</function>
<function name="gdk_drag_get_display">
<description>
-Gets the #GdkDisplay that the drag object was created for.
+Gets the `GdkDisplay` that the drag object was created for.
</description>
<parameters>
<parameter name="drag">
-<parameter_description> a #GdkDrag
+<parameter_description> a `GdkDrag`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDisplay
+<return> a `GdkDisplay`
</return>
</function>
<function name="gdk_drag_get_drag_surface">
<description>
Returns the surface on which the drag icon should be rendered
-during the drag operation. Note that the surface may not be
-available until the drag operation has begun. GDK will move
-the surface in accordance with the ongoing drag operation.
-The surface is owned by @drag and will be destroyed when
-the drag operation is over.
+during the drag operation.
+
+Note that the surface may not be available until the drag operation
+has begun. GDK will move the surface in accordance with the ongoing
+drag operation. The surface is owned by @drag and will be destroyed
+when the drag operation is over.
</description>
<parameters>
<parameter name="drag">
-<parameter_description> a #GdkDrag
+<parameter_description> a `GdkDrag`
</parameter_description>
</parameter>
</parameters>
@@ -6279,17 +6819,17 @@ the drag operation is over.
<function name="gdk_drag_get_formats">
<description>
-Retrieves the formats supported by this GdkDrag object.
+Retrieves the formats supported by this `GdkDrag` object.
</description>
<parameters>
<parameter name="drag">
-<parameter_description> a #GdkDrag
+<parameter_description> a `GdkDrag`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkContentFormats
+<return> a `GdkContentFormats`
</return>
</function>
@@ -6301,40 +6841,41 @@ Determines the action chosen by the drag destination.
</description>
<parameters>
<parameter name="drag">
-<parameter_description> a #GdkDrag
+<parameter_description> a `GdkDrag`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDragAction value
+<return> a `GdkDragAction` value
</return>
</function>
<function name="gdk_drag_get_surface">
<description>
-Returns the #GdkSurface where the drag originates.
+Returns the `GdkSurface` where the drag originates.
</description>
<parameters>
<parameter name="drag">
-<parameter_description> a #GdkDrag
+<parameter_description> a `GdkDrag`
</parameter_description>
</parameter>
</parameters>
-<return> The #GdkSurface where the drag originates
+<return> The `GdkSurface` where the drag originates
</return>
</function>
<function name="gdk_drag_set_hotspot">
<description>
Sets the position of the drag surface that will be kept
-under the cursor hotspot. Initially, the hotspot is at the
-top left corner of the drag surface.
+under the cursor hotspot.
+
+Initially, the hotspot is at the top left corner of the drag surface.
</description>
<parameters>
<parameter name="drag">
-<parameter_description> a #GdkDrag
+<parameter_description> a `GdkDrag`
</parameter_description>
</parameter>
<parameter name="hot_x">
@@ -6357,7 +6898,7 @@ Present @drag_surface.
</description>
<parameters>
<parameter name="drag_surface">
-<parameter_description> the #GdkDragSurface to show
+<parameter_description> the `GdkDragSurface` to show
</parameter_description>
</parameter>
<parameter name="width">
@@ -6381,28 +6922,29 @@ on the @context's surface.
Calling this function begins a drawing operation using @context on the
surface that @context was created from. The actual requirements and
guarantees for the drawing operation vary for different implementations
-of drawing, so a #GdkCairoContext and a #GdkGLContext need to be treated
-differently.
+of drawing, so a [class@Gdk.CairoContext] and a [class@Gdk.GLContext]
+need to be treated differently.
-A call to this function is a requirement for drawing and must be followed
-by a call to gdk_draw_context_end_frame(), which will complete the
-drawing operation and ensure the contents become visible on screen.
+A call to this function is a requirement for drawing and must be
+followed by a call to [method@Gdk.DrawContext.end_frame], which will
+complete the drawing operation and ensure the contents become visible
+on screen.
Note that the @region passed to this function is the minimum region that
needs to be drawn and depending on implementation, windowing system and
hardware in use, it might be necessary to draw a larger region. Drawing
-implementation must use gdk_draw_context_get_frame_region() to query the
-region that must be drawn.
+implementation must use [method@Gdk.DrawContext.get_frame_region() to
+query the region that must be drawn.
-When using GTK+, the widget system automatically places calls to
+When using GTK, the widget system automatically places calls to
gdk_draw_context_begin_frame() and gdk_draw_context_end_frame() via the
-use of #GskRenderers, so application code does not need to call these
-functions explicitly.
+use of [class@Gsk.Renderer]s, so application code does not need to call
+these functions explicitly.
</description>
<parameters>
<parameter name="context">
-<parameter_description> the context used to draw the frame
+<parameter_description> the `GdkDrawContext` used to draw the frame
</parameter_description>
</parameter>
<parameter name="region">
@@ -6415,18 +6957,19 @@ functions explicitly.
<function name="gdk_draw_context_end_frame">
<description>
-Ends a drawing operation started with gdk_draw_context_begin_frame()
-and makes the drawing available on screen. See that function for more
-details about drawing.
+Ends a drawing operation started with gdk_draw_context_begin_frame().
-When using a #GdkGLContext, this function may call `glFlush()`
+This makes the drawing available on screen.
+See [method@Gdk.DrawContext.begin_frame] for more details about drawing.
+
+When using a [class@Gdk.GLContext], this function may call `glFlush()`
implicitly before returning; it is not recommended to call `glFlush()`
explicitly before calling this function.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkDrawContext
+<parameter_description> a `GdkDrawContext`
</parameter_description>
</parameter>
</parameters>
@@ -6435,30 +6978,30 @@ explicitly before calling this function.
<function name="gdk_draw_context_get_display">
<description>
-Retrieves the #GdkDisplay the @context is created for
+Retrieves the `GdkDisplay` the @context is created for
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkDrawContext
+<parameter_description> a `GdkDrawContext`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDisplay or %NULL
+<return> a `GdkDisplay` or %NULL
</return>
</function>
<function name="gdk_draw_context_get_frame_region">
<description>
-Retrieves the region that is currently in the process of being repainted.
+Retrieves the region that is currently being repainted.
-After a call to gdk_draw_context_begin_frame() this function will return
-a union of the region passed to that function and the area of the surface
-that the @context determined needs to be repainted.
+After a call to [method@Gdk.DrawContext.begin_frame] this function will
+return a union of the region passed to that function and the area of the
+surface that the @context determined needs to be repainted.
-If @context is not in between calls to gdk_draw_context_begin_frame() and
-gdk_draw_context_end_frame(), %NULL will be returned.
+If @context is not in between calls to [method@Gdk.DrawContext.begin_frame]
+and [method@Gdk.DrawContext.end_frame], %NULL will be returned.
</description>
@@ -6475,13 +7018,13 @@ a frame.
<function name="gdk_draw_context_get_surface">
<description>
-Retrieves the #GdkSurface used by the @context.
+Retrieves the surface that @context is bound to.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkDrawContext
+<parameter_description> a `GdkDrawContext`
</parameter_description>
</parameter>
</parameters>
@@ -6491,22 +7034,22 @@ Retrieves the #GdkSurface used by the @context.
<function name="gdk_draw_context_is_in_frame">
<description>
-Returns %TRUE if @context is in the process of drawing to its surface
-after a call to gdk_draw_context_begin_frame() and not yet having called
-gdk_draw_context_end_frame().
-In this situation, drawing commands may be effecting the contents of a
-@context's surface.
+Returns %TRUE if @context is in the process of drawing to its surface.
+
+This is the case between calls to [method@Gdk.DrawContext.begin_frame]
+and [method@Gdk.DrawContext.end_frame]. In this situation, drawing commands
+may be effecting the contents of the @context's surface.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkDrawContext
+<parameter_description> a `GdkDrawContext`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the context is between gdk_draw_context_begin_frame()
-and gdk_draw_context_end_frame() calls.
+<return> %TRUE if the context is between [method@Gdk.DrawContext.begin_frame]
+and [method@Gdk.DrawContext.end_frame] calls.
</return>
</function>
@@ -6515,17 +7058,16 @@ and gdk_draw_context_end_frame() calls.
Ends the drag operation after a drop.
The @action must be a single action selected from the actions
-available via gdk_drop_get_actions().
+available via [method Gdk Drop.get_actions].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GdkDrop
+<parameter_description> a `GdkDrop`
</parameter_description>
</parameter>
<parameter name="action">
-<parameter_description> the action performed by the destination or 0 if the drop
-failed
+<parameter_description> the action performed by the destination or 0 if the drop failed
</parameter_description>
</parameter>
</parameters>
@@ -6534,66 +7076,68 @@ failed
<function name="gdk_drop_get_actions">
<description>
-Returns the possible actions for this #GdkDrop. If this value
-contains multiple actions - ie gdk_drag_action_is_unique()
-returns %FALSE for the result - gdk_drop_finish() must choose
-the action to use when accepting the drop. This will only
-happen if you passed %GDK_ACTION_ASK as one of the possible
-actions in gdk_drop_status(). %GDK_ACTION_ASK itself will not
+Returns the possible actions for this `GdkDrop`.
+
+If this value contains multiple actions - i.e.
+[func@Gdk.DragAction.is_unique] returns %FALSE for the result -
+[method Gdk Drop.finish] must choose the action to use when
+accepting the drop. This will only happen if you passed
+%GDK_ACTION_ASK as one of the possible actions in
+[method Gdk Drop.status]. %GDK_ACTION_ASK itself will not
be included in the actions returned by this function.
-This value may change over the lifetime of the #GdkDrop both
-as a response to source side actions as well as to calls to
-gdk_drop_status() or gdk_drop_finish(). The source side will
-not change this value anymore once a drop has started.
+This value may change over the lifetime of the [class Gdk Drop]
+both as a response to source side actions as well as to calls to
+[method Gdk Drop.status] or [method Gdk Drop.finish]. The source
+side will not change this value anymore once a drop has started.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GdkDrop
+<parameter_description> a `GdkDrop`
</parameter_description>
</parameter>
</parameters>
-<return> The possible #GdkDragActions
+<return> The possible `GdkDragActions`
</return>
</function>
<function name="gdk_drop_get_device">
<description>
-Returns the #GdkDevice performing the drop.
+Returns the `GdkDevice` performing the drop.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GdkDrop
+<parameter_description> a `GdkDrop`
</parameter_description>
</parameter>
</parameters>
-<return> The #GdkDevice performing the drop.
+<return> The `GdkDevice` performing the drop.
</return>
</function>
<function name="gdk_drop_get_display">
<description>
-Gets the #GdkDisplay that @self was created for.
+Gets the `GdkDisplay` that @self was created for.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GdkDrop
+<parameter_description> a `GdkDrop`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDisplay
+<return> a `GdkDisplay`
</return>
</function>
<function name="gdk_drop_get_drag">
<description>
-If this is an in-app drag-and-drop operation, returns the #GdkDrag
+If this is an in-app drag-and-drop operation, returns the `GdkDrag`
that corresponds to this drop.
If it is not, %NULL is returned.
@@ -6602,56 +7146,56 @@ If it is not, %NULL is returned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GdkDrop
+<parameter_description> a `GdkDrop`
</parameter_description>
</parameter>
</parameters>
-<return> the corresponding #GdkDrag
+<return> the corresponding `GdkDrag`
</return>
</function>
<function name="gdk_drop_get_formats">
<description>
-Returns the #GdkContentFormats that the drop offers the data
+Returns the `GdkContentFormats` that the drop offers the data
to be read in.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GdkDrop
+<parameter_description> a `GdkDrop`
</parameter_description>
</parameter>
</parameters>
-<return> The possible #GdkContentFormats
+<return> The possible `GdkContentFormats`
</return>
</function>
<function name="gdk_drop_get_surface">
<description>
-Returns the #GdkSurface performing the drop.
+Returns the `GdkSurface` performing the drop.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GdkDrop
+<parameter_description> a `GdkDrop`
</parameter_description>
</parameter>
</parameters>
-<return> The #GdkSurface performing the drop.
+<return> The `GdkSurface` performing the drop.
</return>
</function>
<function name="gdk_drop_read_async">
<description>
-Asynchronously read the dropped data from a #GdkDrop
+Asynchronously read the dropped data from a `GdkDrop`
in a format that complies with one of the mime types.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GdkDrop
+<parameter_description> a `GdkDrop`
</parameter_description>
</parameter>
<parameter name="mime_types">
@@ -6660,16 +7204,16 @@ pointer to an array of mime types
</parameter_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the io priority for the read operation
+<parameter_description> the I/O priority for the read operation
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object,
+<parameter_description> optional `GCancellable` object,
%NULL to ignore
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when
+<parameter_description> a `GAsyncReadyCallback` to call when
the request is satisfied
</parameter_description>
</parameter>
@@ -6683,17 +7227,24 @@ the request is satisfied
<function name="gdk_drop_read_finish">
<description>
-Finishes an async drop read operation, see gdk_drop_read_async().
+Finishes an async drop read operation.
+
+Note that you must not use blocking read calls on the returned stream
+in the GTK thread, since some platforms might require communication with
+GTK to complete the data transfer. You can use async APIs such as
+g_input_stream_read_bytes_async().
+
+See [method Gdk Drop.read_async].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GdkDrop
+<parameter_description> a `GdkDrop`
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult
+<parameter_description> a `GAsyncResult`
</parameter_description>
</parameter>
<parameter name="out_mime_type">
@@ -6705,38 +7256,39 @@ Finishes an async drop read operation, see gdk_drop_read_async().
</parameter_description>
</parameter>
</parameters>
-<return> the #GInputStream, or %NULL
+<return> the `GInputStream`, or %NULL
</return>
</function>
<function name="gdk_drop_read_value_async">
<description>
-Asynchronously request the drag operation's contents converted to the given
-@type. When the operation is finished @callback will be called.
-You can then call gdk_drop_read_value_finish() to get the resulting
-#GValue.
+Asynchronously request the drag operation's contents converted
+to the given @type.
+
+When the operation is finished @callback will be called. You must
+then call [method Gdk Drop.read_value_finish] to get the resulting
+`GValue`.
-For local drag'n'drop operations that are available in the given #GType, the
-value will be copied directly. Otherwise, GDK will try to use
-gdk_content_deserialize_async() to convert the data.
+For local drag'n'drop operations that are available in the given
+`GType`, the value will be copied directly. Otherwise, GDK will
+try to use [func@Gdk.content_deserialize_async] to convert the data.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GdkDrop
+<parameter_description> a `GdkDrop`
</parameter_description>
</parameter>
<parameter name="type">
-<parameter_description> a #GType to read
+<parameter_description> a `GType` to read
</parameter_description>
</parameter>
<parameter name="io_priority">
-<parameter_description> the [I/O priority][io-priority]
-of the request.
+<parameter_description> the I/O priority of the request.
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore.
+<parameter_description> optional `GCancellable` object, %NULL to ignore.
</parameter_description>
</parameter>
<parameter name="callback">
@@ -6753,27 +7305,27 @@ of the request.
<function name="gdk_drop_read_value_finish">
<description>
-Finishes an async drop read started with
-gdk_drop_read_value_async().
+Finishes an async drop read.
+
+See [method Gdk Drop.read_value_async].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GdkDrop
+<parameter_description> a `GdkDrop`
</parameter_description>
</parameter>
<parameter name="result">
-<parameter_description> a #GAsyncResult
+<parameter_description> a `GAsyncResult`
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError location to store the error occurring, or %NULL to
-ignore.
+<parameter_description> a `GError` location to store the error occurring, or %NULL to ignore
</parameter_description>
</parameter>
</parameters>
-<return> a #GValue containing the result.
+<return> a `GValue` containing the result.
</return>
</function>
@@ -6782,7 +7334,7 @@ ignore.
Selects all actions that are potentially supported by the destination.
When calling this function, do not restrict the passed in actions to
-the ones provided by gdk_drop_get_actions(). Those actions may
+the ones provided by [method Gdk Drop.get_actions]. Those actions may
change in the future, even depending on the actions you provide here.
The @preferred action is a hint to the drag'n'drop mechanism about which
@@ -6796,7 +7348,7 @@ actions first and then later call this function again.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GdkDrop
+<parameter_description> a `GdkDrop`
</parameter_description>
</parameter>
<parameter name="actions">
@@ -6806,7 +7358,7 @@ that a drop will not be accepted
</parameter>
<parameter name="preferred">
<parameter_description> A unique action that's a member of @actions indicating the
-preferred action.
+preferred action
</parameter_description>
</parameter>
</parameters>
@@ -6821,7 +7373,7 @@ Extracts all axis values from an event.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter_description> a `GdkEvent`
</parameter_description>
</parameter>
<parameter name="axes">
@@ -6846,7 +7398,7 @@ an event structure.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter_description> a `GdkEvent`
</parameter_description>
</parameter>
<parameter name="axis_use">
@@ -6870,7 +7422,7 @@ Returns the device of an event.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #GdkEvent.
+<parameter_description> a `GdkEvent`.
</parameter_description>
</parameter>
</parameters>
@@ -6880,20 +7432,22 @@ Returns the device of an event.
<function name="gdk_event_get_device_tool">
<description>
-If the event was generated by a device that supports
-different tools (eg. a tablet), this function will
-return a #GdkDeviceTool representing the tool that
-caused the event. Otherwise, %NULL will be returned.
+Returns a `GdkDeviceTool` representing the tool that
+caused the event.
+
+If the was not generated by a device that supports
+different tools (such as a tablet), this function will
+return %NULL.
-Note: the #GdkDeviceTools will be constant during
+Note: the `GdkDeviceTool` will be constant during
the application lifetime, if settings must be stored
-persistently across runs, see gdk_device_tool_get_serial()
+persistently across runs, see [method@Gdk.DeviceTool.get_serial].
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter_description> a `GdkEvent`
</parameter_description>
</parameter>
</parameters>
@@ -6903,13 +7457,13 @@ persistently across runs, see gdk_device_tool_get_serial()
<function name="gdk_event_get_display">
<description>
-Retrieves the #GdkDisplay associated to the @event.
+Retrieves the display associated to the @event.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter_description> a `GdkEvent`
</parameter_description>
</parameter>
</parameters>
@@ -6919,14 +7473,16 @@ Retrieves the #GdkDisplay associated to the @event.
<function name="gdk_event_get_event_sequence">
<description>
-If @event is a touch event, returns the #GdkEventSequence
-to which the event belongs. Otherwise, return %NULL.
+Retuns the event sequence to which the event belongs.
+
+Related touch events are connected in a sequence. Other
+events typically don't have event sequence information.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter_description> a `GdkEvent`
</parameter_description>
</parameter>
</parameters>
@@ -6942,29 +7498,30 @@ Retrieves the type of the event.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter_description> a `GdkEvent`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkEventType
+<return> a `GdkEvent`Type
</return>
</function>
<function name="gdk_event_get_history">
<description>
-Retrieves the history of the @event, as a list of time and coordinates.
+Retrieves the history of the device that @event is for, as a list of
+time and coordinates.
-The history includes events that are not delivered to the application
-because they occurred in the same frame as @event.
+The history includes positions that are not delivered as separate events
+to the application because they occurred in the same frame as @event.
Note that only motion and scroll events record history, and motion
-events only if one of the mouse buttons is down.
+events do it only if one of the mouse buttons is down.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a motion or scroll #GdkEvent
+<parameter_description> a motion or scroll event
</parameter_description>
</parameter>
<parameter name="out_n_coords">
@@ -6985,7 +7542,7 @@ Returns the modifier state field of an event.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter_description> a `GdkEvent`
</parameter_description>
</parameter>
</parameters>
@@ -6995,14 +7552,15 @@ Returns the modifier state field of an event.
<function name="gdk_event_get_pointer_emulated">
<description>
-Returns whether this event is an 'emulated' pointer event (typically
-from a touch event), as opposed to a real one.
+Returns whether this event is an 'emulated' pointer event.
+
+Emulated pointer events typically originate from a touch events.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter_description> a `GdkEvent`
</parameter_description>
</parameter>
</parameters>
@@ -7017,7 +7575,7 @@ Extract the event surface relative x/y coordinates from an event.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter_description> a `GdkEvent`
</parameter_description>
</parameter>
<parameter name="x">
@@ -7040,7 +7598,7 @@ Returns the seat that originated the event.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter_description> a `GdkEvent`
</parameter_description>
</parameter>
</parameters>
@@ -7050,13 +7608,13 @@ Returns the seat that originated the event.
<function name="gdk_event_get_surface">
<description>
-Extracts the #GdkSurface associated with an event.
+Extracts the surface associated with an event.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter_description> a `GdkEvent`
</parameter_description>
</parameter>
</parameters>
@@ -7066,18 +7624,20 @@ Extracts the #GdkSurface associated with an event.
<function name="gdk_event_get_time">
<description>
-Returns the time stamp from @event, if there is one; otherwise
-returns #GDK_CURRENT_TIME.
+Returns the timestamp of @event.
+
+Not all events have timestamps. In that case, this function
+returns %GDK_CURRENT_TIME.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter_description> a `GdkEvent`
</parameter_description>
</parameter>
</parameters>
-<return> time stamp field from @event
+<return> timestamp field from @event
</return>
</function>
@@ -7089,7 +7649,7 @@ Increase the ref count of @event.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter_description> a `GdkEvent`
</parameter_description>
</parameter>
</parameters>
@@ -7099,9 +7659,10 @@ Increase the ref count of @event.
<function name="gdk_event_triggers_context_menu">
<description>
-This function returns whether a #GdkEvent should trigger a
-context menu, according to platform conventions. The right
-mouse button always triggers context menus.
+Returns whether a `GdkEvent` should trigger a context menu,
+according to platform conventions.
+
+The right mouse button typically triggers context menus.
This function should always be used instead of simply checking for
event->button == %GDK_BUTTON_SECONDARY.
@@ -7110,7 +7671,7 @@ event->button == %GDK_BUTTON_SECONDARY.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #GdkEvent, currently only button events are meaningful values
+<parameter_description> a `GdkEvent`, currently only button events are meaningful values
</parameter_description>
</parameter>
</parameters>
@@ -7120,13 +7681,14 @@ event->button == %GDK_BUTTON_SECONDARY.
<function name="gdk_event_unref">
<description>
-Decrease the ref count of @event, and free it
-if the last reference is dropped.
+Decrease the ref count of @event.
+
+If the last reference is dropped, the structure is freed.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter_description> a `GdkEvent`
</parameter_description>
</parameter>
</parameters>
@@ -7135,20 +7697,24 @@ if the last reference is dropped.
<function name="gdk_events_get_angle">
<description>
-If both events contain X/Y information, this function will return %TRUE
-and return in @angle the relative angle from @event1 to @event2. The rotation
-direction for positive angles is from the positive X axis towards the positive
-Y axis.
+Returns the relative angle from @event1 to @event2.
+
+The relative angle is the angle between the X axis and the line
+through both events' positions. The rotation direction for positive
+angles is from the positive X axis towards the positive Y axis.
+
+This assumes that both events have X/Y information.
+If not, this function returns %FALSE.
</description>
<parameters>
<parameter name="event1">
-<parameter_description> first #GdkEvent
+<parameter_description> first `GdkEvent`
</parameter_description>
</parameter>
<parameter name="event2">
-<parameter_description> second #GdkEvent
+<parameter_description> second `GdkEvent`
</parameter_description>
</parameter>
<parameter name="angle">
@@ -7162,18 +7728,20 @@ Y axis.
<function name="gdk_events_get_center">
<description>
-If both events contain X/Y information, the center of both coordinates
-will be returned in @x and @y.
+Returns the point halfway between the events' positions.
+
+This assumes that both events have X/Y information.
+If not, this function returns %FALSE.
</description>
<parameters>
<parameter name="event1">
-<parameter_description> first #GdkEvent
+<parameter_description> first `GdkEvent`
</parameter_description>
</parameter>
<parameter name="event2">
-<parameter_description> second #GdkEvent
+<parameter_description> second `GdkEvent`
</parameter_description>
</parameter>
<parameter name="x">
@@ -7191,18 +7759,20 @@ will be returned in @x and @y.
<function name="gdk_events_get_distance">
<description>
-If both events have X/Y information, the distance between both coordinates
-(as in a straight line going from @event1 to @event2) will be returned.
+Returns the distance between the event locations.
+
+This assumes that both events have X/Y information.
+If not, this function returns %FALSE.
</description>
<parameters>
<parameter name="event1">
-<parameter_description> first #GdkEvent
+<parameter_description> first `GdkEvent`
</parameter_description>
</parameter>
<parameter name="event2">
-<parameter_description> second #GdkEvent
+<parameter_description> second `GdkEvent`
</parameter_description>
</parameter>
<parameter name="distance">
@@ -7233,17 +7803,18 @@ leaving the surface.
<function name="gdk_frame_clock_begin_updating">
<description>
-Starts updates for an animation. Until a matching call to
-gdk_frame_clock_end_updating() is made, the frame clock will continually
-request a new frame with the %GDK_FRAME_CLOCK_PHASE_UPDATE phase.
-This function may be called multiple times and frames will be
-requested until gdk_frame_clock_end_updating() is called the same
-number of times.
+Starts updates for an animation.
+
+Until a matching call to [method@Gdk.FrameClock.end_updating] is made,
+the frame clock will continually request a new frame with the
+%GDK_FRAME_CLOCK_PHASE_UPDATE phase. This function may be called multiple
+times and frames will be requested until gdk_frame_clock_end_updating()
+is called the same number of times.
</description>
<parameters>
<parameter name="frame_clock">
-<parameter_description> a #GdkFrameClock
+<parameter_description> a `GdkFrameClock`
</parameter_description>
</parameter>
</parameters>
@@ -7252,13 +7823,14 @@ number of times.
<function name="gdk_frame_clock_end_updating">
<description>
-Stops updates for an animation. See the documentation for
-gdk_frame_clock_begin_updating().
+Stops updates for an animation.
+
+See the documentation for [method@Gdk.FrameClock.begin_updating].
</description>
<parameters>
<parameter name="frame_clock">
-<parameter_description> a #GdkFrameClock
+<parameter_description> a `GdkFrameClock`
</parameter_description>
</parameter>
</parameters>
@@ -7273,11 +7845,11 @@ Gets the frame timings for the current frame.
</description>
<parameters>
<parameter name="frame_clock">
-<parameter_description> a #GdkFrameClock
+<parameter_description> a `GdkFrameClock`
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkFrameTimings for the
+<return> the `GdkFrameTimings` for the
frame currently being processed, or even no frame is being
processed, for the previous frame. Before any frames have been
processed, returns %NULL.
@@ -7293,24 +7865,24 @@ frame timings of @frame_clock.
</description>
<parameters>
<parameter name="frame_clock">
-<parameter_description> a #GdkFrameClock
+<parameter_description> a `GdkFrameClock`
</parameter_description>
</parameter>
</parameters>
-<return> the current fps, as a double
+<return> the current fps, as a `double`
</return>
</function>
<function name="gdk_frame_clock_get_frame_counter">
<description>
-A #GdkFrameClock maintains a 64-bit counter that increments for
+`GdkFrameClock` maintains a 64-bit counter that increments for
each frame drawn.
</description>
<parameters>
<parameter name="frame_clock">
-<parameter_description> a #GdkFrameClock
+<parameter_description> a `GdkFrameClock`
</parameter_description>
</parameter>
</parameters>
@@ -7322,8 +7894,9 @@ counter for the last frame.
<function name="gdk_frame_clock_get_frame_time">
<description>
-Gets the time that should currently be used for animations. Inside
-the processing of a frame, it’s the time used to compute the
+Gets the time that should currently be used for animations.
+
+Inside the processing of a frame, it’s the time used to compute the
animation position of everything in a frame. Outside of a frame, it's
the time of the conceptual “previous frame,” which may be either
the actual previous frame time, or if that’s too old, an updated
@@ -7333,7 +7906,7 @@ time.
</description>
<parameters>
<parameter name="frame_clock">
-<parameter_description> a #GdkFrameClock
+<parameter_description> a `GdkFrameClock`
</parameter_description>
</parameter>
</parameters>
@@ -7344,29 +7917,33 @@ of g_get_monotonic_time().
<function name="gdk_frame_clock_get_history_start">
<description>
-#GdkFrameClock internally keeps a history of #GdkFrameTimings
+Returns the frame counter for the oldest frame available in history.
+
+`GdkFrameClock` internally keeps a history of `GdkFrameTimings`
objects for recent frames that can be retrieved with
-gdk_frame_clock_get_timings(). The set of stored frames
+[method@Gdk.FrameClock.get_timings]. The set of stored frames
is the set from the counter values given by
-gdk_frame_clock_get_history_start() and
-gdk_frame_clock_get_frame_counter(), inclusive.
+[method@Gdk.FrameClock.get_history_start] and
+[method@Gdk.FrameClock.get_frame_counter], inclusive.
</description>
<parameters>
<parameter name="frame_clock">
-<parameter_description> a #GdkFrameClock
+<parameter_description> a `GdkFrameClock`
</parameter_description>
</parameter>
</parameters>
<return> the frame counter value for the oldest frame
that is available in the internal frame history of the
-#GdkFrameClock.
+`GdkFrameClock`
</return>
</function>
<function name="gdk_frame_clock_get_refresh_info">
<description>
+Predicts a presentation time, based on history.
+
Using the frame history stored in the frame clock, finds the last
known presentation time and refresh interval, and assuming that
presentation times are separated by the refresh interval,
@@ -7376,7 +7953,7 @@ interval after the last presentation time, and later than @base_time.
</description>
<parameters>
<parameter name="frame_clock">
-<parameter_description> a #GdkFrameClock
+<parameter_description> a `GdkFrameClock`
</parameter_description>
</parameter>
<parameter name="base_time">
@@ -7401,46 +7978,49 @@ candidate presentation time after the given base time.
<function name="gdk_frame_clock_get_timings">
<description>
-Retrieves a #GdkFrameTimings object holding timing information
-for the current frame or a recent frame. The #GdkFrameTimings
-object may not yet be complete: see gdk_frame_timings_get_complete().
+Retrieves a `GdkFrameTimings` object holding timing information
+for the current frame or a recent frame.
+
+The `GdkFrameTimings` object may not yet be complete: see
+[method@Gdk.FrameTimings.get_complete].
</description>
<parameters>
<parameter name="frame_clock">
-<parameter_description> a #GdkFrameClock
+<parameter_description> a `GdkFrameClock`
</parameter_description>
</parameter>
<parameter name="frame_counter">
<parameter_description> the frame counter value identifying the frame to
-be received.
+be received
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkFrameTimings object for
-the specified frame, or %NULL if it is not available. See
-gdk_frame_clock_get_history_start().
+<return> the `GdkFrameTimings` object
+for the specified frame, or %NULL if it is not available. See
+[method@Gdk.FrameClock.get_history_start].
</return>
</function>
<function name="gdk_frame_clock_request_phase">
<description>
-Asks the frame clock to run a particular phase. The signal
-corresponding the requested phase will be emitted the next
+Asks the frame clock to run a particular phase.
+
+The signal corresponding the requested phase will be emitted the next
time the frame clock processes. Multiple calls to
gdk_frame_clock_request_phase() will be combined together
and only one frame processed. If you are displaying animated
content and want to continually request the
%GDK_FRAME_CLOCK_PHASE_UPDATE phase for a period of time,
-you should use gdk_frame_clock_begin_updating() instead, since
-this allows GTK to adjust system parameters to get maximally
+you should use [method@Gdk.FrameClock.begin_updating] instead,
+since this allows GTK to adjust system parameters to get maximally
smooth animations.
</description>
<parameters>
<parameter name="frame_clock">
-<parameter_description> a #GdkFrameClock
+<parameter_description> a `GdkFrameClock`
</parameter_description>
</parameter>
<parameter name="phase">
@@ -7453,21 +8033,25 @@ smooth animations.
<function name="gdk_frame_timings_get_complete">
<description>
-The timing information in a #GdkFrameTimings is filled in
+Returns whether @timings are complete.
+
+The timing information in a `GdkFrameTimings` is filled in
incrementally as the frame as drawn and passed off to the
window system for processing and display to the user. The
-accessor functions for #GdkFrameTimings can return 0 to
+accessor functions for `GdkFrameTimings` can return 0 to
indicate an unavailable value for two reasons: either because
the information is not yet available, or because it isn't
-available at all. Once gdk_frame_timings_get_complete() returns
-%TRUE for a frame, you can be certain that no further values
-will become available and be stored in the #GdkFrameTimings.
+available at all.
+
+Once this function returns %TRUE for a frame, you can be
+certain that no further values will become available and be
+stored in the `GdkFrameTimings`.
</description>
<parameters>
<parameter name="timings">
-<parameter_description> a #GdkFrameTimings
+<parameter_description> a `GdkFrameTimings`
</parameter_description>
</parameter>
</parameters>
@@ -7478,14 +8062,14 @@ for the frame has been filled in.
<function name="gdk_frame_timings_get_frame_counter">
<description>
-Gets the frame counter value of the #GdkFrameClock when this
+Gets the frame counter value of the `GdkFrameClock` when
this frame was drawn.
</description>
<parameters>
<parameter name="timings">
-<parameter_description> a #GdkFrameTimings
+<parameter_description> a `GdkFrameTimings`
</parameter_description>
</parameter>
</parameters>
@@ -7495,15 +8079,16 @@ this frame was drawn.
<function name="gdk_frame_timings_get_frame_time">
<description>
-Returns the frame time for the frame. This is the time value
-that is typically used to time animations for the frame. See
-gdk_frame_clock_get_frame_time().
+Returns the frame time for the frame.
+
+This is the time value that is typically used to time
+animations for the frame. See [method@Gdk.FrameClock.get_frame_time].
</description>
<parameters>
<parameter name="timings">
-<parameter_description> A #GdkFrameTimings
+<parameter_description> A `GdkFrameTimings`
</parameter_description>
</parameter>
</parameters>
@@ -7514,21 +8099,24 @@ of g_get_monotonic_time()
<function name="gdk_frame_timings_get_predicted_presentation_time">
<description>
-Gets the predicted time at which this frame will be displayed. Although
-no predicted time may be available, if one is available, it will
-be available while the frame is being generated, in contrast to
-gdk_frame_timings_get_presentation_time(), which is only available
-after the frame has been presented. In general, if you are simply
-animating, you should use gdk_frame_clock_get_frame_time() rather
-than this function, but this function is useful for applications
-that want exact control over latency. For example, a movie player
-may want this information for Audio/Video synchronization.
+Gets the predicted time at which this frame will be displayed.
+
+Although no predicted time may be available, if one is available,
+it will be available while the frame is being generated, in contrast
+to [method@Gdk.FrameTimings.get_presentation_time], which is only
+available after the frame has been presented.
+
+In general, if you are simply animating, you should use
+[method@Gdk.FrameClock.get_frame_time] rather than this function,
+but this function is useful for applications that want exact control
+over latency. For example, a movie player may want this information
+for Audio/Video synchronization.
</description>
<parameters>
<parameter name="timings">
-<parameter_description> a #GdkFrameTimings
+<parameter_description> a `GdkFrameTimings`
</parameter_description>
</parameter>
</parameters>
@@ -7540,40 +8128,43 @@ presentation time is available.
<function name="gdk_frame_timings_get_presentation_time">
<description>
-Reurns the presentation time. This is the time at which the frame
-became visible to the user.
+Reurns the presentation time.
+
+This is the time at which the frame became visible to the user.
</description>
<parameters>
<parameter name="timings">
-<parameter_description> a #GdkFrameTimings
+<parameter_description> a `GdkFrameTimings`
</parameter_description>
</parameter>
</parameters>
<return> the time the frame was displayed to the user, in the
timescale of g_get_monotonic_time(), or 0 if no presentation
-time is available. See gdk_frame_timings_get_complete()
+time is available. See [method@Gdk.FrameTimings.get_complete]
</return>
</function>
<function name="gdk_frame_timings_get_refresh_interval">
<description>
Gets the natural interval between presentation times for
-the display that this frame was displayed on. Frame presentation
-usually happens during the “vertical blanking interval”.
+the display that this frame was displayed on.
+
+Frame presentation usually happens during the “vertical
+blanking interval”.
</description>
<parameters>
<parameter name="timings">
-<parameter_description> a #GdkFrameTimings
+<parameter_description> a `GdkFrameTimings`
</parameter_description>
</parameter>
</parameters>
<return> the refresh interval of the display, in microseconds,
or 0 if the refresh interval is not available.
-See gdk_frame_timings_get_complete().
+See [method@Gdk.FrameTimings.get_complete].
</return>
</function>
@@ -7585,7 +8176,7 @@ Increases the reference count of @timings.
</description>
<parameters>
<parameter name="timings">
-<parameter_description> a #GdkFrameTimings
+<parameter_description> a `GdkFrameTimings`
</parameter_description>
</parameter>
</parameters>
@@ -7595,13 +8186,14 @@ Increases the reference count of @timings.
<function name="gdk_frame_timings_unref">
<description>
-Decreases the reference count of @timings. If @timings
-is no longer referenced, it will be freed.
+Decreases the reference count of @timings.
+
+If @timings is no longer referenced, it will be freed.
</description>
<parameters>
<parameter name="timings">
-<parameter_description> a #GdkFrameTimings
+<parameter_description> a `GdkFrameTimings`
</parameter_description>
</parameter>
</parameters>
@@ -7610,10 +8202,10 @@ is no longer referenced, it will be freed.
<function name="gdk_gl_context_clear_current">
<description>
-Clears the current #GdkGLContext.
+Clears the current `GdkGLContext`.
Any OpenGL call after this function returns will be ignored
-until gdk_gl_context_make_current() is called.
+until [method@Gdk.GLContext.make_current] is called.
</description>
<parameters>
@@ -7623,25 +8215,27 @@ until gdk_gl_context_make_current() is called.
<function name="gdk_gl_context_get_current">
<description>
-Retrieves the current #GdkGLContext.
+Retrieves the current `GdkGLContext`.
</description>
<parameters>
</parameters>
-<return> the current #GdkGLContext, or %NULL
+<return> the current `GdkGLContext`, or %NULL
</return>
</function>
<function name="gdk_gl_context_get_debug_enabled">
<description>
-Retrieves the value set using gdk_gl_context_set_debug_enabled().
+Retrieves whether the context is doing extra validations and runtime checking.
+
+See [method@Gdk.GLContext.set_debug_enabled].
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkGLContext
+<parameter_description> a `GdkGLContext`
</parameter_description>
</parameter>
</parameters>
@@ -7651,45 +8245,48 @@ Retrieves the value set using gdk_gl_context_set_debug_enabled().
<function name="gdk_gl_context_get_display">
<description>
-Retrieves the #GdkDisplay the @context is created for
+Retrieves the display the @context is created for
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkGLContext
+<parameter_description> a `GdkGLContext`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDisplay or %NULL
+<return> a `GdkDisplay` or %NULL
</return>
</function>
<function name="gdk_gl_context_get_forward_compatible">
<description>
-Retrieves the value set using gdk_gl_context_set_forward_compatible().
+Retrieves whether the context is forward-compatible.
+
+See [method@Gdk.GLContext.set_forward_compatible].
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkGLContext
+<parameter_description> a `GdkGLContext`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the context should be forward compatible
+<return> %TRUE if the context should be forward-compatible
</return>
</function>
<function name="gdk_gl_context_get_required_version">
<description>
-Retrieves the major and minor version requested by calling
-gdk_gl_context_set_required_version().
+Retrieves required OpenGL version.
+
+See [method@Gdk.GLContext.set_required_version].
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkGLContext
+<parameter_description> a `GdkGLContext`
</parameter_description>
</parameter>
<parameter name="major">
@@ -7706,33 +8303,33 @@ gdk_gl_context_set_required_version().
<function name="gdk_gl_context_get_shared_context">
<description>
-Retrieves the #GdkGLContext that this @context share data with.
+Retrieves the `GdkGLContext` that this @context share data with.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkGLContext
+<parameter_description> a `GdkGLContext`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkGLContext or %NULL
+<return> a `GdkGLContext` or %NULL
</return>
</function>
<function name="gdk_gl_context_get_surface">
<description>
-Retrieves the #GdkSurface used by the @context.
+Retrieves the surface used by the @context.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkGLContext
+<parameter_description> a `GdkGLContext`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkSurface or %NULL
+<return> a `GdkSurface` or %NULL
</return>
</function>
@@ -7744,11 +8341,11 @@ Checks whether the @context is using an OpenGL or OpenGL ES profile.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkGLContext
+<parameter_description> a `GdkGLContext`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the #GdkGLContext is using an OpenGL ES profile
+<return> %TRUE if the `GdkGLContext` is using an OpenGL ES profile
</return>
</function>
@@ -7761,7 +8358,7 @@ The @context must be realized prior to calling this function.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkGLContext
+<parameter_description> a `GdkGLContext`
</parameter_description>
</parameter>
<parameter name="major">
@@ -7778,9 +8375,9 @@ The @context must be realized prior to calling this function.
<function name="gdk_gl_context_is_legacy">
<description>
-Whether the #GdkGLContext is in legacy mode or not.
+Whether the `GdkGLContext` is in legacy mode or not.
-The #GdkGLContext must be realized before calling this function.
+The `GdkGLContext` must be realized before calling this function.
When realizing a GL context, GDK will try to use the OpenGL 3.2 core
profile; this profile removes all the OpenGL API that was deprecated
@@ -7799,7 +8396,7 @@ kind of shader programs to load.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkGLContext
+<parameter_description> a `GdkGLContext`
</parameter_description>
</parameter>
</parameters>
@@ -7814,7 +8411,7 @@ Makes the @context the current one.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkGLContext
+<parameter_description> a `GdkGLContext`
</parameter_description>
</parameter>
</parameters>
@@ -7823,19 +8420,19 @@ Makes the @context the current one.
<function name="gdk_gl_context_realize">
<description>
-Realizes the given #GdkGLContext.
+Realizes the given `GdkGLContext`.
-It is safe to call this function on a realized #GdkGLContext.
+It is safe to call this function on a realized `GdkGLContext`.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkGLContext
+<parameter_description> a `GdkGLContext`
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter_description> return location for a `GError`
</parameter_description>
</parameter>
</parameters>
@@ -7845,17 +8442,18 @@ It is safe to call this function on a realized #GdkGLContext.
<function name="gdk_gl_context_set_debug_enabled">
<description>
-Sets whether the #GdkGLContext should perform extra validations and
-run time checking. This is useful during development, but has
-additional overhead.
+Sets whether the `GdkGLContext` should perform extra validations and
+runtime checking.
+
+This is useful during development, but has additional overhead.
-The #GdkGLContext must not be realized or made current prior to
+The `GdkGLContext` must not be realized or made current prior to
calling this function.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkGLContext
+<parameter_description> a `GdkGLContext`
</parameter_description>
</parameter>
<parameter name="enabled">
@@ -7868,24 +8466,24 @@ calling this function.
<function name="gdk_gl_context_set_forward_compatible">
<description>
-Sets whether the #GdkGLContext should be forward compatible.
+Sets whether the `GdkGLContext` should be forward-compatible.
-Forward compatible contexts must not support OpenGL functionality that
+Forward-compatible contexts must not support OpenGL functionality that
has been marked as deprecated in the requested version; non-forward
compatible contexts, on the other hand, must support both deprecated and
non deprecated functionality.
-The #GdkGLContext must not be realized or made current prior to calling
+The `GdkGLContext` must not be realized or made current prior to calling
this function.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkGLContext
+<parameter_description> a `GdkGLContext`
</parameter_description>
</parameter>
<parameter name="compatible">
-<parameter_description> whether the context should be forward compatible
+<parameter_description> whether the context should be forward-compatible
</parameter_description>
</parameter>
</parameters>
@@ -7898,13 +8496,13 @@ Sets the major and minor version of OpenGL to request.
Setting @major and @minor to zero will use the default values.
-The #GdkGLContext must not be realized or made current prior to calling
+The `GdkGLContext` must not be realized or made current prior to calling
this function.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkGLContext
+<parameter_description> a `GdkGLContext`
</parameter_description>
</parameter>
<parameter name="major">
@@ -7921,8 +8519,9 @@ this function.
<function name="gdk_gl_context_set_use_es">
<description>
-Requests that GDK create an OpenGL ES context instead of an OpenGL one,
-if the platform and windowing system allows it.
+Requests that GDK create an OpenGL ES context instead of an OpenGL one.
+
+Not all platforms support OpenGL ES.
The @context must not have been realized.
@@ -7930,14 +8529,14 @@ By default, GDK will attempt to automatically detect whether the
underlying GL implementation is OpenGL or OpenGL ES once the @context
is realized.
-You should check the return value of gdk_gl_context_get_use_es() after
-calling gdk_gl_context_realize() to decide whether to use the OpenGL or
-OpenGL ES API, extensions, or shaders.
+You should check the return value of [method@Gdk.GLContext.get_use_es]
+after calling [method@Gdk.GLContext.realize] to decide whether to use
+the OpenGL or OpenGL ES API, extensions, or shaders.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkGLContext:
+<parameter_description> a `GdkGLContext`
</parameter_description>
</parameter>
<parameter name="use_es">
@@ -7955,13 +8554,13 @@ Creates a new texture for an existing GL texture.
Note that the GL texture must not be modified until @destroy is called,
which will happen when the GdkTexture object is finalized, or due to
-an explicit call of gdk_gl_texture_release().
+an explicit call of [method@Gdk.GLTexture.release].
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkGLContext
+<parameter_description> a `GdkGLContext`
</parameter_description>
</parameter>
<parameter name="id">
@@ -7986,23 +8585,22 @@ are released
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created #GdkTexture
+<return> A newly-created `GdkTexture`
</return>
</function>
<function name="gdk_gl_texture_release">
<description>
-Releases the GL resources held by a #GdkGLTexture that
-was created with gdk_gl_texture_new().
+Releases the GL resources held by a `GdkGLTexture`.
The texture contents are still available via the
-gdk_texture_download() function, after this function
-has been called.
+[method@Gdk.Texture.download] function, after this
+function has been called.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GdkTexture wrapping a GL texture
+<parameter_description> a `GdkTexture` wrapping a GL texture
</parameter_description>
</parameter>
</parameters>
@@ -8143,14 +8741,16 @@ Extracts the shift level from a key event.
<function name="gdk_key_event_get_match">
<description>
-Gets a keyval and modifier combination that will cause
-gdk_key_event_matches() to successfully match the given event.
+Gets a keyval and modifier combination that will match
+the event.
+
+See [method@Gdk.KeyEvent.matches].
</description>
<parameters>
<parameter name="event">
-<parameter_description> a key #GdkEvent
+<parameter_description> a key `GdkEvent`
</parameter_description>
</parameter>
<parameter name="keyval">
@@ -8184,9 +8784,12 @@ Extracts whether the key event is for a modifier key.
<function name="gdk_key_event_matches">
<description>
-Matches a key event against a keyboard shortcut that is specified
-as a keyval and modifiers. Partial matches are possible where the
-combination matches if the currently active group is ignored.
+Matches a key event against a keyval and modifiers.
+
+This is typically used to trigger keyboard shortcuts such as Ctrl-C.
+
+Partial matches are possible where the combination matches
+if the currently active group is ignored.
Note that we ignore Caps Lock for matching.
@@ -8194,7 +8797,7 @@ Note that we ignore Caps Lock for matching.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a key #GdkEvent
+<parameter_description> a key `GdkEvent`
</parameter_description>
</parameter>
<parameter name="keyval">
@@ -8206,7 +8809,7 @@ Note that we ignore Caps Lock for matching.
</parameter_description>
</parameter>
</parameters>
-<return> a GdkKeyMatch value describing whether @event matches
+<return> a `GdkKeyMatch` value describing whether @event matches
</return>
</function>
@@ -8229,6 +8832,7 @@ Returns whether the Caps Lock modifier is locked.
<function name="gdk_keymap_get_direction">
<description>
Returns the direction of effective layout of the keymap.
+
The direction of a layout is the direction of the majority of its
symbols. See pango_unichar_direction().
@@ -8527,6 +9131,7 @@ that were used to determine the group or level, or %NULL
<function name="gdk_keyval_convert_case">
<description>
Obtains the upper- and lower-case versions of the keyval @symbol.
+
Examples of keyvals are #GDK_KEY_a, #GDK_KEY_Enter, #GDK_KEY_F1, etc.
</description>
@@ -8643,7 +9248,7 @@ in lower case or it is not subject to case conversion.
<function name="gdk_keyval_to_unicode">
<description>
-Convert from a GDK key symbol to the corresponding ISO10646 (Unicode)
+Convert from a GDK key symbol to the corresponding Unicode
character.
Note that the conversion does not take the current locale
@@ -8683,7 +9288,8 @@ in upper case or it is not subject to case conversion.
<function name="gdk_memory_texture_new">
<description>
Creates a new texture for a blob of image data.
-The #GBytes must contain @stride x @height pixels
+
+The `GBytes` must contain @stride x @height pixels
in the given format.
@@ -8702,7 +9308,7 @@ in the given format.
</parameter_description>
</parameter>
<parameter name="bytes">
-<parameter_description> the #GBytes containing the pixel data
+<parameter_description> the `GBytes` containing the pixel data
</parameter_description>
</parameter>
<parameter name="stride">
@@ -8710,7 +9316,7 @@ in the given format.
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created #GdkTexture
+<return> A newly-created `GdkTexture`
</return>
</function>
@@ -8722,7 +9328,7 @@ Gets the name of the monitor's connector, if available.
</description>
<parameters>
<parameter name="monitor">
-<parameter_description> a #GdkMonitor
+<parameter_description> a `GdkMonitor`
</parameter_description>
</parameter>
</parameters>
@@ -8738,7 +9344,7 @@ Gets the display that this monitor belongs to.
</description>
<parameters>
<parameter name="monitor">
-<parameter_description> a #GdkMonitor
+<parameter_description> a `GdkMonitor`
</parameter_description>
</parameter>
</parameters>
@@ -8748,18 +9354,20 @@ Gets the display that this monitor belongs to.
<function name="gdk_monitor_get_geometry">
<description>
-Retrieves the size and position of an individual monitor within the
-display coordinate space. The returned geometry is in ”application pixels”,
-not in ”device pixels” (see gdk_monitor_get_scale_factor()).
+Retrieves the size and position of the monitor within the
+display coordinate space.
+
+The returned geometry is in ”application pixels”, not in
+”device pixels” (see [method@Gdk.Monitor.get_scale_factor]).
</description>
<parameters>
<parameter name="monitor">
-<parameter_description> a #GdkMonitor
+<parameter_description> a `GdkMonitor`
</parameter_description>
</parameter>
<parameter name="geometry">
-<parameter_description> a #GdkRectangle to be filled with the monitor geometry
+<parameter_description> a `GdkRectangle` to be filled with the monitor geometry
</parameter_description>
</parameter>
</parameters>
@@ -8774,7 +9382,7 @@ Gets the height in millimeters of the monitor.
</description>
<parameters>
<parameter name="monitor">
-<parameter_description> a #GdkMonitor
+<parameter_description> a `GdkMonitor`
</parameter_description>
</parameter>
</parameters>
@@ -8784,22 +9392,24 @@ Gets the height in millimeters of the monitor.
<function name="gdk_monitor_get_manufacturer">
<description>
-Gets the name or PNP ID of the monitor's manufacturer, if available.
+Gets the name or PNP ID of the monitor's manufacturer.
Note that this value might also vary depending on actual
display backend.
-PNP ID registry is located at https://uefi.org/pnp_id_list
+The PNP ID registry is located at
+[https://uefi.org/pnp_id_list](https://uefi.org/pnp_id_list).
</description>
<parameters>
<parameter name="monitor">
-<parameter_description> a #GdkMonitor
+<parameter_description> a `GdkMonitor`
</parameter_description>
</parameter>
</parameters>
-<return> the name of the manufacturer, or %NULL
+<return> the name of the manufacturer,
+or %NULL
</return>
</function>
@@ -8811,7 +9421,7 @@ Gets the string identifying the monitor model, if available.
</description>
<parameters>
<parameter name="monitor">
-<parameter_description> a #GdkMonitor
+<parameter_description> a `GdkMonitor`
</parameter_description>
</parameter>
</parameters>
@@ -8830,7 +9440,7 @@ is returned as 60000.
</description>
<parameters>
<parameter name="monitor">
-<parameter_description> a #GdkMonitor
+<parameter_description> a `GdkMonitor`
</parameter_description>
</parameter>
</parameters>
@@ -8841,18 +9451,20 @@ is returned as 60000.
<function name="gdk_monitor_get_scale_factor">
<description>
Gets the internal scale factor that maps from monitor coordinates
-to the actual device pixels. On traditional systems this is 1, but
-on very high density outputs this can be a higher value (often 2).
+to device pixels.
+
+On traditional systems this is 1, but on very high density outputs
+it can be a higher value (often 2).
This can be used if you want to create pixel based data for a
particular monitor, but most of the time you’re drawing to a surface
-where it is better to use gdk_surface_get_scale_factor() instead.
+where it is better to use [method@Gdk.Surface.get_scale_factor] instead.
</description>
<parameters>
<parameter name="monitor">
-<parameter_description> a #GdkMonitor
+<parameter_description> a `GdkMonitor`
</parameter_description>
</parameter>
</parameters>
@@ -8863,13 +9475,13 @@ where it is better to use gdk_surface_get_scale_factor() instead.
<function name="gdk_monitor_get_subpixel_layout">
<description>
Gets information about the layout of red, green and blue
-primaries for each pixel in this monitor, if available.
+primaries for pixels.
</description>
<parameters>
<parameter name="monitor">
-<parameter_description> a #GdkMonitor
+<parameter_description> a `GdkMonitor`
</parameter_description>
</parameter>
</parameters>
@@ -8885,7 +9497,7 @@ Gets the width in millimeters of the monitor.
</description>
<parameters>
<parameter name="monitor">
-<parameter_description> a #GdkMonitor
+<parameter_description> a `GdkMonitor`
</parameter_description>
</parameter>
</parameters>
@@ -8896,14 +9508,16 @@ Gets the width in millimeters of the monitor.
<function name="gdk_monitor_is_valid">
<description>
Returns %TRUE if the @monitor object corresponds to a
-physical monitor. The @monitor becomes invalid when the
-physical monitor is unplugged or removed.
+physical monitor.
+
+The @monitor becomes invalid when the physical monitor
+is unplugged or removed.
</description>
<parameters>
<parameter name="monitor">
-<parameter_description> a #GdkMonitor
+<parameter_description> a `GdkMonitor`
</parameter_description>
</parameter>
</parameters>
@@ -8974,8 +9588,10 @@ Extracts group and mode information from a pad event.
<function name="gdk_paintable_compute_concrete_size">
<description>
-Applies the sizing algorithm outlined in
-https://drafts.csswg.org/css-images-3/#default-sizing
+Compute a concrete size for the `GdkPaintable`.
+
+Applies the sizing algorithm outlined in the
+[CSS Image spec](https://drafts.csswg.org/css-images-3/#default-sizing)
to the given @paintable. See that link for more details.
It is not necessary to call this function when both @specified_width
@@ -8986,7 +9602,7 @@ other dimension when only one dimension is given.
</description>
<parameters>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable
+<parameter_description> a `GdkPaintable`
</parameter_description>
</parameter>
<parameter name="specified_width">
@@ -9027,8 +9643,8 @@ computed.
<description>
Gets an immutable paintable for the current contents displayed by @paintable.
-This is useful when you want to retain the current state of an animation, for
-example to take a screenshot of a running animation.
+This is useful when you want to retain the current state of an animation,
+for example to take a screenshot of a running animation.
If the @paintable is already immutable, it will return itself.
@@ -9036,7 +9652,7 @@ If the @paintable is already immutable, it will return itself.
</description>
<parameters>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable
+<parameter_description> a `GdkPaintable`
</parameter_description>
</parameter>
</parameters>
@@ -9047,45 +9663,49 @@ contents of @paintable.
<function name="gdk_paintable_get_flags">
<description>
-Get flags for the paintable. This is oftentimes useful for optimizations.
+Get flags for the paintable.
+
+This is oftentimes useful for optimizations.
-See #GdkPaintableFlags for the flags and what they mean.
+See [flags@Gdk.PaintableFlags] for the flags and what they mean.
</description>
<parameters>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable
+<parameter_description> a `GdkPaintable`
</parameter_description>
</parameter>
</parameters>
-<return> The #GdkPaintableFlags for this paintable.
+<return> The `GdkPaintableFlags` for this paintable
</return>
</function>
<function name="gdk_paintable_get_intrinsic_aspect_ratio">
<description>
Gets the preferred aspect ratio the @paintable would like to be displayed at.
-The aspect ratio is the width divided by the height, so a value of 0.5 means
-that the @paintable prefers to be displayed twice as high as it is wide.
-Consumers of this interface can use this to preserve aspect ratio when displaying
-the paintable.
-This is a purely informational value and does not in any way limit the values
-that may be passed to gdk_paintable_snapshot().
+The aspect ratio is the width divided by the height, so a value of 0.5
+means that the @paintable prefers to be displayed twice as high as it
+is wide. Consumers of this interface can use this to preserve aspect
+ratio when displaying the paintable.
+
+This is a purely informational value and does not in any way limit the
+values that may be passed to [method@Gdk.Paintable.snapshot].
Usually when a @paintable returns nonzero values from
-gdk_paintable_get_intrinsic_width() and gdk_paintable_get_intrinsic_height()
-the aspect ratio should conform to those values, though that is not required.
+[method@Gdk.Paintable.get_intrinsic_width] and
+[method@Gdk.Paintable.get_intrinsic_height] the aspect ratio
+should conform to those values, though that is not required.
-If the @paintable does not have a preferred aspect ratio, it returns 0.
-Negative values are never returned.
+If the @paintable does not have a preferred aspect ratio,
+it returns 0. Negative values are never returned.
</description>
<parameters>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable
+<parameter_description> a `GdkPaintable`
</parameter_description>
</parameter>
</parameters>
@@ -9096,20 +9716,21 @@ Negative values are never returned.
<function name="gdk_paintable_get_intrinsic_height">
<description>
Gets the preferred height the @paintable would like to be displayed at.
+
Consumers of this interface can use this to reserve enough space to draw
the paintable.
-This is a purely informational value and does not in any way limit the values
-that may be passed to gdk_paintable_snapshot().
+This is a purely informational value and does not in any way limit the
+values that may be passed to [method@Gdk.Paintable.snapshot].
-If the @paintable does not have a preferred height, it returns 0. Negative
-values are never returned.
+If the @paintable does not have a preferred height, it returns 0.
+Negative values are never returned.
</description>
<parameters>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable
+<parameter_description> a `GdkPaintable`
</parameter_description>
</parameter>
</parameters>
@@ -9120,20 +9741,21 @@ values are never returned.
<function name="gdk_paintable_get_intrinsic_width">
<description>
Gets the preferred width the @paintable would like to be displayed at.
+
Consumers of this interface can use this to reserve enough space to draw
the paintable.
-This is a purely informational value and does not in any way limit the values
-that may be passed to gdk_paintable_snapshot().
+This is a purely informational value and does not in any way limit the
+values that may be passed to [method@Gdk.Paintable.snapshot].
-If the @paintable does not have a preferred width, it returns 0. Negative
-values are never returned.
+If the @paintable does not have a preferred width, it returns 0.
+Negative values are never returned.
</description>
<parameters>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable
+<parameter_description> a `GdkPaintable`
</parameter_description>
</parameter>
</parameters>
@@ -9143,11 +9765,13 @@ values are never returned.
<function name="gdk_paintable_invalidate_contents">
<description>
-Called by implementations of #GdkPaintable to invalidate their contents.
+Called by implementations of `GdkPaintable` to invalidate their contents.
+
Unless the contents are invalidated, implementations must guarantee that
-multiple calls of gdk_paintable_snapshot() produce the same output.
+multiple calls of [method@Gdk.Paintable.snapshot] produce the same output.
-This function will emit the #GdkPaintable::invalidate-contents signal.
+This function will emit the [signal@Gdk.Paintable::invalidate-contents]
+signal.
If a @paintable reports the %GDK_PAINTABLE_STATIC_CONTENTS flag,
it must not call this function.
@@ -9155,7 +9779,7 @@ it must not call this function.
</description>
<parameters>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable
+<parameter_description> a `GdkPaintable`
</parameter_description>
</parameter>
</parameters>
@@ -9164,11 +9788,13 @@ it must not call this function.
<function name="gdk_paintable_invalidate_size">
<description>
-Called by implementations of #GdkPaintable to invalidate their size.
+Called by implementations of `GdkPaintable` to invalidate their size.
+
As long as the size is not invalidated, @paintable must return the same
values for its intrinsic width, height and aspect ratio.
-This function will emit the #GdkPaintable::invalidate-size signal.
+This function will emit the [signal@Gdk.Paintable::invalidate-size]
+signal.
If a @paintable reports the %GDK_PAINTABLE_STATIC_SIZE flag,
it must not call this function.
@@ -9176,7 +9802,7 @@ it must not call this function.
</description>
<parameters>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable
+<parameter_description> a `GdkPaintable`
</parameter_description>
</parameter>
</parameters>
@@ -9186,9 +9812,11 @@ it must not call this function.
<function name="gdk_paintable_new_empty">
<description>
Returns a paintable that has the given intrinsic size and draws nothing.
-This is often useful for implementing the #GdkPaintableInterface.get_current_image()
-virtual function when the paintable is in an incomplete state (like a
-#GtkMediaStream before receiving the first frame).
+
+This is often useful for implementing the
+#GdkPaintableInterface.get_current_image() virtual function
+when the paintable is in an incomplete state (like a
+[class@Gtk.MediaStream] before receiving the first frame).
</description>
@@ -9202,24 +9830,26 @@ virtual function when the paintable is in an incomplete state (like a
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkPaintable
+<return> a `GdkPaintable`
</return>
</function>
<function name="gdk_paintable_snapshot">
<description>
-Snapshots the given paintable with the given @width and @height at the
-current (0,0) offset of the @snapshot. If @width and @height are not larger
-than zero, this function will do nothing.
+Snapshots the given paintable with the given @width and @height.
+
+The paintable is drawn at the current (0,0) offset of the @snapshot.
+If @width and @height are not larger than zero, this function will
+do nothing.
</description>
<parameters>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable
+<parameter_description> a `GdkPaintable`
</parameter_description>
</parameter>
<parameter name="snapshot">
-<parameter_description> a #GdkSnapshot to snapshot to
+<parameter_description> a `GdkSnapshot` to snapshot to
</parameter_description>
</parameter>
<parameter name="width">
@@ -9237,9 +9867,10 @@ than zero, this function will do nothing.
<function name="gdk_pango_layout_get_clip_region">
<description>
Obtains a clip region which contains the areas where the given ranges
-of text would be drawn. @x_origin and @y_origin are the top left point
-to center the layout. @index_ranges should contain
-ranges of bytes in the layout’s text.
+of text would be drawn.
+
+@x_origin and @y_origin are the top left point to center the layout.
+@index_ranges should contain ranges of bytes in the layout’s text.
Note that the regions returned correspond to logical extents of the text
ranges, not ink extents. So the drawn layout may in fact touch areas out of
@@ -9250,7 +9881,7 @@ of text, such as when text is selected.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #PangoLayout
+<parameter_description> a `PangoLayout`
</parameter_description>
</parameter>
<parameter name="x_origin">
@@ -9277,14 +9908,15 @@ of text, such as when text is selected.
<function name="gdk_pango_layout_line_get_clip_region">
<description>
Obtains a clip region which contains the areas where the given
-ranges of text would be drawn. @x_origin and @y_origin are the top left
-position of the layout. @index_ranges
-should contain ranges of bytes in the layout’s text. The clip
-region will include space to the left or right of the line (to the
-layout bounding box) if you have indexes above or below the indexes
-contained inside the line. This is to draw the selection all the way
-to the side of the layout. However, the clip region is in line coordinates,
-not layout coordinates.
+ranges of text would be drawn.
+
+@x_origin and @y_origin are the top left position of the layout.
+@index_ranges should contain ranges of bytes in the layout’s text.
+The clip region will include space to the left or right of the line
+(to the layout bounding box) if you have indexes above or below the
+indexes contained inside the line. This is to draw the selection all
+the way to the side of the layout. However, the clip region is in line
+coordinates, not layout coordinates.
Note that the regions returned correspond to logical extents of the text
ranges, not ink extents. So the drawn line may in fact touch areas out of
@@ -9295,7 +9927,7 @@ of text, such as when text is selected.
</description>
<parameters>
<parameter name="line">
-<parameter_description> a #PangoLayoutLine
+<parameter_description> a `PangoLayoutLine`
</parameter_description>
</parameter>
<parameter name="x_origin">
@@ -9341,13 +9973,18 @@ g_output_stream_splice().
<function name="gdk_pixbuf_add_alpha">
<description>
Takes an existing pixbuf and adds an alpha channel to it.
+
If the existing pixbuf already had an alpha channel, the channel
values are copied from the original; otherwise, the alpha channel
is initialized to 255 (full opacity).
-If @substitute_color is %TRUE, then the color specified by (@r, @g, @b) will be
-assigned zero opacity. That is, if you pass (255, 255, 255) for the
-substitute color, all white pixels will become fully transparent.
+If `substitute_color` is `TRUE`, then the color specified by the
+(`r`, `g`, `b`) arguments will be assigned zero opacity. That is,
+if you pass `(255, 255, 255)` for the substitute color, all white
+pixels will become fully transparent.
+
+If `substitute_color` is `FALSE`, then the (`r`, `g`, `b`) arguments
+will be ignored.
</description>
@@ -9357,8 +9994,7 @@ substitute color, all white pixels will become fully transparent.
</parameter_description>
</parameter>
<parameter name="substitute_color">
-<parameter_description> Whether to set a color to zero opacity. If this
-is %FALSE, then the (@r, @g, @b) arguments will be ignored.
+<parameter_description> Whether to set a color to zero opacity.
</parameter_description>
</parameter>
<parameter name="r">
@@ -9374,7 +10010,7 @@ is %FALSE, then the (@r, @g, @b) arguments will be ignored.
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created pixbuf with a reference count of 1.
+<return> A newly-created pixbuf
</return>
</function>
@@ -9396,9 +10032,10 @@ Queries the height of the bounding box of a pixbuf animation.
<function name="gdk_pixbuf_animation_get_iter">
<description>
-Get an iterator for displaying an animation. The iterator provides
-the frames that should be displayed at a given time. It should be
-freed after use with g_object_unref().
+Get an iterator for displaying an animation.
+
+The iterator provides the frames that should be displayed at a
+given time.
@start_time would normally come from g_get_current_time(), and marks
the beginning of animation playback. After creating an iterator, you
@@ -9410,7 +10047,7 @@ gdk_pixbuf_animation_iter_get_delay_time() milliseconds. Each time
the image is updated, you should reinstall the timeout with the new,
possibly-changed delay time.
-As a shortcut, if @start_time is %NULL, the result of
+As a shortcut, if @start_time is `NULL`, the result of
g_get_current_time() will be used automatically.
To update the image (i.e. possibly change the result of
@@ -9421,14 +10058,14 @@ If you're using #GdkPixbufLoader, in addition to updating the image
after the delay time, you should also update it whenever you
receive the area_updated signal and
gdk_pixbuf_animation_iter_on_currently_loading_frame() returns
-%TRUE. In this case, the frame currently being fed into the loader
+`TRUE`. In this case, the frame currently being fed into the loader
has received new data, so needs to be refreshed. The delay time for
a frame may also be modified after an area_updated signal, for
example if the delay time for a frame is encoded in the data after
the frame itself. So your timeout should be reinstalled after any
area_updated signal.
-A delay time of -1 is possible, indicating "infinite."
+A delay time of -1 is possible, indicating "infinite".
</description>
@@ -9448,12 +10085,17 @@ A delay time of -1 is possible, indicating "infinite."
<function name="gdk_pixbuf_animation_get_static_image">
<description>
+Retrieves a static image for the animation.
+
If an animation is really just a plain image (has only one frame),
-this function returns that image. If the animation is an animation,
-this function returns a reasonable thing to display as a static
-unanimated image, which might be the first frame, or something more
-sophisticated. If an animation hasn't loaded any frames yet, this
-function will return %NULL.
+this function returns that image.
+
+If the animation is an animation, this function returns a reasonable
+image to use as a static unanimated image, which might be the first
+frame, or something more sophisticated depending on the file format.
+
+If an animation hasn't loaded any frames yet, this function will
+return `NULL`.
</description>
@@ -9485,9 +10127,11 @@ Queries the width of the bounding box of a pixbuf animation.
<function name="gdk_pixbuf_animation_is_static_image">
<description>
+Checks whether the animation is a static image.
+
If you load a file with gdk_pixbuf_animation_new_from_file() and it
turns out to be a plain, unanimated image, then this function will
-return %TRUE. Use gdk_pixbuf_animation_get_static_image() to retrieve
+return `TRUE`. Use gdk_pixbuf_animation_get_static_image() to retrieve
the image.
@@ -9498,14 +10142,16 @@ the image.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the "animation" was really just an image
+<return> `TRUE` if the "animation" was really just an image
</return>
</function>
<function name="gdk_pixbuf_animation_iter_advance">
<description>
-Possibly advances an animation to a new frame. Chooses the frame based
-on the start time passed to gdk_pixbuf_animation_get_iter().
+Possibly advances an animation to a new frame.
+
+Chooses the frame based on the start time passed to
+gdk_pixbuf_animation_get_iter().
@current_time would normally come from g_get_current_time(), and
must be greater than or equal to the time passed to
@@ -9514,14 +10160,14 @@ unchanged each time gdk_pixbuf_animation_iter_get_pixbuf() is
called. That is, you can't go backward in time; animations only
play forward.
-As a shortcut, pass %NULL for the current time and g_get_current_time()
+As a shortcut, pass `NULL` for the current time and g_get_current_time()
will be invoked on your behalf. So you only need to explicitly pass
@current_time if you're doing something odd like playing the animation
at double speed.
-If this function returns %FALSE, there's no need to update the animation
+If this function returns `FALSE`, there's no need to update the animation
display, assuming the display had been rendered prior to advancing;
-if %TRUE, you need to call gdk_pixbuf_animation_iter_get_pixbuf()
+if `TRUE`, you need to call gdk_pixbuf_animation_iter_get_pixbuf()
and update the display with the new pixbuf.
@@ -9536,16 +10182,17 @@ and update the display with the new pixbuf.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the image may need updating
+<return> `TRUE` if the image may need updating
</return>
</function>
<function name="gdk_pixbuf_animation_iter_get_delay_time">
<description>
Gets the number of milliseconds the current pixbuf should be displayed,
-or -1 if the current pixbuf should be displayed forever. g_timeout_add()
-conveniently takes a timeout in milliseconds, so you can use a timeout
-to schedule the next update.
+or -1 if the current pixbuf should be displayed forever.
+
+The `g_timeout_add()` function conveniently takes a timeout in milliseconds,
+so you can use a timeout to schedule the next update.
Note that some formats, like GIF, might clamp the timeout values in the
image file to avoid updates that are just too quick. The minimum timeout
@@ -9565,17 +10212,21 @@ for GIF images is currently 20 milliseconds.
<function name="gdk_pixbuf_animation_iter_get_pixbuf">
<description>
-Gets the current pixbuf which should be displayed; the pixbuf might not
-be the same size as the animation itself
+Gets the current pixbuf which should be displayed.
+
+The pixbuf might not be the same size as the animation itself
(gdk_pixbuf_animation_get_width(), gdk_pixbuf_animation_get_height()).
-This pixbuf should be displayed for
-gdk_pixbuf_animation_iter_get_delay_time() milliseconds. The caller
-of this function does not own a reference to the returned pixbuf;
-the returned pixbuf will become invalid when the iterator advances
-to the next frame, which may happen anytime you call
-gdk_pixbuf_animation_iter_advance(). Copy the pixbuf to keep it
-(don't just add a reference), as it may get recycled as you advance
-the iterator.
+
+This pixbuf should be displayed for gdk_pixbuf_animation_iter_get_delay_time()
+milliseconds.
+
+The caller of this function does not own a reference to the returned
+pixbuf; the returned pixbuf will become invalid when the iterator
+advances to the next frame, which may happen anytime you call
+gdk_pixbuf_animation_iter_advance().
+
+Copy the pixbuf to keep it (don't just add a reference), as it may get
+recycled as you advance the iterator.
</description>
@@ -9592,10 +10243,11 @@ the iterator.
<function name="gdk_pixbuf_animation_iter_on_currently_loading_frame">
<description>
Used to determine how to respond to the area_updated signal on
-#GdkPixbufLoader when loading an animation. area_updated is emitted
-for an area of the frame currently streaming in to the loader. So if
-you're on the currently loading frame, you need to redraw the screen for
-the updated area.
+#GdkPixbufLoader when loading an animation.
+
+The `::area_updated` signal is emitted for an area of the frame currently
+streaming in to the loader. So if you're on the currently loading frame,
+you will need to redraw the screen for the updated area.
</description>
@@ -9605,16 +10257,20 @@ the updated area.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the frame we're on is partially loaded, or the last frame
+<return> `TRUE` if the frame we're on is partially loaded, or the last frame
</return>
</function>
<function name="gdk_pixbuf_animation_new_from_file">
<description>
-Creates a new animation by loading it from a file. The file format is
-detected automatically. If the file's format does not support multi-frame
-images, then an animation with a single frame will be created. Possible errors
-are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.
+Creates a new animation by loading it from a file.
+
+The file format is detected automatically.
+
+If the file's format does not support multi-frame images, then an animation
+with a single frame will be created.
+
+Possible errors are in the `GDK_PIXBUF_ERROR` and `G_FILE_ERROR` domains.
</description>
@@ -9629,10 +10285,7 @@ name encoding
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created animation with a reference count of 1, or %NULL
-if any of several error conditions ocurred: the file could not be opened,
-there was no loader for the file's format, there was not enough memory to
-allocate the image buffer, or the image file contained invalid data.
+<return> A newly-created animation
</return>
</function>
@@ -9652,7 +10305,7 @@ Same as gdk_pixbuf_animation_new_from_file()
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created animation with a reference count of 1, or %NULL
+<return> A newly-created animation with a reference count of 1, or `NULL`
if any of several error conditions ocurred: the file could not be opened,
there was no loader for the file's format, there was not enough memory to
allocate the image buffer, or the image file contained invalid data.
@@ -9663,7 +10316,7 @@ allocate the image buffer, or the image file contained invalid data.
<description>
Creates a new pixbuf animation by loading an image from an resource.
-The file format is detected automatically. If %NULL is returned, then
+The file format is detected automatically. If `NULL` is returned, then
@error will be set.
Since: 2.28
@@ -9679,10 +10332,7 @@ Since: 2.28
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created animation, or %NULL if any of several error
-conditions occurred: the file could not be opened, the image format is
-not supported, there was not enough memory to allocate the image buffer,
-the stream contained invalid data, or the operation was cancelled.
+<return> A newly-created animation
</return>
</function>
@@ -9691,11 +10341,14 @@ the stream contained invalid data, or the operation was cancelled.
<description>
Creates a new animation by loading it from an input stream.
-The file format is detected automatically. If %NULL is returned, then
-@error will be set. The @cancellable can be used to abort the operation
-from another thread. If the operation was cancelled, the error
-%G_IO_ERROR_CANCELLED will be returned. Other possible errors are in
-the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains.
+The file format is detected automatically.
+
+If `NULL` is returned, then @error will be set.
+
+The @cancellable can be used to abort the operation from another thread.
+If the operation was cancelled, the error `G_IO_ERROR_CANCELLED` will be
+returned. Other possible errors are in the `GDK_PIXBUF_ERROR` and
+`G_IO_ERROR` domains.
The stream is not closed.
@@ -9704,11 +10357,11 @@ Since: 2.28
</description>
<parameters>
<parameter name="stream">
-<parameter_description> a #GInputStream to load the pixbuf from
+<parameter_description> a `GInputStream` to load the pixbuf from
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<parameter_description> optional `GCancellable` object
</parameter_description>
</parameter>
<parameter name="error">
@@ -9716,10 +10369,7 @@ Since: 2.28
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created pixbuf, or %NULL if any of several error
-conditions occurred: the file could not be opened, the image format is
-not supported, there was not enough memory to allocate the image buffer,
-the stream contained invalid data, or the operation was cancelled.
+<return> A newly-created animation
</return>
</function>
@@ -9731,7 +10381,7 @@ Creates a new animation by asynchronously loading an image from an input stream.
For more details see gdk_pixbuf_new_from_stream(), which is the synchronous
version of this function.
-When the operation is finished, @callback will be called in the main thread.
+When the operation is finished, `callback` will be called in the main thread.
You can then call gdk_pixbuf_animation_new_from_stream_finish() to get the
result of the operation.
@@ -9744,11 +10394,11 @@ Since: 2.28
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<parameter_description> optional #GCancellable object
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when the pixbuf is loaded
+<parameter_description> a `GAsyncReadyCallback` to call when the pixbuf is loaded
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -9762,7 +10412,7 @@ Since: 2.28
<function name="gdk_pixbuf_animation_new_from_stream_finish">
<description>
Finishes an asynchronous pixbuf animation creation operation started with
-gdk_pixbuf_animation_new_from_stream_async().
+[func@GdkPixbuf.PixbufAnimation.new_from_stream_async].
Since: 2.28
@@ -9773,12 +10423,11 @@ Since: 2.28
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError, or %NULL
+<parameter_description> a #GError, or `NULL`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkPixbufAnimation or %NULL on error. Free the returned
-object with g_object_unref().
+<return> the newly created animation
</return>
</function>
@@ -9820,26 +10469,26 @@ Deprecated: 2.0: Use g_object_unref().
<function name="gdk_pixbuf_apply_embedded_orientation">
<description>
Takes an existing pixbuf and checks for the presence of an
-associated "orientation" option, which may be provided by the
-jpeg loader (which reads the exif orientation tag) or the
-tiff loader (which reads the tiff orientation tag, and
-compensates it for the partial transforms performed by
-libtiff). If an orientation option/tag is present, the
-appropriate transform will be performed so that the pixbuf
-is oriented correctly.
+associated "orientation" option.
+
+The orientation option may be provided by the JPEG loader (which
+reads the exif orientation tag) or the TIFF loader (which reads
+the TIFF orientation tag, and compensates it for the partial
+transforms performed by libtiff).
+
+If an orientation option/tag is present, the appropriate transform
+will be performed so that the pixbuf is oriented correctly.
Since: 2.12
</description>
<parameters>
<parameter name="src">
-<parameter_description> A #GdkPixbuf.
+<parameter_description> a pixbuf with an orientation option
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created pixbuf, %NULL if
-not enough memory could be allocated for it, or a reference to the
-input pixbuf (with an increased reference count).
+<return> A newly-created pixbuf
</return>
</function>
@@ -10059,8 +10708,10 @@ it manages are freed.
<function name="gdk_pixbuf_calculate_rowstride">
<description>
Calculates the rowstride that an image created with those values would
-have. This is useful for front-ends and backends that want to sanity
-check image values without needing to create them.
+have.
+
+This function is useful for front-ends and backends that want to check
+image values without needing to create a `GdkPixbuf`.
Since: 2.36.8
@@ -10096,6 +10747,7 @@ Since: 2.36.8
<description>
Creates a transformation of the source image @src by scaling by
@scale_x and @scale_y then translating by @offset_x and @offset_y.
+
This gives an image in the coordinates of the destination pixbuf.
The rectangle (@dest_x, @dest_y, @dest_width, @dest_height)
is then alpha blended onto the corresponding rectangle of the
@@ -10176,7 +10828,6 @@ path is used which omits the alpha blending and just performs the scaling.
See gdk_pixbuf_composite_color_simple() for a simpler variant of this
function suitable for many tasks.
-
</description>
<parameters>
<parameter name="src">
@@ -10253,9 +10904,9 @@ function suitable for many tasks.
<function name="gdk_pixbuf_composite_color_simple">
<description>
-Creates a new #GdkPixbuf by scaling @src to @dest_width x
-@dest_height and alpha blending the result with a checkboard of colors
-@color1 and @color2.
+Creates a new pixbuf by scaling `src` to `dest_width` x `dest_height`
+and alpha blending the result with a checkboard of colors `color1`
+and `color2`.
</description>
@@ -10293,15 +10944,16 @@ Creates a new #GdkPixbuf by scaling @src to @dest_width x
</parameter_description>
</parameter>
</parameters>
-<return> the new #GdkPixbuf, or %NULL if not enough memory could be
-allocated for it.
+<return> the new pixbuf
</return>
</function>
<function name="gdk_pixbuf_copy">
<description>
-Creates a new #GdkPixbuf with a copy of the information in the specified
-@pixbuf. Note that this does not copy the options set on the original #GdkPixbuf,
+Creates a new `GdkPixbuf` with a copy of the information in the specified
+`pixbuf`.
+
+Note that this does not copy the options set on the original `GdkPixbuf`,
use gdk_pixbuf_copy_options() for this.
@@ -10312,15 +10964,15 @@ use gdk_pixbuf_copy_options() for this.
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created pixbuf with a reference count of 1, or %NULL if
-not enough memory could be allocated.
+<return> A newly-created pixbuf
</return>
</function>
<function name="gdk_pixbuf_copy_area">
<description>
-Copies a rectangular area from @src_pixbuf to @dest_pixbuf. Conversion of
-pixbuf formats is done automatically.
+Copies a rectangular area from `src_pixbuf` to `dest_pixbuf`.
+
+Conversion of pixbuf formats is done automatically.
If the source rectangle overlaps the destination rectangle on the
same pixbuf, it will be overwritten during the copy operation.
@@ -10366,7 +11018,9 @@ Therefore, you can not use this function to scroll a pixbuf.
<function name="gdk_pixbuf_copy_options">
<description>
-Copy the key/value pair options attached to a #GdkPixbuf to another.
+Copies the key/value pair options attached to a `GdkPixbuf` to another
+`GdkPixbuf`.
+
This is useful to keep original metadata after having manipulated
a file. However be careful to remove metadata which you've already
applied, such as the "orientation" option after rotating the image.
@@ -10376,15 +11030,15 @@ Since: 2.36
</description>
<parameters>
<parameter name="src_pixbuf">
-<parameter_description> a #GdkPixbuf to copy options from
+<parameter_description> the source pixbuf
</parameter_description>
</parameter>
<parameter name="dest_pixbuf">
-<parameter_description> the #GdkPixbuf to copy options to
+<parameter_description> the destination pixbuf
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success.
+<return> `TRUE` on success.
</return>
</function>
@@ -10392,19 +11046,20 @@ Since: 2.36
<function name="gdk_pixbuf_fill">
<description>
Clears a pixbuf to the given RGBA value, converting the RGBA value into
-the pixbuf's pixel format. The alpha will be ignored if the pixbuf
-doesn't have an alpha channel.
+the pixbuf's pixel format.
+The alpha component will be ignored if the pixbuf doesn't have an alpha
+channel.
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
+<parameter_description> a `GdkPixbuf`
</parameter_description>
</parameter>
<parameter name="pixel">
-<parameter_description> RGBA pixel to clear to
-(0xffffffff is opaque white, 0x00000000 transparent black)
+<parameter_description> RGBA pixel to used to clear (`0xffffffff` is opaque white,
+`0x00000000` transparent black)
</parameter_description>
</parameter>
</parameters>
@@ -10425,30 +11080,29 @@ Since: 2.6
</parameter_description>
</parameter>
<parameter name="horizontal">
-<parameter_description> %TRUE to flip horizontally, %FALSE to flip vertically
+<parameter_description> `TRUE` to flip horizontally, `FALSE` to flip vertically
</parameter_description>
</parameter>
</parameters>
-<return> the new #GdkPixbuf, or %NULL
-if not enough memory could be allocated for it.
+<return> the new pixbuf
</return>
</function>
<function name="gdk_pixbuf_format_copy">
<description>
-Creates a copy of @format
+Creates a copy of `format`.
Since: 2.22
</description>
<parameters>
<parameter name="format">
-<parameter_description> a #GdkPixbufFormat
+<parameter_description> a pixbuf format
</parameter_description>
</parameter>
</parameters>
-<return> the newly allocated copy of a #GdkPixbufFormat. Use
+<return> the newly allocated copy of a `GdkPixbufFormat`. Use
gdk_pixbuf_format_free() to free the resources when done
</return>
@@ -10456,7 +11110,7 @@ gdk_pixbuf_format_free() to free the resources when done
<function name="gdk_pixbuf_format_free">
<description>
-Frees the resources allocated when copying a #GdkPixbufFormat
+Frees the resources allocated when copying a `GdkPixbufFormat`
using gdk_pixbuf_format_copy()
Since: 2.22
@@ -10464,7 +11118,7 @@ Since: 2.22
</description>
<parameters>
<parameter name="format">
-<parameter_description> a #GdkPixbufFormat
+<parameter_description> a pixbuf format
</parameter_description>
</parameter>
</parameters>
@@ -10480,7 +11134,7 @@ Since: 2.2
</description>
<parameters>
<parameter name="format">
-<parameter_description> a #GdkPixbufFormat
+<parameter_description> a `GdkPixbufFormat`
</parameter_description>
</parameter>
</parameters>
@@ -10499,33 +11153,33 @@ Since: 2.2
</description>
<parameters>
<parameter name="format">
-<parameter_description> a #GdkPixbufFormat
+<parameter_description> a `GdkPixbufFormat`
</parameter_description>
</parameter>
</parameters>
-<return> a %NULL-terminated array of filename extensions which must be
-freed with g_strfreev() when it is no longer needed.
+<return> an array of
+filename extensions
</return>
</function>
<function name="gdk_pixbuf_format_get_license">
<description>
-Returns information about the license of the image loader for the format. The
-returned string should be a shorthand for a wellknown license, e.g. "LGPL",
-"GPL", "QPL", "GPL/QPL", or "other" to indicate some other license.
This
-string should be freed with g_free() when it's no longer needed.
+Returns information about the license of the image loader for the format.
+
+The returned string should be a shorthand for a well known license, e.g.
+"LGPL", "GPL", "QPL", "GPL/QPL", or "other" to indicate
some other license.
Since: 2.6
</description>
<parameters>
<parameter name="format">
-<parameter_description> a #GdkPixbufFormat
+<parameter_description> a pixbuf format
</parameter_description>
</parameter>
</parameters>
-<return> a string describing the license of @format.
+<return> a string describing the license of the pixbuf format
</return>
</function>
@@ -10539,12 +11193,11 @@ Since: 2.2
</description>
<parameters>
<parameter name="format">
-<parameter_description> a #GdkPixbufFormat
+<parameter_description> a `GdkPixbufFormat`
</parameter_description>
</parameter>
</parameters>
-<return> a %NULL-terminated array of mime types which must be freed with
-g_strfreev() when it is no longer needed.
+<return> an array of mime types
</return>
</function>
@@ -10558,7 +11211,7 @@ Since: 2.2
</description>
<parameters>
<parameter name="format">
-<parameter_description> a #GdkPixbufFormat
+<parameter_description> a `GdkPixbufFormat`
</parameter_description>
</parameter>
</parameters>
@@ -10569,15 +11222,16 @@ Since: 2.2
<function name="gdk_pixbuf_format_is_disabled">
<description>
-Returns whether this image format is disabled. See
-gdk_pixbuf_format_set_disabled().
+Returns whether this image format is disabled.
+
+See gdk_pixbuf_format_set_disabled().
Since: 2.6
</description>
<parameters>
<parameter name="format">
-<parameter_description> a #GdkPixbufFormat
+<parameter_description> a `GdkPixbufFormat`
</parameter_description>
</parameter>
</parameters>
@@ -10588,8 +11242,9 @@ Since: 2.6
<function name="gdk_pixbuf_format_is_save_option_supported">
<description>
-Returns %TRUE if the save option specified by @option_key is supported when
+Returns `TRUE` if the save option specified by @option_key is supported when
saving a pixbuf using the module implementing @format.
+
See gdk_pixbuf_save() for more information about option keys.
Since: 2.36
@@ -10597,7 +11252,7 @@ Since: 2.36
</description>
<parameters>
<parameter name="format">
-<parameter_description> a #GdkPixbufFormat
+<parameter_description> a pixbuf format
</parameter_description>
</parameter>
<parameter name="option_key">
@@ -10605,24 +11260,25 @@ Since: 2.36
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the specified option is supported
+<return> `TRUE` if the specified option is supported
</return>
</function>
<function name="gdk_pixbuf_format_is_scalable">
<description>
-Returns whether this image format is scalable. If a file is in a
-scalable format, it is preferable to load it at the desired size,
-rather than loading it at the default size and scaling the
-resulting pixbuf to the desired size.
+Returns whether this image format is scalable.
+
+If a file is in a scalable format, it is preferable to load it at
+the desired size, rather than loading it at the default size and
+scaling the resulting pixbuf to the desired size.
Since: 2.6
</description>
<parameters>
<parameter name="format">
-<parameter_description> a #GdkPixbufFormat
+<parameter_description> a `GdkPixbufFormat`
</parameter_description>
</parameter>
</parameters>
@@ -10640,7 +11296,7 @@ Since: 2.2
</description>
<parameters>
<parameter name="format">
-<parameter_description> a #GdkPixbufFormat
+<parameter_description> a `GdkPixbufFormat`
</parameter_description>
</parameter>
</parameters>
@@ -10651,21 +11307,24 @@ Since: 2.2
<function name="gdk_pixbuf_format_set_disabled">
<description>
-Disables or enables an image format. If a format is disabled,
-gdk-pixbuf won't use the image loader for this format to load
-images. Applications can use this to avoid using image loaders
-with an inappropriate license, see gdk_pixbuf_format_get_license().
+Disables or enables an image format.
+
+If a format is disabled, GdkPixbuf won't use the image loader for
+this format to load images.
+
+Applications can use this to avoid using image loaders with an
+inappropriate license, see gdk_pixbuf_format_get_license().
Since: 2.6
</description>
<parameters>
<parameter name="format">
-<parameter_description> a #GdkPixbufFormat
+<parameter_description> a `GdkPixbufFormat`
</parameter_description>
</parameter>
<parameter name="disabled">
-<parameter_description> %TRUE to disable the format @format
+<parameter_description> `TRUE` to disable the format @format
</parameter_description>
</parameter>
</parameters>
@@ -10674,16 +11333,18 @@ Since: 2.6
<function name="gdk_pixbuf_from_pixdata">
<description>
-Converts a #GdkPixdata to a #GdkPixbuf. If @copy_pixels is %TRUE or
-if the pixel data is run-length-encoded, the pixel data is copied into
-newly-allocated memory; otherwise it is reused.
+Converts a `GdkPixdata` to a `GdkPixbuf`.
-Deprecated: 2.32: Use #GResource instead.
+If `copy_pixels` is `TRUE` or if the pixel data is run-length-encoded,
+the pixel data is copied into newly-allocated memory; otherwise it is
+reused.
+
+Deprecated: 2.32: Use `GResource` instead.
</description>
<parameters>
<parameter name="pixdata">
-<parameter_description> a #GdkPixdata to convert into a #GdkPixbuf.
+<parameter_description> a #GdkPixdata to convert into a `GdkPixbuf`.
</parameter_description>
</parameter>
<parameter name="copy_pixels">
@@ -10696,7 +11357,8 @@ pixel data is always copied.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkPixbuf.
+<return> a new pixbuf
+
</return>
</function>
@@ -10763,20 +11425,16 @@ Since: 2.4
</parameter_description>
</parameter>
<parameter name="width">
-<parameter_description> Return location for the width of the
-image, or %NULL
+<parameter_description> Return location for the width of the image
</parameter_description>
</parameter>
<parameter name="height">
-<parameter_description> Return location for the height of the
-image, or %NULL
+<parameter_description> Return location for the height of the image
</parameter_description>
</parameter>
</parameters>
-<return> A #GdkPixbufFormat describing
-the image format of the file or %NULL if the image format wasn't
-recognized. The return value is owned by #GdkPixbuf and should
-not be freed.
+<return> A `GdkPixbufFormat` describing
+the image format of the file
</return>
</function>
@@ -10802,11 +11460,11 @@ Since: 2.32
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<parameter_description> optional `GCancellable` object, `NULL` to ignore
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when the file info is available
+<parameter_description> a `GAsyncReadyCallback` to call when the file info is available
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -10827,26 +11485,24 @@ Since: 2.32
</description>
<parameters>
<parameter name="async_result">
-<parameter_description> a #GAsyncResult
+<parameter_description> a `GAsyncResult`
</parameter_description>
</parameter>
<parameter name="width">
-<parameter_description> Return location for the width of the image, or %NULL
+<parameter_description> Return location for the width of the image, or `NULL`
</parameter_description>
</parameter>
<parameter name="height">
-<parameter_description> Return location for the height of the image, or %NULL
+<parameter_description> Return location for the height of the image, or `NULL`
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError, or %NULL
+<parameter_description> a `GError`, or `NULL`
</parameter_description>
</parameter>
</parameters>
-<return> A #GdkPixbufFormat describing the image
-format of the file or %NULL if the image format wasn't
-recognized. The return value is owned by GdkPixbuf and should
-not be freed.
+<return> A `GdkPixbufFormat` describing the
+image format of the file
</return>
</function>
@@ -10862,18 +11518,17 @@ Since: 2.2
<parameters>
</parameters>
<return> A list of
-#GdkPixbufFormats describing the supported image formats. The list should
-be freed when it is no longer needed, but the structures themselves are
-owned by #GdkPixbuf and should not be freed.
+support image formats.
</return>
</function>
<function name="gdk_pixbuf_get_from_surface">
<description>
-Transfers image data from a #cairo_surface_t and converts it to an RGB(A)
-representation inside a #GdkPixbuf. This allows you to efficiently read
-individual pixels from cairo surfaces.
+Transfers image data from a `cairo_surface_t` and converts it
+to a `GdkPixbuf`.
+
+This allows you to efficiently read individual pixels from cairo surfaces.
This function will create an RGB pixbuf with 8 bits per channel.
The pixbuf will contain an alpha channel if the @surface contains one.
@@ -10909,15 +11564,17 @@ reference count of 1, or %NULL on error
<function name="gdk_pixbuf_get_from_texture">
<description>
-Creates a new pixbuf from @texture. This should generally not be used
-in newly written code as later stages will almost certainly convert
-the pixbuf back into a texture to draw it on screen.
+Creates a new pixbuf from @texture.
+
+This should generally not be used in newly written code as later
+stages will almost certainly convert the pixbuf back into a texture
+to draw it on screen.
</description>
<parameters>
<parameter name="texture">
-<parameter_description> a #GdkTexture
+<parameter_description> a `GdkTexture`
</parameter_description>
</parameter>
</parameters>
@@ -10938,7 +11595,7 @@ Queries whether a pixbuf has an alpha channel (opacity information).
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if it has an alpha channel, %FALSE otherwise.
+<return> `TRUE` if it has an alpha channel, `FALSE` otherwise.
</return>
</function>
@@ -10996,7 +11653,7 @@ EXIF tag.
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
+<parameter_description> a `GdkPixbuf`
</parameter_description>
</parameter>
<parameter name="key">
@@ -11004,29 +11661,27 @@ EXIF tag.
</parameter_description>
</parameter>
</parameters>
-<return> the value associated with @key. This is a nul-terminated
-string that should not be freed or %NULL if @key was not found.
+<return> the value associated with `key`
</return>
</function>
<function name="gdk_pixbuf_get_options">
<description>
-Returns a #GHashTable with a list of all the options that may have been
-attached to the @pixbuf when it was loaded, or that may have been
-attached by another function using gdk_pixbuf_set_option().
-
-See gdk_pixbuf_get_option() for more details.
+Returns a `GHashTable` with a list of all the options that may have been
+attached to the `pixbuf` when it was loaded, or that may have been
+attached by another function using [method@GdkPixbuf.Pixbuf.set_option].
Since: 2.32
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
+<parameter_description> a `GdkPixbuf`
</parameter_description>
</parameter>
</parameters>
-<return> a #GHashTable of key/values
+<return> a #GHashTable
+of key/values pairs
</return>
</function>
@@ -11035,6 +11690,12 @@ Since: 2.32
<description>
Queries a pointer to the pixel data of a pixbuf.
+This function will cause an implicit copy of the pixbuf data if the
+pixbuf was created from read-only data.
+
+Please see the section on [image data](class.Pixbuf.html#image-data) for information
+about how the pixel data is stored in memory.
+
</description>
<parameters>
@@ -11044,11 +11705,6 @@ Queries a pointer to the pixel data of a pixbuf.
</parameter>
</parameters>
<return> A pointer to the pixbuf's pixel data.
-Please see the section on [image data][image-data] for information
-about how the pixel data is stored in memory.
-
-This function will cause an implicit copy of the pixbuf data if the
-pixbuf was created from read-only data.
</return>
</function>
@@ -11056,6 +11712,12 @@ pixbuf was created from read-only data.
<description>
Queries a pointer to the pixel data of a pixbuf.
+This function will cause an implicit copy of the pixbuf data if the
+pixbuf was created from read-only data.
+
+Please see the section on [image data](class.Pixbuf.html#image-data) for information
+about how the pixel data is stored in memory.
+
Since: 2.26
</description>
@@ -11070,11 +11732,7 @@ Since: 2.26
</parameter>
</parameters>
<return> A pointer to the pixbuf's
-pixel data. Please see the section on [image data][image-data]
-for information about how the pixel data is stored in memory.
-
-This function will cause an implicit copy of the pixbuf data if the
-pixbuf was created from read-only data.
+pixel data.
</return>
</function>
@@ -11114,7 +11772,7 @@ Queries the width of a pixbuf.
<function name="gdk_pixbuf_init_modules">
<description>
-Initalizes the gdk-pixbuf loader modules referenced by the loaders.cache
+Initalizes the gdk-pixbuf loader modules referenced by the `loaders.cache`
file present inside that directory.
This is to be used by applications that want to ship certain loaders
@@ -11133,11 +11791,11 @@ Since: 2.40
</description>
<parameters>
<parameter name="path">
-<parameter_description> Path to directory where the loaders.cache is installed
+<parameter_description> Path to directory where the `loaders.cache` is installed
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter_description> return location for a `GError`
</parameter_description>
</parameter>
</parameters>
@@ -11148,16 +11806,19 @@ Since: 2.40
<description>
Informs a pixbuf loader that no further writes with
gdk_pixbuf_loader_write() will occur, so that it can free its
-internal loading structures. Also, tries to parse any data that
-hasn't yet been parsed; if the remaining data is partial or
-corrupt, an error will be returned. If %FALSE is returned, @error
-will be set to an error from the #GDK_PIXBUF_ERROR or #G_FILE_ERROR
-domains. If you're just cancelling a load rather than expecting it
-to be finished, passing %NULL for @error to ignore it is
-reasonable.
+internal loading structures.
+
+This function also tries to parse any data that hasn't yet been parsed;
+if the remaining data is partial or corrupt, an error will be returned.
+
+If `FALSE` is returned, `error` will be set to an error from the
+`GDK_PIXBUF_ERROR` or `G_FILE_ERROR` domains.
-Remember that this does not unref the loader, so if you plan not to
-use it anymore, please g_object_unref() it.
+If you're just cancelling a load rather than expecting it to be finished,
+passing `NULL` for `error` to ignore it is reasonable.
+
+Remember that this function does not release a reference on the loader, so
+you will need to explicitly release any reference you hold.
</description>
@@ -11167,22 +11828,25 @@ use it anymore, please g_object_unref() it.
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL to ignore errors
+<parameter_description> return location for a #GError, or `NULL` to ignore errors
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if all image data written so far was successfully
- passed out via the update_area signal
+<return> `TRUE` if all image data written so far was successfully
+passed out via the update_area signal
</return>
</function>
<function name="gdk_pixbuf_loader_get_animation">
<description>
Queries the #GdkPixbufAnimation that a pixbuf loader is currently creating.
-In general it only makes sense to call this function after the "area-prepared"
-signal has been emitted by the loader. If the loader doesn't have enough
-bytes yet (hasn't emitted the "area-prepared" signal) this function will
-return %NULL.
+
+In general it only makes sense to call this function after the
+[signal@GdkPixbuf.PixbufLoader::area-prepared] signal has been emitted by
+the loader.
+
+If the loader doesn't have enough bytes yet, and hasn't emitted the `area-prepared`
+signal, this function will return `NULL`.
</description>
@@ -11192,8 +11856,8 @@ return %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> The #GdkPixbufAnimation that the loader is loading, or %NULL if
-not enough data has been read to determine the information.
+<return> The animation that the loader is
+currently loading
</return>
</function>
@@ -11211,9 +11875,7 @@ Since: 2.2
</parameter_description>
</parameter>
</parameters>
-<return> A #GdkPixbufFormat or
-%NULL. The return value is owned by GdkPixbuf and should not be
-freed.
+<return> A #GdkPixbufFormat
</return>
</function>
@@ -11221,16 +11883,20 @@ freed.
<function name="gdk_pixbuf_loader_get_pixbuf">
<description>
Queries the #GdkPixbuf that a pixbuf loader is currently creating.
+
In general it only makes sense to call this function after the
-"area-prepared" signal has been emitted by the loader; this means
-that enough data has been read to know the size of the image that
-will be allocated. If the loader has not received enough data via
-gdk_pixbuf_loader_write(), then this function returns %NULL. The
-returned pixbuf will be the same in all future calls to the loader,
-so simply calling g_object_ref() should be sufficient to continue
-using it. Additionally, if the loader is an animation, it will
-return the "static image" of the animation
-(see gdk_pixbuf_animation_get_static_image()).
+[signal@GdkPixbuf.PixbufLoader::area-prepared] signal has been
+emitted by the loader; this means that enough data has been read
+to know the size of the image that will be allocated.
+
+If the loader has not received enough data via gdk_pixbuf_loader_write(),
+then this function returns `NULL`.
+
+The returned pixbuf will be the same in all future calls to the loader,
+so if you want to keep using it, you should acquire a reference to it.
+
+Additionally, if the loader is an animation, it will return the "static
+image" of the animation (see gdk_pixbuf_animation_get_static_image()).
</description>
@@ -11240,8 +11906,8 @@ return the "static image" of the animation
</parameter_description>
</parameter>
</parameters>
-<return> The #GdkPixbuf that the loader is creating, or %NULL if not
-enough data has been read to determine how to create the image buffer.
+<return> The pixbuf that the loader is
+creating
</return>
</function>
@@ -11260,11 +11926,13 @@ Creates a new pixbuf loader object.
<function name="gdk_pixbuf_loader_new_with_mime_type">
<description>
Creates a new pixbuf loader object that always attempts to parse
-image data as if it were an image of mime type @mime_type, instead of
-identifying the type automatically. Useful if you want an error if
-the image isn't the expected mime type, for loading image formats
-that can't be reliably identified by looking at the data, or if
-the user manually forces a specific mime type.
+image data as if it were an image of MIME type @mime_type, instead of
+identifying the type automatically.
+
+This function is useful if you want an error if the image isn't the
+expected MIME type; for loading image formats that can't be reliably
+identified by looking at the data; or if the user manually forces a
+specific MIME type.
The list of supported mime types depends on what image loaders
are installed, but typically "image/png", "image/jpeg", "image/gif",
@@ -11282,11 +11950,12 @@ Since: 2.4
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for an allocated #GError, or %NULL to ignore errors
+<parameter_description> return location for an allocated #GError, or `NULL` to ignore errors
</parameter_description>
</parameter>
</parameters>
<return> A newly-created pixbuf loader.
+
</return>
</function>
@@ -11294,10 +11963,12 @@ Since: 2.4
<description>
Creates a new pixbuf loader object that always attempts to parse
image data as if it were an image of type @image_type, instead of
-identifying the type automatically. Useful if you want an error if
-the image isn't the expected type, for loading image formats
-that can't be reliably identified by looking at the data, or if
-the user manually forces a specific type.
+identifying the type automatically.
+
+This function is useful if you want an error if the image isn't the
+expected type; for loading image formats that can't be reliably
+identified by looking at the data; or if the user manually forces
+a specific type.
The list of supported image formats depends on what image loaders
are installed, but typically "png", "jpeg", "gif", "tiff" and
@@ -11313,7 +11984,7 @@ of the #GdkPixbufFormat structs returned by gdk_pixbuf_get_formats().
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for an allocated #GError, or %NULL to ignore errors
+<parameter_description> return location for an allocated #GError, or `NULL` to ignore errors
</parameter_description>
</parameter>
</parameters>
@@ -11323,9 +11994,10 @@ of the #GdkPixbufFormat structs returned by gdk_pixbuf_get_formats().
<function name="gdk_pixbuf_loader_set_size">
<description>
-Causes the image to be scaled while it is loaded. The desired
-image size can be determined relative to the original size of
-the image by calling gdk_pixbuf_loader_set_size() from a
+Causes the image to be scaled while it is loaded.
+
+The desired image size can be determined relative to the original
+size of the image by calling gdk_pixbuf_loader_set_size() from a
signal handler for the ::size-prepared signal.
Attempts to set the desired image size are ignored after the
@@ -11353,12 +12025,7 @@ Since: 2.2
<function name="gdk_pixbuf_loader_write">
<description>
-This will cause a pixbuf loader to parse the next @count bytes of
-an image. It will return %TRUE if the data was loaded successfully,
-and %FALSE if an error occurred. In the latter case, the loader
-will be closed, and will not accept further writes. If %FALSE is
-returned, @error will be set to an error from the #GDK_PIXBUF_ERROR
-or #G_FILE_ERROR domains.
+Parses the next `count` bytes in the given image buffer.
</description>
@@ -11380,21 +12047,14 @@ or #G_FILE_ERROR domains.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the write was successful, or %FALSE if the loader
-cannot parse the buffer.
+<return> `TRUE` if the write was successful, or
+`FALSE` if the loader cannot parse the buffer
</return>
</function>
<function name="gdk_pixbuf_loader_write_bytes">
<description>
-This will cause a pixbuf loader to parse a buffer inside a #GBytes
-for an image. It will return %TRUE if the data was loaded successfully,
-and %FALSE if an error occurred. In the latter case, the loader
-will be closed, and will not accept further writes. If %FALSE is
-returned, @error will be set to an error from the #GDK_PIXBUF_ERROR
-or #G_FILE_ERROR domains.
-
-See also: gdk_pixbuf_loader_write()
+Parses the next contents of the given image buffer.
Since: 2.30
@@ -11405,7 +12065,7 @@ Since: 2.30
</parameter_description>
</parameter>
<parameter name="buffer">
-<parameter_description> The image data as a #GBytes
+<parameter_description> The image data as a `GBytes` buffer.
</parameter_description>
</parameter>
<parameter name="error">
@@ -11413,8 +12073,8 @@ Since: 2.30
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the write was successful, or %FALSE if the loader
-cannot parse the buffer.
+<return> `TRUE` if the write was successful, or `FALSE` if
+the loader cannot parse the buffer
</return>
</function>
@@ -11427,7 +12087,7 @@ gdk-pixbuf version 1.2.5 this is 1.)
This variable is in the library, so represents the
gdk-pixbuf library you have linked against. Contrast with the
-#GDK_PIXBUF_MAJOR macro, which represents the major version of the
+`GDK_PIXBUF_MAJOR` macro, which represents the major version of the
gdk-pixbuf headers you have included.
</description>
@@ -11444,7 +12104,7 @@ gdk-pixbuf version 1.2.5 this is 5.)
This variable is in the library, so represents the
gdk-pixbuf library you have linked against. Contrast with the
-#GDK_PIXBUF_MICRO macro, which represents the micro version of the
+`GDK_PIXBUF_MICRO` macro, which represents the micro version of the
gdk-pixbuf headers you have included.
</description>
@@ -11461,7 +12121,7 @@ gdk-pixbuf version 1.2.5 this is 2.)
This variable is in the library, so represents the
gdk-pixbuf library you have linked against. Contrast with the
-#GDK_PIXBUF_MINOR macro, which represents the minor version of the
+`GDK_PIXBUF_MINOR` macro, which represents the minor version of the
gdk-pixbuf headers you have included.
</description>
@@ -11472,8 +12132,11 @@ gdk-pixbuf headers you have included.
<function name="gdk_pixbuf_new">
<description>
-Creates a new #GdkPixbuf structure and allocates a buffer for it. The
-buffer has an optimal rowstride. Note that the buffer is not cleared;
+Creates a new `GdkPixbuf` structure and allocates a buffer for it.
+
+If the allocation of the buffer failed, this function will return `NULL`.
+
+The buffer has an optimal rowstride. Note that the buffer is not cleared;
you will have to fill it completely yourself.
@@ -11500,16 +12163,18 @@ you will have to fill it completely yourself.
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created #GdkPixbuf with a reference count of 1, or
-%NULL if not enough memory could be allocated for the image buffer.
+<return> A newly-created pixel buffer
</return>
</function>
<function name="gdk_pixbuf_new_from_bytes">
<description>
Creates a new #GdkPixbuf out of in-memory readonly image data.
+
Currently only RGB images with 8 bits per sample are supported.
-This is the #GBytes variant of gdk_pixbuf_new_from_data().
+
+This is the `GBytes` variant of gdk_pixbuf_new_from_data(), useful
+for language bindings.
Since: 2.32
@@ -11544,22 +12209,24 @@ Since: 2.32
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created #GdkPixbuf structure with a reference count of 1.
+<return> A newly-created pixbuf
+
</return>
</function>
<function name="gdk_pixbuf_new_from_data">
<description>
-Creates a new #GdkPixbuf out of in-memory image data. Currently only RGB
-images with 8 bits per sample are supported.
+Creates a new #GdkPixbuf out of in-memory image data.
+
+Currently only RGB images with 8 bits per sample are supported.
Since you are providing a pre-allocated pixel buffer, you must also
specify a way to free that data. This is done with a function of
-type #GdkPixbufDestroyNotify. When a pixbuf created with is
+type `GdkPixbufDestroyNotify`. When a pixbuf created with is
finalized, your destroy notification function will be called, and
it is its responsibility to free the pixel array.
-See also gdk_pixbuf_new_from_bytes().
+See also: [ctor@GdkPixbuf.Pixbuf.new_from_bytes]
</description>
@@ -11602,15 +12269,24 @@ drops to zero, or %NULL if the data should not be freed
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created #GdkPixbuf structure with a reference count of 1.
+<return> A newly-created pixbuf
</return>
</function>
<function name="gdk_pixbuf_new_from_file">
<description>
-Creates a new pixbuf by loading an image from a file. The file format is
-detected automatically. If %NULL is returned, then @error will be set.
-Possible errors are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.
+Creates a new pixbuf by loading an image from a file.
+
+The file format is detected automatically.
+
+If `NULL` is returned, then @error will be set. Possible errors are:
+
+- the file could not be opened
+- there is no loader for the file's format
+- there is not enough memory to allocate the image buffer
+- the image buffer contains invalid data
+
+The error domains are `GDK_PIXBUF_ERROR` and `G_FILE_ERROR`.
</description>
@@ -11625,26 +12301,33 @@ name encoding
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created pixbuf with a reference count of 1, or %NULL if
-any of several error conditions occurred: the file could not be opened,
-there was no loader for the file's format, there was not enough memory to
-allocate the image buffer, or the image file contained invalid data.
+<return> A newly-created pixbuf
</return>
</function>
<function name="gdk_pixbuf_new_from_file_at_scale">
<description>
-Creates a new pixbuf by loading an image from a file. The file format is
-detected automatically. If %NULL is returned, then @error will be set.
-Possible errors are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.
+Creates a new pixbuf by loading an image from a file.
+
+The file format is detected automatically.
+
+If `NULL` is returned, then @error will be set. Possible errors are:
+
+- the file could not be opened
+- there is no loader for the file's format
+- there is not enough memory to allocate the image buffer
+- the image buffer contains invalid data
+
+The error domains are `GDK_PIXBUF_ERROR` and `G_FILE_ERROR`.
+
The image will be scaled to fit in the requested size, optionally preserving
the image's aspect ratio.
-When preserving the aspect ratio, a @width of -1 will cause the image
-to be scaled to the exact given height, and a @height of -1 will cause
+When preserving the aspect ratio, a `width` of -1 will cause the image
+to be scaled to the exact given height, and a `height` of -1 will cause
the image to be scaled to the exact given width. When not preserving
-aspect ratio, a @width or @height of -1 means to not scale the image
-at all in that dimension. Negative values for @width and @height are
+aspect ratio, a `width` or `height` of -1 means to not scale the image
+at all in that dimension. Negative values for `width` and `height` are
allowed since 2.8.
Since: 2.6
@@ -11665,7 +12348,7 @@ name encoding
</parameter_description>
</parameter>
<parameter name="preserve_aspect_ratio">
-<parameter_description> %TRUE to preserve the image's aspect ratio
+<parameter_description> `TRUE` to preserve the image's aspect ratio
</parameter_description>
</parameter>
<parameter name="error">
@@ -11673,10 +12356,7 @@ name encoding
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created pixbuf with a reference count of 1, or %NULL
-if any of several error conditions occurred: the file could not be opened,
-there was no loader for the file's format, there was not enough memory to
-allocate the image buffer, or the image file contained invalid data.
+<return> A newly-created pixbuf
</return>
</function>
@@ -11702,7 +12382,7 @@ Since: 2.6
</parameter_description>
</parameter>
<parameter name="preserve_aspect_ratio">
-<parameter_description> %TRUE to preserve the image's aspect ratio
+<parameter_description> `TRUE` to preserve the image's aspect ratio
</parameter_description>
</parameter>
<parameter name="error">
@@ -11710,7 +12390,7 @@ Since: 2.6
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created pixbuf with a reference count of 1, or %NULL
+<return> A newly-created pixbuf with a reference count of 1, or `NULL`
if any of several error conditions occurred: the file could not be opened,
there was no loader for the file's format, there was not enough memory to
allocate the image buffer, or the image file contained invalid data.
@@ -11720,16 +12400,24 @@ allocate the image buffer, or the image file contained invalid data.
<function name="gdk_pixbuf_new_from_file_at_size">
<description>
-Creates a new pixbuf by loading an image from a file.
-The file format is detected automatically. If %NULL is returned, then
-@error will be set. Possible errors are in the #GDK_PIXBUF_ERROR and
-#G_FILE_ERROR domains.
+Creates a new pixbuf by loading an image from a file.
+
+The file format is detected automatically.
+
+If `NULL` is returned, then @error will be set. Possible errors are:
+
+- the file could not be opened
+- there is no loader for the file's format
+- there is not enough memory to allocate the image buffer
+- the image buffer contains invalid data
+
+The error domains are `GDK_PIXBUF_ERROR` and `G_FILE_ERROR`.
The image will be scaled to fit in the requested size, preserving
the image's aspect ratio. Note that the returned pixbuf may be smaller
-than @width x @height, if the aspect ratio requires it. To load
+than `width` x `height`, if the aspect ratio requires it. To load
and image at the requested size, regardless of aspect ratio, use
-gdk_pixbuf_new_from_file_at_scale().
+[ctor@GdkPixbuf.Pixbuf.new_from_file_at_scale].
Since: 2.4
@@ -11753,11 +12441,7 @@ name encoding
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created pixbuf with a reference count of 1, or
-%NULL if any of several error conditions occurred: the file could not
-be opened, there was no loader for the file's format, there was not
-enough memory to allocate the image buffer, or the image file contained
-invalid data.
+<return> A newly-created pixbuf
</return>
</function>
@@ -11788,7 +12472,7 @@ Since: 2.4
</parameter>
</parameters>
<return> A newly-created pixbuf with a reference count of 1, or
-%NULL if any of several error conditions occurred: the file could not
+`NULL` if any of several error conditions occurred: the file could not
be opened, there was no loader for the file's format, there was not
enough memory to allocate the image buffer, or the image file contained
invalid data.
@@ -11812,7 +12496,7 @@ Same as gdk_pixbuf_new_from_file()
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created pixbuf with a reference count of 1, or %NULL if
+<return> A newly-created pixbuf with a reference count of 1, or `NULL` if
any of several error conditions occurred: the file could not be opened,
there was no loader for the file's format, there was not enough memory to
allocate the image buffer, or the image file contained invalid data.
@@ -11821,63 +12505,65 @@ allocate the image buffer, or the image file contained invalid data.
<function name="gdk_pixbuf_new_from_inline">
<description>
-Create a #GdkPixbuf from a flat representation that is suitable for
-storing as inline data in a program. This is useful if you want to
-ship a program with images, but don't want to depend on any
-external files.
+Creates a `GdkPixbuf` from a flat representation that is suitable for
+storing as inline data in a program.
+
+This is useful if you want to ship a program with images, but don't want
+to depend on any external files.
+
+GdkPixbuf ships with a program called `gdk-pixbuf-csource`, which allows
+for conversion of `GdkPixbuf`s into such a inline representation.
-gdk-pixbuf ships with a program called [gdk-pixbuf-csource][gdk-pixbuf-csource],
-which allows for conversion of #GdkPixbufs into such a inline representation.
In almost all cases, you should pass the `--raw` option to
`gdk-pixbuf-csource`. A sample invocation would be:
-|[
+```
gdk-pixbuf-csource --raw --name=myimage_inline myimage.png
-]|
+```
For the typical case where the inline pixbuf is read-only static data,
you don't need to copy the pixel data unless you intend to write to
-it, so you can pass %FALSE for @copy_pixels. (If you pass `--rle` to
-`gdk-pixbuf-csource`, a copy will be made even if @copy_pixels is %FALSE,
-so using this option is generally a bad idea.)
+it, so you can pass `FALSE` for `copy_pixels`. If you pass `--rle` to
+`gdk-pixbuf-csource`, a copy will be made even if `copy_pixels` is `FALSE`,
+so using this option is generally a bad idea.
If you create a pixbuf from const inline data compiled into your
program, it's probably safe to ignore errors and disable length checks,
since things will always succeed:
-|[
+
+```c
pixbuf = gdk_pixbuf_new_from_inline (-1, myimage_inline, FALSE, NULL);
-]|
+```
For non-const inline data, you could get out of memory. For untrusted
inline data located at runtime, you could have corrupt inline data in
addition.
-Deprecated: 2.32: Use #GResource instead.
+Deprecated: 2.32: Use `GResource` instead.
</description>
<parameters>
<parameter name="data_length">
-<parameter_description> Length in bytes of the @data argument or -1 to
+<parameter_description> Length in bytes of the `data` argument or -1 to
disable length checks
</parameter_description>
</parameter>
<parameter name="data">
<parameter_description> Byte data containing a
-serialized #GdkPixdata structure
+serialized `GdkPixdata` structure
</parameter_description>
</parameter>
<parameter name="copy_pixels">
<parameter_description> Whether to copy the pixel data, or use direct pointers
-@data for the resulting pixbuf
+`data` for the resulting pixbuf
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> #GError return location, may be %NULL to ignore errors
+<parameter_description> #GError return location, may be `NULL` to ignore errors
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created #GdkPixbuf structure with a reference,
-count of 1, or %NULL if an error occurred.
+<return> A newly-created pixbuf
</return>
</function>
@@ -11886,7 +12572,7 @@ count of 1, or %NULL if an error occurred.
<description>
Creates a new pixbuf by loading an image from an resource.
-The file format is detected automatically. If %NULL is returned, then
+The file format is detected automatically. If `NULL` is returned, then
@error will be set.
Since: 2.26
@@ -11902,10 +12588,7 @@ Since: 2.26
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created pixbuf, or %NULL if any of several error
-conditions occurred: the file could not be opened, the image format is
-not supported, there was not enough memory to allocate the image buffer,
-the stream contained invalid data, or the operation was cancelled.
+<return> A newly-created pixbuf
</return>
</function>
@@ -11914,7 +12597,7 @@ the stream contained invalid data, or the operation was cancelled.
<description>
Creates a new pixbuf by loading an image from an resource.
-The file format is detected automatically. If %NULL is returned, then
+The file format is detected automatically. If `NULL` is returned, then
@error will be set.
The image will be scaled to fit in the requested size, optionally
@@ -11943,7 +12626,7 @@ Since: 2.26
</parameter_description>
</parameter>
<parameter name="preserve_aspect_ratio">
-<parameter_description> %TRUE to preserve the image's aspect ratio
+<parameter_description> `TRUE` to preserve the image's aspect ratio
</parameter_description>
</parameter>
<parameter name="error">
@@ -11951,10 +12634,7 @@ Since: 2.26
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created pixbuf, or %NULL if any of several error
-conditions occurred: the file could not be opened, the image format is
-not supported, there was not enough memory to allocate the image buffer,
-the stream contained invalid data, or the operation was cancelled.
+<return> A newly-created pixbuf
</return>
</function>
@@ -11963,11 +12643,14 @@ the stream contained invalid data, or the operation was cancelled.
<description>
Creates a new pixbuf by loading an image from an input stream.
-The file format is detected automatically. If %NULL is returned, then
-@error will be set. The @cancellable can be used to abort the operation
-from another thread. If the operation was cancelled, the error
-%G_IO_ERROR_CANCELLED will be returned. Other possible errors are in
-the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains.
+The file format is detected automatically.
+
+If `NULL` is returned, then `error` will be set.
+
+The `cancellable` can be used to abort the operation from another thread.
+If the operation was cancelled, the error `G_IO_ERROR_CANCELLED` will be
+returned. Other possible errors are in the `GDK_PIXBUF_ERROR` and
+`G_IO_ERROR` domains.
The stream is not closed.
@@ -11976,11 +12659,11 @@ Since: 2.14
</description>
<parameters>
<parameter name="stream">
-<parameter_description> a #GInputStream to load the pixbuf from
+<parameter_description> a `GInputStream` to load the pixbuf from
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<parameter_description> optional `GCancellable` object, `NULL` to ignore
</parameter_description>
</parameter>
<parameter name="error">
@@ -11988,10 +12671,7 @@ Since: 2.14
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created pixbuf, or %NULL if any of several error
-conditions occurred: the file could not be opened, the image format is
-not supported, there was not enough memory to allocate the image buffer,
-the stream contained invalid data, or the operation was cancelled.
+<return> A newly-created pixbuf
</return>
</function>
@@ -12004,22 +12684,23 @@ For more details see gdk_pixbuf_new_from_stream(), which is the synchronous
version of this function.
When the operation is finished, @callback will be called in the main thread.
-You can then call gdk_pixbuf_new_from_stream_finish() to get the result of the operation.
+You can then call gdk_pixbuf_new_from_stream_finish() to get the result of
+the operation.
Since: 2.24
</description>
<parameters>
<parameter name="stream">
-<parameter_description> a #GInputStream from which to load the pixbuf
+<parameter_description> a `GInputStream` from which to load the pixbuf
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<parameter_description> optional `GCancellable` object, `NULL` to ignore
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when the pixbuf is loaded
+<parameter_description> a `GAsyncReadyCallback` to call when the pixbuf is loaded
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -12034,22 +12715,22 @@ Since: 2.24
<description>
Creates a new pixbuf by loading an image from an input stream.
-The file format is detected automatically. If %NULL is returned, then
+The file format is detected automatically. If `NULL` is returned, then
@error will be set. The @cancellable can be used to abort the operation
from another thread. If the operation was cancelled, the error
-%G_IO_ERROR_CANCELLED will be returned. Other possible errors are in
-the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains.
+`G_IO_ERROR_CANCELLED` will be returned. Other possible errors are in
+the `GDK_PIXBUF_ERROR` and `G_IO_ERROR` domains.
The image will be scaled to fit in the requested size, optionally
preserving the image's aspect ratio.
-When preserving the aspect ratio, a @width of -1 will cause the image to be
-scaled to the exact given height, and a @height of -1 will cause the image
-to be scaled to the exact given width. If both @width and @height are
+When preserving the aspect ratio, a `width` of -1 will cause the image to be
+scaled to the exact given height, and a `height` of -1 will cause the image
+to be scaled to the exact given width. If both `width` and `height` are
given, this function will behave as if the smaller of the two values
is passed as -1.
-When not preserving aspect ratio, a @width or @height of -1 means to not
+When not preserving aspect ratio, a `width` or `height` of -1 means to not
scale the image at all in that dimension.
The stream is not closed.
@@ -12059,7 +12740,7 @@ Since: 2.14
</description>
<parameters>
<parameter name="stream">
-<parameter_description> a #GInputStream to load the pixbuf from
+<parameter_description> a `GInputStream` to load the pixbuf from
</parameter_description>
</parameter>
<parameter name="width">
@@ -12071,11 +12752,11 @@ Since: 2.14
</parameter_description>
</parameter>
<parameter name="preserve_aspect_ratio">
-<parameter_description> %TRUE to preserve the image's aspect ratio
+<parameter_description> `TRUE` to preserve the image's aspect ratio
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<parameter_description> optional `GCancellable` object, `NULL` to ignore
</parameter_description>
</parameter>
<parameter name="error">
@@ -12083,10 +12764,7 @@ Since: 2.14
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created pixbuf, or %NULL if any of several error
-conditions occurred: the file could not be opened, the image format is
-not supported, there was not enough memory to allocate the image buffer,
-the stream contained invalid data, or the operation was cancelled.
+<return> A newly-created pixbuf
</return>
</function>
@@ -12106,7 +12784,7 @@ Since: 2.24
</description>
<parameters>
<parameter name="stream">
-<parameter_description> a #GInputStream from which to load the pixbuf
+<parameter_description> a `GInputStream` from which to load the pixbuf
</parameter_description>
</parameter>
<parameter name="width">
@@ -12118,15 +12796,15 @@ Since: 2.24
</parameter_description>
</parameter>
<parameter name="preserve_aspect_ratio">
-<parameter_description> %TRUE to preserve the image's aspect ratio
+<parameter_description> `TRUE` to preserve the image's aspect ratio
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<parameter_description> optional `GCancellable` object, `NULL` to ignore
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when the pixbuf is loaded
+<parameter_description> a `GAsyncReadyCallback` to call when the pixbuf is loaded
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -12147,24 +12825,25 @@ Since: 2.24
</description>
<parameters>
<parameter name="async_result">
-<parameter_description> a #GAsyncResult
+<parameter_description> a `GAsyncResult`
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError, or %NULL
+<parameter_description> a `GError`, or `NULL`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkPixbuf or %NULL on error. Free the returned
-object with g_object_unref().
+<return> the newly created pixbuf
</return>
</function>
<function name="gdk_pixbuf_new_from_xpm_data">
<description>
-Creates a new pixbuf by parsing XPM data in memory. This data is commonly
-the result of including an XPM file into a program's C source.
+Creates a new pixbuf by parsing XPM data in memory.
+
+This data is commonly the result of including an XPM file into a
+program's C source.
</description>
@@ -12174,26 +12853,27 @@ the result of including an XPM file into a program's C source.
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created pixbuf with a reference count of 1.
+<return> A newly-created pixbuf
</return>
</function>
<function name="gdk_pixbuf_new_subpixbuf">
<description>
-Creates a new pixbuf which represents a sub-region of @src_pixbuf.
+Creates a new pixbuf which represents a sub-region of `src_pixbuf`.
+
The new pixbuf shares its pixels with the original pixbuf, so
writing to one affects both. The new pixbuf holds a reference to
-@src_pixbuf, so @src_pixbuf will not be finalized until the new
+`src_pixbuf`, so `src_pixbuf` will not be finalized until the new
pixbuf is finalized.
-Note that if @src_pixbuf is read-only, this function will force it
+Note that if `src_pixbuf` is read-only, this function will force it
to be mutable.
</description>
<parameters>
<parameter name="src_pixbuf">
-<parameter_description> a #GdkPixbuf
+<parameter_description> a `GdkPixbuf`
</parameter_description>
</parameter>
<parameter name="src_x">
@@ -12220,9 +12900,10 @@ to be mutable.
<function name="gdk_pixbuf_read_pixel_bytes">
<description>
Provides a #GBytes buffer containing the raw pixel data; the data
-must not be modified. This function allows skipping the implicit
-copy that must be made if gdk_pixbuf_get_pixels() is called on a
-read-only pixbuf.
+must not be modified.
+
+This function allows skipping the implicit copy that must be made
+if gdk_pixbuf_get_pixels() is called on a read-only pixbuf.
Since: 2.32
@@ -12243,10 +12924,10 @@ returned #GBytes.
<function name="gdk_pixbuf_read_pixels">
<description>
-Provides a read-only pointer to the raw pixel data; must not be
-modified. This function allows skipping the implicit copy that
-must be made if gdk_pixbuf_get_pixels() is called on a read-only
-pixbuf.
+Provides a read-only pointer to the raw pixel data.
+
+This function allows skipping the implicit copy that must be made
+if gdk_pixbuf_get_pixels() is called on a read-only pixbuf.
Since: 2.32
@@ -12282,14 +12963,14 @@ Deprecated: 2.0: Use g_object_ref().
<function name="gdk_pixbuf_remove_option">
<description>
-Remove the key/value pair option attached to a #GdkPixbuf.
+Removes the key/value pair option attached to a `GdkPixbuf`.
Since: 2.36
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
+<parameter_description> a `GdkPixbuf`
</parameter_description>
</parameter>
<parameter name="key">
@@ -12297,7 +12978,7 @@ Since: 2.36
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if an option was removed, %FALSE if not.
+<return> `TRUE` if an option was removed, `FALSE` if not.
</return>
</function>
@@ -12307,7 +12988,7 @@ Since: 2.36
Rotates a pixbuf by a multiple of 90 degrees, and returns the
result in a new pixbuf.
-If @angle is 0, a copy of @src is returned, avoiding any rotation.
+If `angle` is 0, this function will return a copy of `src`.
Since: 2.6
@@ -12322,23 +13003,28 @@ Since: 2.6
</parameter_description>
</parameter>
</parameters>
-<return> the new #GdkPixbuf, or %NULL
-if not enough memory could be allocated for it.
+<return> the new pixbuf
</return>
</function>
<function name="gdk_pixbuf_saturate_and_pixelate">
<description>
-Modifies saturation and optionally pixelates @src, placing the result in
-@dest. @src and @dest may be the same pixbuf with no ill effects. If
-@saturation is 1.0 then saturation is not changed. If it's less than 1.0,
-saturation is reduced (the image turns toward grayscale); if greater than
-1.0, saturation is increased (the image gets more vivid colors). If @pixelate
-is %TRUE, then pixels are faded in a checkerboard pattern to create a
-pixelated image. @src and @dest must have the same image format, size, and
+Modifies saturation and optionally pixelates `src`, placing the result in
+`dest`.
+
+The `src` and `dest` pixbufs must have the same image format, size, and
rowstride.
+The `src` and `dest` arguments may be the same pixbuf with no ill effects.
+
+If `saturation` is 1.0 then saturation is not changed. If it's less than 1.0,
+saturation is reduced (the image turns toward grayscale); if greater than
+1.0, saturation is increased (the image gets more vivid colors).
+
+If `pixelate` is `TRUE`, then pixels are faded in a checkerboard pattern to
+create a pixelated image.
+
</description>
<parameters>
@@ -12369,7 +13055,7 @@ and "bmp" are possible file formats to save in, but more formats may b
installed. The list of all writable formats can be determined in the
following way:
-|[
+```c
void add_if_writable (GdkPixbufFormat *data, GSList **list)
{
if (gdk_pixbuf_format_is_writable (data))
@@ -12380,49 +13066,57 @@ GSList *formats = gdk_pixbuf_get_formats ();
GSList *writable_formats = NULL;
g_slist_foreach (formats, add_if_writable, &writable_formats);
g_slist_free (formats);
-]|
+```
-If @error is set, %FALSE will be returned. Possible errors include
-those in the #GDK_PIXBUF_ERROR domain and those in the #G_FILE_ERROR domain.
+If `error` is set, `FALSE` will be returned. Possible errors include
+those in the `GDK_PIXBUF_ERROR` domain and those in the `G_FILE_ERROR`
+domain.
-The variable argument list should be %NULL-terminated; if not empty,
+The variable argument list should be `NULL`-terminated; if not empty,
it should contain pairs of strings that modify the save
parameters. For example:
-|[
+
+```c
gdk_pixbuf_save (pixbuf, handle, "jpeg", &error, "quality", "100", NULL);
-]|
+```
-Currently only few parameters exist. JPEG images can be saved with a
-"quality" parameter; its value should be in the range [0,100]. JPEG
-and PNG density can be set by setting the "x-dpi" and "y-dpi" parameters
-to the appropriate values in dots per inch.
+Currently only few parameters exist.
+
+JPEG images can be saved with a "quality" parameter; its value should be
+in the range `[0, 100]`. JPEG and PNG density can be set by setting the
+"x-dpi" and "y-dpi" parameters to the appropriate values in dots per inch.
Text chunks can be attached to PNG images by specifying parameters of
the form "tEXt::key", where key is an ASCII string of length 1-79.
The values are UTF-8 encoded strings. The PNG compression level can
be specified using the "compression" parameter; it's value is in an
-integer in the range of [0,9].
+integer in the range of `[0, 9]`.
ICC color profiles can also be embedded into PNG, JPEG and TIFF images.
The "icc-profile" value should be the complete ICC profile encoded
into base64.
-|[
-gchar *contents;
-gchar *contents_encode;
+```c
+char *contents;
gsize length;
-g_file_get_contents ("/home/hughsie/.color/icc/L225W.icm", &contents, &length, NULL);
-contents_encode = g_base64_encode ((const guchar *) contents, length);
+
+// icm_path is set elsewhere
+g_file_get_contents (icm_path, &contents, &length, NULL);
+
+char *contents_encode = g_base64_encode ((const guchar *) contents, length);
+
gdk_pixbuf_save (pixbuf, handle, "png", &error, "icc-profile", contents_encode,
NULL);
-]|
+```
+
+TIFF images recognize:
-TIFF images recognize: (1) a "bits-per-sample" option (integer) which
-can be either 1 for saving bi-level CCITTFAX4 images, or 8 for saving
-8-bits per sample; (2) a "compression" option (integer) which can be
-1 for no compression, 2 for Huffman, 5 for LZW, 7 for JPEG and 8 for
-DEFLATE (see the libtiff documentation and tiff.h for all supported
-codec values); (3) an "icc-profile" option (zero-terminated string)
-containing a base64 encoded ICC color profile.
+1. a "bits-per-sample" option (integer) which can be either 1 for saving
+bi-level CCITTFAX4 images, or 8 for saving 8-bits per sample
+2. a "compression" option (integer) which can be 1 for no compression,
+2 for Huffman, 5 for LZW, 7 for JPEG and 8 for DEFLATE (see the libtiff
+documentation and tiff.h for all supported codec values)
+3. an "icc-profile" option (zero-terminated string) containing a base64
+encoded ICC color profile.
ICO images can be saved in depth 16, 24, or 32, by using the "depth"
parameter. When the ICO saver is given "x_hot" and "y_hot" parameters,
@@ -12432,7 +13126,7 @@ it produces a CUR instead of an ICO.
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf.
+<parameter_description> a `GdkPixbuf`.
</parameter_description>
</parameter>
<parameter name="filename">
@@ -12444,36 +13138,41 @@ it produces a CUR instead of an ICO.
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for error, or %NULL
+<parameter_description> return location for error
</parameter_description>
</parameter>
<parameter name="Varargs">
-<parameter_description> list of key-value save options, followed by %NULL
+<parameter_description> list of key-value save options, followed by `NULL`
</parameter_description>
</parameter>
</parameters>
-<return> whether an error was set
+<return> `TRUE` on success, and `FALSE` otherwise
</return>
</function>
<function name="gdk_pixbuf_save_to_buffer">
<description>
-Saves pixbuf to a new buffer in format @type, which is currently "jpeg",
-"png", "tiff", "ico" or "bmp". This is a convenience function that
uses
-gdk_pixbuf_save_to_callback() to do the real work. Note that the buffer
-is not nul-terminated and may contain embedded nuls.
-If @error is set, %FALSE will be returned and @buffer will be set to
-%NULL. Possible errors include those in the #GDK_PIXBUF_ERROR
+Saves pixbuf to a new buffer in format `type`, which is currently "jpeg",
+"png", "tiff", "ico" or "bmp".
+
+This is a convenience function that uses `gdk_pixbuf_save_to_callback()`
+to do the real work.
+
+Note that the buffer is not `NUL`-terminated and may contain embedded `NUL`
+characters.
+
+If @error is set, `FALSE` will be returned and @buffer will be set to
+`NULL`. Possible errors include those in the `GDK_PIXBUF_ERROR`
domain.
-See gdk_pixbuf_save() for more details.
+See `gdk_pixbuf_save()` for more details.
Since: 2.4
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf.
+<parameter_description> a `GdkPixbuf`.
</parameter_description>
</parameter>
<parameter name="buffer">
@@ -12490,7 +13189,7 @@ to the new buffer.
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for error, or %NULL
+<parameter_description> return location for error, or `NULL`
</parameter_description>
</parameter>
<parameter name="Varargs">
@@ -12505,16 +13204,19 @@ to the new buffer.
<function name="gdk_pixbuf_save_to_bufferv">
<description>
+Vector version of `gdk_pixbuf_save_to_buffer()`.
+
Saves pixbuf to a new buffer in format @type, which is currently "jpeg",
-"tiff", "png", "ico" or "bmp". See gdk_pixbuf_save_to_buffer()
-for more details.
+"tiff", "png", "ico" or "bmp".
+
+See [method@GdkPixbuf.Pixbuf.save_to_buffer] for more details.
Since: 2.4
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf.
+<parameter_description> a `GdkPixbuf`.
</parameter_description>
</parameter>
<parameter name="buffer">
@@ -12531,7 +13233,7 @@ location to receive a pointer to the new buffer.
</parameter_description>
</parameter>
<parameter name="option_keys">
-<parameter_description> name of options to set, %NULL-terminated
+<parameter_description> name of options to set
</parameter_description>
</parameter>
<parameter name="option_values">
@@ -12539,7 +13241,7 @@ location to receive a pointer to the new buffer.
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for error, or %NULL
+<parameter_description> return location for error, or `NULL`
</parameter_description>
</parameter>
</parameters>
@@ -12550,21 +13252,24 @@ location to receive a pointer to the new buffer.
<function name="gdk_pixbuf_save_to_callback">
<description>
-Saves pixbuf in format @type by feeding the produced data to a
-callback. Can be used when you want to store the image to something
-other than a file, such as an in-memory buffer or a socket.
-If @error is set, %FALSE will be returned. Possible errors
-include those in the #GDK_PIXBUF_ERROR domain and whatever the save
+Saves pixbuf in format `type` by feeding the produced data to a
+callback.
+
+This function can be used when you want to store the image to something
+other than a file, such as an in-memory buffer or a socket.
+
+If @error is set, `FALSE` will be returned. Possible errors
+include those in the `GDK_PIXBUF_ERROR` domain and whatever the save
function generates.
-See gdk_pixbuf_save() for more details.
+See [method GdkPixbuf Pixbuf save] for more details.
Since: 2.4
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf.
+<parameter_description> a `GdkPixbuf`.
</parameter_description>
</parameter>
<parameter name="save_func">
@@ -12581,7 +13286,7 @@ the save routine generates.
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for error, or %NULL
+<parameter_description> return location for error, or `NULL`
</parameter_description>
</parameter>
<parameter name="Varargs">
@@ -12596,16 +13301,21 @@ the save routine generates.
<function name="gdk_pixbuf_save_to_callbackv">
<description>
+Vector version of `gdk_pixbuf_save_to_callback()`.
+
Saves pixbuf to a callback in format @type, which is currently "jpeg",
-"png", "tiff", "ico" or "bmp". If @error is set, %FALSE will be
returned. See
-gdk_pixbuf_save_to_callback () for more details.
+"png", "tiff", "ico" or "bmp".
+
+If @error is set, `FALSE` will be returned.
+
+See [method@GdkPixbuf.Pixbuf.save_to_callback] for more details.
Since: 2.4
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf.
+<parameter_description> a `GdkPixbuf`.
</parameter_description>
</parameter>
<parameter name="save_func">
@@ -12622,7 +13332,7 @@ the save routine generates.
</parameter_description>
</parameter>
<parameter name="option_keys">
-<parameter_description> name of options to set, %NULL-terminated
+<parameter_description> name of options to set
</parameter_description>
</parameter>
<parameter name="option_values">
@@ -12630,7 +13340,7 @@ the save routine generates.
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for error, or %NULL
+<parameter_description> return location for error, or `NULL`
</parameter_description>
</parameter>
</parameters>
@@ -12641,28 +13351,28 @@ the save routine generates.
<function name="gdk_pixbuf_save_to_stream">
<description>
-Saves @pixbuf to an output stream.
+Saves `pixbuf` to an output stream.
Supported file formats are currently "jpeg", "tiff", "png", "ico" or
-"bmp". See gdk_pixbuf_save_to_buffer() for more details.
+"bmp". See `gdk_pixbuf_save_to_buffer()` for more details.
-The @cancellable can be used to abort the operation from another
-thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED
-will be returned. Other possible errors are in the #GDK_PIXBUF_ERROR
-and %G_IO_ERROR domains.
+The `cancellable` can be used to abort the operation from another
+thread. If the operation was cancelled, the error `G_IO_ERROR_CANCELLED`
+will be returned. Other possible errors are in the `GDK_PIXBUF_ERROR`
+and `G_IO_ERROR` domains.
-The stream is not closed.
+The stream is not closed at the end of this call.
Since: 2.14
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
+<parameter_description> a `GdkPixbuf`
</parameter_description>
</parameter>
<parameter name="stream">
-<parameter_description> a #GOutputStream to save the pixbuf to
+<parameter_description> a `GOutputStream` to save the pixbuf to
</parameter_description>
</parameter>
<parameter name="type">
@@ -12670,11 +13380,11 @@ Since: 2.14
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<parameter_description> optional `GCancellable` object, `NULL` to ignore
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for error, or %NULL
+<parameter_description> return location for error, or `NULL`
</parameter_description>
</parameter>
<parameter name="Varargs">
@@ -12682,7 +13392,7 @@ Since: 2.14
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the pixbuf was saved successfully, %FALSE if an
+<return> `TRUE` if the pixbuf was saved successfully, `FALSE` if an
error was set.
</return>
@@ -12690,24 +13400,26 @@ error was set.
<function name="gdk_pixbuf_save_to_stream_async">
<description>
-Saves @pixbuf to an output stream asynchronously.
+Saves `pixbuf` to an output stream asynchronously.
For more details see gdk_pixbuf_save_to_stream(), which is the synchronous
version of this function.
-When the operation is finished, @callback will be called in the main thread.
-You can then call gdk_pixbuf_save_to_stream_finish() to get the result of the operation.
+When the operation is finished, `callback` will be called in the main thread.
+
+You can then call gdk_pixbuf_save_to_stream_finish() to get the result of
+the operation.
Since: 2.24
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
+<parameter_description> a `GdkPixbuf`
</parameter_description>
</parameter>
<parameter name="stream">
-<parameter_description> a #GOutputStream to which to save the pixbuf
+<parameter_description> a `GOutputStream` to which to save the pixbuf
</parameter_description>
</parameter>
<parameter name="type">
@@ -12715,11 +13427,11 @@ Since: 2.24
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<parameter_description> optional `GCancellable` object, `NULL` to ignore
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when the pixbuf is saved
+<parameter_description> a `GAsyncReadyCallback` to call when the pixbuf is saved
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -12744,36 +13456,38 @@ Since: 2.24
</description>
<parameters>
<parameter name="async_result">
-<parameter_description> a #GAsyncResult
+<parameter_description> a `GAsyncResult`
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a #GError, or %NULL
+<parameter_description> a `GError`, or `NULL`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the pixbuf was saved successfully, %FALSE if an error was set.
+<return> `TRUE` if the pixbuf was saved successfully, `FALSE` if an error was set.
</return>
</function>
<function name="gdk_pixbuf_save_to_streamv">
<description>
-Saves @pixbuf to an output stream.
+Saves `pixbuf` to an output stream.
Supported file formats are currently "jpeg", "tiff", "png", "ico" or
-"bmp". See gdk_pixbuf_save_to_stream() for more details.
+"bmp".
+
+See [method@GdkPixbuf.Pixbuf.save_to_stream] for more details.
Since: 2.36
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
+<parameter_description> a `GdkPixbuf`
</parameter_description>
</parameter>
<parameter name="stream">
-<parameter_description> a #GOutputStream to save the pixbuf to
+<parameter_description> a `GOutputStream` to save the pixbuf to
</parameter_description>
</parameter>
<parameter name="type">
@@ -12781,7 +13495,7 @@ Since: 2.36
</parameter_description>
</parameter>
<parameter name="option_keys">
-<parameter_description> name of options to set, %NULL-terminated
+<parameter_description> name of options to set
</parameter_description>
</parameter>
<parameter name="option_values">
@@ -12789,15 +13503,15 @@ Since: 2.36
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<parameter_description> optional `GCancellable` object, `NULL` to ignore
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for error, or %NULL
+<parameter_description> return location for error
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the pixbuf was saved successfully, %FALSE if an
+<return> `TRUE` if the pixbuf was saved successfully, `FALSE` if an
error was set.
</return>
@@ -12805,24 +13519,26 @@ error was set.
<function name="gdk_pixbuf_save_to_streamv_async">
<description>
-Saves @pixbuf to an output stream asynchronously.
+Saves `pixbuf` to an output stream asynchronously.
For more details see gdk_pixbuf_save_to_streamv(), which is the synchronous
version of this function.
-When the operation is finished, @callback will be called in the main thread.
-You can then call gdk_pixbuf_save_to_stream_finish() to get the result of the operation.
+When the operation is finished, `callback` will be called in the main thread.
+
+You can then call gdk_pixbuf_save_to_stream_finish() to get the result of
+the operation.
Since: 2.36
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
+<parameter_description> a `GdkPixbuf`
</parameter_description>
</parameter>
<parameter name="stream">
-<parameter_description> a #GOutputStream to which to save the pixbuf
+<parameter_description> a `GOutputStream` to which to save the pixbuf
</parameter_description>
</parameter>
<parameter name="type">
@@ -12830,7 +13546,7 @@ Since: 2.36
</parameter_description>
</parameter>
<parameter name="option_keys">
-<parameter_description> name of options to set, %NULL-terminated
+<parameter_description> name of options to set
</parameter_description>
</parameter>
<parameter name="option_values">
@@ -12838,11 +13554,11 @@ Since: 2.36
</parameter_description>
</parameter>
<parameter name="cancellable">
-<parameter_description> optional #GCancellable object, %NULL to ignore
+<parameter_description> optional `GCancellable` object, `NULL` to ignore
</parameter_description>
</parameter>
<parameter name="callback">
-<parameter_description> a #GAsyncReadyCallback to call when the pixbuf is saved
+<parameter_description> a `GAsyncReadyCallback` to call when the pixbuf is saved
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -12855,15 +13571,19 @@ Since: 2.36
<function name="gdk_pixbuf_savev">
<description>
-Saves pixbuf to a file in @type, which is currently "jpeg", "png", "tiff",
"ico" or "bmp".
-If @error is set, %FALSE will be returned.
-See gdk_pixbuf_save () for more details.
+Vector version of `gdk_pixbuf_save()`.
+
+Saves pixbuf to a file in `type`, which is currently "jpeg", "png", "tiff",
"ico" or "bmp".
+
+If @error is set, `FALSE` will be returned.
+
+See [method GdkPixbuf Pixbuf save] for more details.
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf.
+<parameter_description> a `GdkPixbuf`.
</parameter_description>
</parameter>
<parameter name="filename">
@@ -12875,7 +13595,7 @@ See gdk_pixbuf_save () for more details.
</parameter_description>
</parameter>
<parameter name="option_keys">
-<parameter_description> name of options to set, %NULL-terminated
+<parameter_description> name of options to set
</parameter_description>
</parameter>
<parameter name="option_values">
@@ -12883,7 +13603,7 @@ See gdk_pixbuf_save () for more details.
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for error, or %NULL
+<parameter_description> return location for error, or `NULL`
</parameter_description>
</parameter>
</parameters>
@@ -12899,7 +13619,7 @@ Same as gdk_pixbuf_savev()
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf.
+<parameter_description> a `GdkPixbuf`.
</parameter_description>
</parameter>
<parameter name="filename">
@@ -12911,7 +13631,7 @@ Same as gdk_pixbuf_savev()
</parameter_description>
</parameter>
<parameter name="option_keys">
-<parameter_description> name of options to set, %NULL-terminated
+<parameter_description> name of options to set
</parameter_description>
</parameter>
<parameter name="option_values">
@@ -12919,7 +13639,7 @@ Same as gdk_pixbuf_savev()
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for error, or %NULL
+<parameter_description> return location for error, or `NULL`
</parameter_description>
</parameter>
</parameters>
@@ -12935,8 +13655,8 @@ then renders the rectangle (@dest_x, @dest_y, @dest_width,
@dest_height) of the resulting image onto the destination image
replacing the previous contents.
-Try to use gdk_pixbuf_scale_simple() first, this function is
-the industrial-strength power tool you can fall back to if
+Try to use gdk_pixbuf_scale_simple() first; this function is
+the industrial-strength power tool you can fall back to, if
gdk_pixbuf_scale_simple() isn't powerful enough.
If the source rectangle overlaps the destination rectangle on the
@@ -12995,21 +13715,24 @@ results in rendering artifacts.
<function name="gdk_pixbuf_scale_simple">
<description>
-Create a new #GdkPixbuf containing a copy of @src scaled to
-@dest_width x @dest_height. Leaves @src unaffected. @interp_type
-should be #GDK_INTERP_NEAREST if you want maximum speed (but when
-scaling down #GDK_INTERP_NEAREST is usually unusably ugly). The
-default @interp_type should be #GDK_INTERP_BILINEAR which offers
-reasonable quality and speed.
+Create a new pixbuf containing a copy of `src` scaled to
+`dest_width` x `dest_height`.
-You can scale a sub-portion of @src by creating a sub-pixbuf
-pointing into @src; see gdk_pixbuf_new_subpixbuf().
+This function leaves `src` unaffected.
-If @dest_width and @dest_height are equal to the @src width and height, a
-copy of @src is returned, avoiding any scaling.
+The `interp_type` should be `GDK_INTERP_NEAREST` if you want maximum
+speed (but when scaling down `GDK_INTERP_NEAREST` is usually unusably
+ugly). The default `interp_type` should be `GDK_INTERP_BILINEAR` which
+offers reasonable quality and speed.
-For more complicated scaling/alpha blending see gdk_pixbuf_scale()
-and gdk_pixbuf_composite().
+You can scale a sub-portion of `src` by creating a sub-pixbuf
+pointing into `src`; see [method@GdkPixbuf.Pixbuf.new_subpixbuf].
+
+If `dest_width` and `dest_height` are equal to the width and height of
+`src`, this function will return an unscaled copy of `src`.
+
+For more complicated scaling/alpha blending see [method@GdkPixbuf.Pixbuf.scale]
+and [method@GdkPixbuf.Pixbuf.composite].
</description>
@@ -13031,23 +13754,23 @@ and gdk_pixbuf_composite().
</parameter_description>
</parameter>
</parameters>
-<return> the new #GdkPixbuf, or %NULL if not enough memory could be
-allocated for it.
+<return> the new pixbuf
</return>
</function>
<function name="gdk_pixbuf_set_option">
<description>
-Attaches a key/value pair as an option to a #GdkPixbuf. If @key already
-exists in the list of options attached to @pixbuf, the new value is
-ignored and %FALSE is returned.
+Attaches a key/value pair as an option to a `GdkPixbuf`.
+
+If `key` already exists in the list of options attached to the `pixbuf`,
+the new value is ignored and `FALSE` is returned.
Since: 2.2
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
+<parameter_description> a `GdkPixbuf`
</parameter_description>
</parameter>
<parameter name="key">
@@ -13059,7 +13782,7 @@ Since: 2.2
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success.
+<return> `TRUE` on success
</return>
</function>
@@ -13180,14 +13903,18 @@ This is the version currently in use by a running program.
<function name="gdk_pixdata_deserialize">
<description>
Deserializes (reconstruct) a #GdkPixdata structure from a byte stream.
+
The byte stream consists of a straightforward writeout of the
-#GdkPixdata fields in network byte order, plus the @pixel_data
+`GdkPixdata` fields in network byte order, plus the `pixel_data`
bytes the structure points to.
-The @pixdata contents are reconstructed byte by byte and are checked
-for validity. This function may fail with %GDK_PIXBUF_ERROR_CORRUPT_IMAGE
-or %GDK_PIXBUF_ERROR_UNKNOWN_TYPE.
-Deprecated: 2.32: Use #GResource instead.
+The `pixdata` contents are reconstructed byte by byte and are checked
+for validity.
+
+This function may fail with `GDK_PIXBUF_ERROR_CORRUPT_IMAGE`
+or `GDK_PIXBUF_ERROR_UNKNOWN_TYPE`.
+
+Deprecated: 2.32: Use `GResource` instead.
</description>
<parameters>
@@ -13205,32 +13932,33 @@ serialized #GdkPixdata structure.
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> #GError location to indicate failures (maybe %NULL to ignore errors).
+<parameter_description> #GError location to indicate failures (maybe `NULL` to ignore errors).
</parameter_description>
</parameter>
</parameters>
-<return> Upon successful deserialization %TRUE is returned,
-%FALSE otherwise.
+<return> Upon successful deserialization `TRUE` is returned,
+`FALSE` otherwise.
</return>
</function>
<function name="gdk_pixdata_from_pixbuf">
<description>
-Converts a #GdkPixbuf to a #GdkPixdata. If @use_rle is %TRUE, the
-pixel data is run-length encoded into newly-allocated memory and a
-pointer to that memory is returned.
+Converts a `GdkPixbuf` to a `GdkPixdata`.
+
+If `use_rle` is `TRUE`, the pixel data is run-length encoded into
+newly-allocated memory and a pointer to that memory is returned.
Deprecated: 2.32: Use #GResource instead.
</description>
<parameters>
<parameter name="pixdata">
-<parameter_description> a #GdkPixdata to fill.
+<parameter_description> a `GdkPixdata` to fill.
</parameter_description>
</parameter>
<parameter name="pixbuf">
-<parameter_description> the data to fill @pixdata with.
+<parameter_description> the data to fill `pixdata` with.
</parameter_description>
</parameter>
<parameter name="use_rle">
@@ -13238,9 +13966,9 @@ Deprecated: 2.32: Use #GResource instead.
</parameter_description>
</parameter>
</parameters>
-<return> If @use_rle is %TRUE, a pointer to the
-newly-allocated memory for the run-length encoded pixel data,
-otherwise %NULL.
+<return> If `use_rle` is
+`TRUE`, a pointer to the newly-allocated memory for the run-length
+encoded pixel data, otherwise `NULL`.
</return>
</function>
@@ -13277,30 +14005,29 @@ structure.
Generates C source code suitable for compiling images directly
into programs.
-gdk-pixbuf ships with a program called
-[gdk-pixbuf-csource][gdk-pixbuf-csource], which offers a command
-line interface to this function.
+GdkPixbuf ships with a program called `gdk-pixbuf-csource`, which offers
+a command line interface to this function.
Deprecated: 2.32: Use #GResource instead.
</description>
<parameters>
<parameter name="pixdata">
-<parameter_description> a #GdkPixdata to convert to C source.
+<parameter_description> a `GdkPixdata` to convert to C source
</parameter_description>
</parameter>
<parameter name="name">
-<parameter_description> used for naming generated data structures or macros.
+<parameter_description> used for naming generated data structures or macros
</parameter_description>
</parameter>
<parameter name="dump_type">
-<parameter_description> a #GdkPixdataDumpType determining the kind of C
-source to be generated.
+<parameter_description> the kind of C source to be generated
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated string containing the C source form
-of @pixdata.
+<return> a newly-allocated string buffer containing
+the C source form of `pixdata`.
+
</return>
</function>
@@ -13312,7 +14039,7 @@ Returns whether this popup is set to hide on outside clicks.
</description>
<parameters>
<parameter name="popup">
-<parameter_description> a #GdkPopup
+<parameter_description> a `GdkPopup`
</parameter_description>
</parameter>
</parameters>
@@ -13328,7 +14055,7 @@ Returns the parent surface of a popup.
</description>
<parameters>
<parameter name="popup">
-<parameter_description> a #GdkPopup
+<parameter_description> a `GdkPopup`
</parameter_description>
</parameter>
</parameters>
@@ -13344,7 +14071,7 @@ Obtains the position of the popup relative to its parent.
</description>
<parameters>
<parameter name="popup">
-<parameter_description> a #GdkPopup
+<parameter_description> a `GdkPopup`
</parameter_description>
</parameter>
</parameters>
@@ -13360,7 +14087,7 @@ Obtains the position of the popup relative to its parent.
</description>
<parameters>
<parameter name="popup">
-<parameter_description> a #GdkPopup
+<parameter_description> a `GdkPopup`
</parameter_description>
</parameter>
</parameters>
@@ -13372,14 +14099,14 @@ Obtains the position of the popup relative to its parent.
<description>
Gets the current popup rectangle anchor.
-The value returned may change after calling gdk_popup_present(),
-or after the #GdkSurface::layout signal is emitted.
+The value returned may change after calling [method@Gdk.Popup.present],
+or after the [signal@Gdk.Surface::layout] signal is emitted.
</description>
<parameters>
<parameter name="popup">
-<parameter_description> a #GdkPopup
+<parameter_description> a `GdkPopup`
</parameter_description>
</parameter>
</parameters>
@@ -13391,14 +14118,14 @@ or after the #GdkSurface::layout signal is emitted.
<description>
Gets the current popup surface anchor.
-The value returned may change after calling gdk_popup_present(),
-or after the #GdkSurface::layout signal is emitted.
+The value returned may change after calling [method@Gdk.Popup.present],
+or after the [signal@Gdk.Surface::layout] signal is emitted.
</description>
<parameters>
<parameter name="popup">
-<parameter_description> a #GdkPopup
+<parameter_description> a `GdkPopup`
</parameter_description>
</parameter>
</parameters>
@@ -13408,13 +14135,13 @@ or after the #GdkSurface::layout signal is emitted.
<function name="gdk_popup_layout_copy">
<description>
-Create a new #GdkPopupLayout and copy the contents of @layout into it.
+Makes a copy of @layout.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GdkPopupLayout
+<parameter_description> a `GdkPopupLayout`
</parameter_description>
</parameter>
</parameters>
@@ -13430,11 +14157,11 @@ Check whether @layout and @other has identical layout properties.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GdkPopupLayout
+<parameter_description> a `GdkPopupLayout`
</parameter_description>
</parameter>
<parameter name="other">
-<parameter_description> another #GdkPopupLayout
+<parameter_description> another `GdkPopupLayout`
</parameter_description>
</parameter>
</parameters>
@@ -13445,17 +14172,17 @@ otherwise %FALSE.
<function name="gdk_popup_layout_get_anchor_hints">
<description>
-Get the #GdkAnchorHints.
+Get the `GdkAnchorHints`.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GdkPopupLayout
+<parameter_description> a `GdkPopupLayout`
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkAnchorHints.
+<return> the `GdkAnchorHints`
</return>
</function>
@@ -13467,11 +14194,11 @@ Get the anchor rectangle.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GdkPopupLayout
+<parameter_description> a `GdkPopupLayout`
</parameter_description>
</parameter>
</parameters>
-<return> The anchor rectangle.
+<return> The anchor rectangle
</return>
</function>
@@ -13482,7 +14209,7 @@ Retrieves the offset for the anchor rectangle.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GdkPopupLayout
+<parameter_description> a `GdkPopupLayout`
</parameter_description>
</parameter>
<parameter name="dx">
@@ -13505,7 +14232,7 @@ Returns the anchor position on the anchor rectangle.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GdkPopupLayout
+<parameter_description> a `GdkPopupLayout`
</parameter_description>
</parameter>
</parameters>
@@ -13513,6 +14240,38 @@ Returns the anchor position on the anchor rectangle.
</return>
</function>
+<function name="gdk_popup_layout_get_shadow_width">
+<description>
+Obtains the shadow widths of this layout.
+
+Since: 4.2
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a `GdkPopupLayout`
+</parameter_description>
+</parameter>
+<parameter name="left">
+<parameter_description> return location for the left shadow width
+</parameter_description>
+</parameter>
+<parameter name="right">
+<parameter_description> return location for the right shadow width
+</parameter_description>
+</parameter>
+<parameter name="top">
+<parameter_description> return location for the top shadow width
+</parameter_description>
+</parameter>
+<parameter name="bottom">
+<parameter_description> return location for the bottom shadow width
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gdk_popup_layout_get_surface_anchor">
<description>
Returns the anchor position on the popup surface.
@@ -13521,7 +14280,7 @@ Returns the anchor position on the popup surface.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GdkPopupLayout
+<parameter_description> a `GdkPopupLayout`
</parameter_description>
</parameter>
</parameters>
@@ -13531,22 +14290,24 @@ Returns the anchor position on the popup surface.
<function name="gdk_popup_layout_new">
<description>
-Create a popup layout description. Used together with gdk_popup_present()
-to describe how a popup surface should be placed and behave on-screen.
+Create a popup layout description.
+
+Used together with [method@Gdk.Popup.present] to describe how a popup
+surface should be placed and behave on-screen.
@anchor_rect is relative to the top-left corner of the surface's parent.
@rect_anchor and @surface_anchor determine anchor points on @anchor_rect
and surface to pin together.
The position of @anchor_rect's anchor point can optionally be offset using
-gdk_popup_layout_set_offset(), which is equivalent to offsetting the
+[method@Gdk.PopupLayout.set_offset], which is equivalent to offsetting the
position of surface.
</description>
<parameters>
<parameter name="anchor_rect">
-<parameter_description> the anchor #GdkRectangle to align @surface with
+<parameter_description> the anchor `GdkRectangle` to align @surface with
</parameter_description>
</parameter>
<parameter name="rect_anchor">
@@ -13558,7 +14319,7 @@ position of surface.
</parameter_description>
</parameter>
</parameters>
-<return> newly created instance of #GdkPopupLayout
+<return> newly created instance of `GdkPopupLayout`
</return>
</function>
@@ -13570,7 +14331,7 @@ Increases the reference count of @value.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GdkPopupLayout
+<parameter_description> a `GdkPopupLayout`
</parameter_description>
</parameter>
</parameters>
@@ -13582,19 +14343,20 @@ Increases the reference count of @value.
<description>
Set new anchor hints.
-The set @anchor_hints determines how @surface will be moved if the anchor
-points cause it to move off-screen. For example, %GDK_ANCHOR_FLIP_X will
-replace %GDK_GRAVITY_NORTH_WEST with %GDK_GRAVITY_NORTH_EAST and vice versa
-if @surface extends beyond the left or right edges of the monitor.
+The set @anchor_hints determines how @surface will be moved
+if the anchor points cause it to move off-screen. For example,
+%GDK_ANCHOR_FLIP_X will replace %GDK_GRAVITY_NORTH_WEST with
+%GDK_GRAVITY_NORTH_EAST and vice versa if @surface extends
+beyond the left or right edges of the monitor.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GdkPopupLayout
+<parameter_description> a `GdkPopupLayout`
</parameter_description>
</parameter>
<parameter name="anchor_hints">
-<parameter_description> the new #GdkAnchorHints
+<parameter_description> the new `GdkAnchorHints`
</parameter_description>
</parameter>
</parameters>
@@ -13608,7 +14370,7 @@ Set the anchor rectangle.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GdkPopupLayout
+<parameter_description> a `GdkPopupLayout`
</parameter_description>
</parameter>
<parameter name="anchor_rect">
@@ -13626,7 +14388,7 @@ Offset the position of the anchor rectangle with the given delta.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GdkPopupLayout
+<parameter_description> a `GdkPopupLayout`
</parameter_description>
</parameter>
<parameter name="dx">
@@ -13648,7 +14410,7 @@ Set the anchor on the anchor rectangle.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GdkPopupLayout
+<parameter_description> a `GdkPopupLayout`
</parameter_description>
</parameter>
<parameter name="anchor">
@@ -13659,6 +14421,42 @@ Set the anchor on the anchor rectangle.
<return></return>
</function>
+<function name="gdk_popup_layout_set_shadow_width">
+<description>
+Sets the shadow width of the popup.
+
+The shadow width corresponds to the part of the computed
+surface size that would consist of the shadow margin
+surrounding the window, would there be any.
+
+Since: 4.2
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a `GdkPopupLayout`
+</parameter_description>
+</parameter>
+<parameter name="left">
+<parameter_description> width of the left part of the shadow
+</parameter_description>
+</parameter>
+<parameter name="right">
+<parameter_description> width of the right part of the shadow
+</parameter_description>
+</parameter>
+<parameter name="top">
+<parameter_description> height of the top part of the shadow
+</parameter_description>
+</parameter>
+<parameter name="bottom">
+<parameter_description> height of the bottom part of the shadow
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gdk_popup_layout_set_surface_anchor">
<description>
Set the anchor on the popup surface.
@@ -13666,7 +14464,7 @@ Set the anchor on the popup surface.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GdkPopupLayout
+<parameter_description> a `GdkPopupLayout`
</parameter_description>
</parameter>
<parameter name="anchor">
@@ -13684,7 +14482,7 @@ Decreases the reference count of @value.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GdkPopupLayout
+<parameter_description> a `GdkPopupLayout`
</parameter_description>
</parameter>
</parameters>
@@ -13694,25 +14492,26 @@ Decreases the reference count of @value.
<function name="gdk_popup_present">
<description>
Present @popup after having processed the #GdkPopupLayout rules.
+
If the popup was previously now showing, it will be showed,
otherwise it will change position according to @layout.
After calling this function, the result should be handled in response
-to the #GdkSurface::layout signal being emitted. The resulting popup
-position can be queried using gdk_popup_get_position_x(),
-gdk_popup_get_position_y(), and the resulting size will be sent as
-parameters in the layout signal. Use gdk_popup_get_rect_anchor() and
-gdk_popup_get_surface_anchor() to get the resulting anchors.
+to the [signal@GdkSurface::layout] signal being emitted. The resulting
+popup position can be queried using [method@Gdk.Popup.get_position_x],
+[method@Gdk.Popup.get_position_y], and the resulting size will be sent as
+parameters in the layout signal. Use [method@Gdk.Popup.get_rect_anchor]
+and [method@Gdk.Popup.get_surface_anchor] to get the resulting anchors.
Presenting may fail, for example if the @popup is set to autohide
and is immediately hidden upon being presented. If presenting failed,
-the #GdkSurface::layout signal will not me emitted.
+the [signal@Gdk.Surface::layout] signal will not me emitted.
</description>
<parameters>
<parameter name="popup">
-<parameter_description> the #GdkPopup to show
+<parameter_description> the `GdkPopup` to show
</parameter_description>
</parameter>
<parameter name="width">
@@ -13724,7 +14523,7 @@ the #GdkSurface::layout signal will not me emitted.
</parameter_description>
</parameter>
<parameter name="layout">
-<parameter_description> the #GdkPopupLayout object used to layout
+<parameter_description> the `GdkPopupLayout` object used to layout
</parameter_description>
</parameter>
</parameters>
@@ -13740,7 +14539,7 @@ Returns #TRUE if @rect contains the point described by @x and @y.
</description>
<parameters>
<parameter name="rect">
-<parameter_description> a #GdkRectangle
+<parameter_description> a `GdkRectangle`
</parameter_description>
</parameter>
<parameter name="x">
@@ -13764,11 +14563,11 @@ Checks if the two given rectangles are equal.
</description>
<parameters>
<parameter name="rect1">
-<parameter_description> a #GdkRectangle
+<parameter_description> a `GdkRectangle`
</parameter_description>
</parameter>
<parameter name="rect2">
-<parameter_description> a #GdkRectangle
+<parameter_description> a `GdkRectangle`
</parameter_description>
</parameter>
</parameters>
@@ -13778,22 +14577,23 @@ Checks if the two given rectangles are equal.
<function name="gdk_rectangle_intersect">
<description>
-Calculates the intersection of two rectangles. It is allowed for
-@dest to be the same as either @src1 or @src2. If the rectangles
-do not intersect, @dest’s width and height is set to 0 and its x
-and y values are undefined. If you are only interested in whether
-the rectangles intersect, but not in the intersecting area itself,
-pass %NULL for @dest.
+Calculates the intersection of two rectangles.
+
+It is allowed for @dest to be the same as either @src1 or @src2.
+If the rectangles do not intersect, @dest’s width and height is set
+to 0 and its x and y values are undefined. If you are only interested
+in whether the rectangles intersect, but not in the intersecting area
+itself, pass %NULL for @dest.
</description>
<parameters>
<parameter name="src1">
-<parameter_description> a #GdkRectangle
+<parameter_description> a `GdkRectangle`
</parameter_description>
</parameter>
<parameter name="src2">
-<parameter_description> a #GdkRectangle
+<parameter_description> a `GdkRectangle`
</parameter_description>
</parameter>
<parameter name="dest">
@@ -13809,9 +14609,10 @@ intersection of @src1 and @src2, or %NULL
<function name="gdk_rectangle_union">
<description>
Calculates the union of two rectangles.
+
The union of rectangles @src1 and @src2 is the smallest rectangle which
-includes both @src1 and @src2 within it.
-It is allowed for @dest to be the same as either @src1 or @src2.
+includes both @src1 and @src2 within it. It is allowed for @dest to be
+the same as either @src1 or @src2.
Note that this function does not ignore 'empty' rectangles (ie. with
zero width or height).
@@ -13819,11 +14620,11 @@ zero width or height).
</description>
<parameters>
<parameter name="src1">
-<parameter_description> a #GdkRectangle
+<parameter_description> a `GdkRectangle`
</parameter_description>
</parameter>
<parameter name="src2">
-<parameter_description> a #GdkRectangle
+<parameter_description> a `GdkRectangle`
</parameter_description>
</parameter>
<parameter name="dest">
@@ -13836,35 +14637,35 @@ zero width or height).
<function name="gdk_rgba_copy">
<description>
-Makes a copy of a #GdkRGBA.
+Makes a copy of a `GdkRGBA`.
-The result must be freed through gdk_rgba_free().
+The result must be freed through [method Gdk RGBA free].
</description>
<parameters>
<parameter name="rgba">
-<parameter_description> a #GdkRGBA
+<parameter_description> a `GdkRGBA`
</parameter_description>
</parameter>
</parameters>
-<return> A newly allocated #GdkRGBA, with the same contents as @rgba
+<return> A newly allocated `GdkRGBA`, with the same contents as @rgba
</return>
</function>
<function name="gdk_rgba_equal">
<description>
-Compares two RGBA colors.
+Compares two `GdkRGBA` colors.
</description>
<parameters>
<parameter name="p1">
-<parameter_description> a #GdkRGBA pointer
+<parameter_description> a `GdkRGBA`
</parameter_description>
</parameter>
<parameter name="p2">
-<parameter_description> another #GdkRGBA pointer
+<parameter_description> another `GdkRGBA`
</parameter_description>
</parameter>
</parameters>
@@ -13874,12 +14675,12 @@ Compares two RGBA colors.
<function name="gdk_rgba_free">
<description>
-Frees a #GdkRGBA created with gdk_rgba_copy()
+Frees a `GdkRGBA`.
</description>
<parameters>
<parameter name="rgba">
-<parameter_description> a #GdkRGBA
+<parameter_description> a `GdkRGBA`
</parameter_description>
</parameter>
</parameters>
@@ -13889,13 +14690,13 @@ Frees a #GdkRGBA created with gdk_rgba_copy()
<function name="gdk_rgba_hash">
<description>
A hash function suitable for using for a hash
-table that stores #GdkRGBAs.
+table that stores `GdkRGBA`s.
</description>
<parameters>
<parameter name="p">
-<parameter_description> a #GdkRGBA pointer
+<parameter_description> a `GdkRGBA`
</parameter_description>
</parameter>
</parameters>
@@ -13905,14 +14706,15 @@ table that stores #GdkRGBAs.
<function name="gdk_rgba_is_clear">
<description>
-Checks if an @rgba value is transparent. That is, drawing with the value
-would not produce any change.
+Checks if an @rgba value is transparent.
+
+That is, drawing with the value would not produce any change.
</description>
<parameters>
<parameter name="rgba">
-<parameter_description> a #GdkRGBA
+<parameter_description> a `GdkRGBA`
</parameter_description>
</parameter>
</parameters>
@@ -13922,14 +14724,16 @@ would not produce any change.
<function name="gdk_rgba_is_opaque">
<description>
-Checks if an @rgba value is opaque. That is, drawing with the value
-will not retain any results from previous contents.
+Checks if an @rgba value is opaque.
+
+That is, drawing with the value will not retain any results
+from previous contents.
</description>
<parameters>
<parameter name="rgba">
-<parameter_description> a #GdkRGBA
+<parameter_description> a `GdkRGBA`
</parameter_description>
</parameter>
</parameters>
@@ -13939,29 +14743,30 @@ will not retain any results from previous contents.
<function name="gdk_rgba_parse">
<description>
-Parses a textual representation of a color, filling in
-the @red, @green, @blue and @alpha fields of the @rgba #GdkRGBA.
+Parses a textual representation of a color.
The string can be either one of:
+
- A standard name (Taken from the X11 rgb.txt file).
- A hexadecimal value in the form “\#rgb”, “\#rrggbb”,
“\#rrrgggbbb” or ”\#rrrrggggbbbb”
- A hexadecimal value in the form “\#rgba”, “\#rrggbbaa”,
or ”\#rrrrggggbbbbaaaa”
-- A RGB color in the form “rgb(r,g,b)” (In this case the color will
-have full opacity)
+- A RGB color in the form “rgb(r,g,b)” (In this case the color
+will have full opacity)
- A RGBA color in the form “rgba(r,g,b,a)”
-Where “r”, “g”, “b” and “a” are respectively the red, green, blue and
-alpha color values. In the last two cases, “r”, “g”, and “b” are either
-integers in the range 0 to 255 or percentage values in the range 0% to
-100%, and a is a floating point value in the range 0 to 1.
+Where “r”, “g”, “b” and “a” are respectively the red, green,
+blue and alpha color values. In the last two cases, “r”, “g”,
+and “b” are either integers in the range 0 to 255 or percentage
+values in the range 0% to 100%, and a is a floating point value
+in the range 0 to 1.
</description>
<parameters>
<parameter name="rgba">
-<parameter_description> the #GdkRGBA to fill in
+<parameter_description> the `GdkRGBA` to fill in
</parameter_description>
</parameter>
<parameter name="spec">
@@ -13976,26 +14781,24 @@ integers in the range 0 to 255 or percentage values in the range 0% to
<function name="gdk_rgba_to_string">
<description>
Returns a textual specification of @rgba in the form
-`rgb(r,g,b)` or
-`rgba(r,g,b,a)`,
-where “r”, “g”, “b” and “a” represent the red, green,
-blue and alpha values respectively. “r”, “g”, and “b” are
-represented as integers in the range 0 to 255, and “a”
-is represented as a floating point value in the range 0 to 1.
+`rgb(r,g,b)` or `rgba(r,g,b,a)`, where “r”, “g”, “b” and
+“a” represent the red, green, blue and alpha values
+respectively. “r”, “g”, and “b” are represented as integers
+in the range 0 to 255, and “a” is represented as a floating
+point value in the range 0 to 1.
These string forms are string forms that are supported by
-the CSS3 colors module, and can be parsed by gdk_rgba_parse().
+the CSS3 colors module, and can be parsed by [method Gdk RGBA.parse].
-Note that this string representation may lose some
-precision, since “r”, “g” and “b” are represented as 8-bit
-integers. If this is a concern, you should use a
-different representation.
+Note that this string representation may lose some precision,
+since “r”, “g” and “b” are represented as 8-bit integers. If
+this is a concern, you should use a different representation.
</description>
<parameters>
<parameter name="rgba">
-<parameter_description> a #GdkRGBA
+<parameter_description> a `GdkRGBA`
</parameter_description>
</parameter>
</parameters>
@@ -14046,11 +14849,13 @@ Extracts the direction of a scroll event.
<function name="gdk_scroll_event_is_stop">
<description>
-Check whether a scroll event is a stop scroll event. Scroll sequences
-with smooth scroll information may provide a stop scroll event once the
-interaction with the device finishes, e.g. by lifting a finger. This
-stop scroll event is the signal that a widget may trigger kinetic
-scrolling based on the current velocity.
+Check whether a scroll event is a stop scroll event.
+
+Scroll sequences with smooth scroll information may provide
+a stop scroll event once the interaction with the device finishes,
+e.g. by lifting a finger. This stop scroll event is the signal
+that a widget may trigger kinetic scrolling based on the current
+velocity.
Stop scroll events always have a delta of 0/0.
@@ -14068,13 +14873,13 @@ Stop scroll events always have a delta of 0/0.
<function name="gdk_seat_get_capabilities">
<description>
-Returns the capabilities this #GdkSeat currently has.
+Returns the capabilities this `GdkSeat` currently has.
</description>
<parameters>
<parameter name="seat">
-<parameter_description> a #GdkSeat
+<parameter_description> a `GdkSeat`
</parameter_description>
</parameter>
</parameters>
@@ -14098,26 +14903,26 @@ Returns the devices that match the given capabilities.
</parameter_description>
</parameter>
</parameters>
-<return> A list of #GdkDevices.
-The list must be freed with g_list_free(), the elements are owned
-by GTK and must not be freed.
+<return> A list
+of `GdkDevices`. The list must be freed with g_list_free(),
+the elements are owned by GTK and must not be freed.
</return>
</function>
<function name="gdk_seat_get_display">
<description>
-Returns the #GdkDisplay this seat belongs to.
+Returns the `GdkDisplay` this seat belongs to.
</description>
<parameters>
<parameter name="seat">
-<parameter_description> a #GdkSeat
+<parameter_description> a `GdkSeat`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDisplay. This object is owned by GTK
-and must not be freed.
+<return> a `GdkDisplay`. This object
+is owned by GTK and must not be freed.
</return>
</function>
@@ -14129,11 +14934,11 @@ Returns the device that routes keyboard events.
</description>
<parameters>
<parameter name="seat">
-<parameter_description> a #GdkSeat
+<parameter_description> a `GdkSeat`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDevice with keyboard
+<return> a `GdkDevice` with keyboard
capabilities. This object is owned by GTK and must not be freed.
</return>
</function>
@@ -14146,25 +14951,24 @@ Returns the device that routes pointer events.
</description>
<parameters>
<parameter name="seat">
-<parameter_description> a #GdkSeat
+<parameter_description> a `GdkSeat`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDevice with pointer
+<return> a `GdkDevice` with pointer
capabilities. This object is owned by GTK and must not be freed.
</return>
</function>
<function name="gdk_seat_get_tools">
<description>
-Returns all #GdkDeviceTools that are known to the
-application.
+Returns all `GdkDeviceTools` that are known to the application.
</description>
<parameters>
<parameter name="seat">
-<parameter_description> A #GdkSeat
+<parameter_description> a `GdkSeat`
</parameter_description>
</parameter>
</parameters>
@@ -14182,25 +14986,31 @@ work with certain GDK backends.
By default, GDK tries all included backends.
-For example,
-|[<!-- language="C" -->
-gdk_set_allowed_backends ("wayland,quartz,*");
-]|
-instructs GDK to try the Wayland backend first,
-followed by the Quartz backend, and then all
-others.
+For example:
-If the `GDK_BACKEND` environment variable
-is set, it determines what backends are tried in what
-order, while still respecting the set of allowed backends
-that are specified by this function.
+```c
+gdk_set_allowed_backends ("wayland,macos,*");
+```
-The possible backend names are x11, win32, quartz,
-broadway, wayland. You can also include a * in the
-list to try all remaining backends.
+instructs GDK to try the Wayland backend first, followed by the
+MacOs backend, and then all others.
-This call must happen prior to gdk_display_open(),
-gtk_init(), or gtk_init_check()
+If the `GDK_BACKEND` environment variable is set, it determines
+what backends are tried in what order, while still respecting the
+set of allowed backends that are specified by this function.
+
+The possible backend names are:
+
+- `broadway`
+- `macos`
+- `wayland`.
+- `win32`
+- `x11`
+
+You can also include a `*` in the list to try all remaining backends.
+
+This call must happen prior to functions that open a display, such
+as [func Gdk Display open], `gtk_init()`, or `gtk_init_check()`
in order to take effect.
</description>
@@ -14215,14 +15025,15 @@ in order to take effect.
<function name="gdk_surface_beep">
<description>
-Emits a short beep associated to @surface in the appropriate
-display, if supported. Otherwise, emits a short beep on
-the display just as gdk_display_beep().
+Emits a short beep associated to @surface.
+
+If the display of @surface does not support per-surface beeps,
+emits a short beep on the display just as [method Gdk Display beep].
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a toplevel #GdkSurface
+<parameter_description> a toplevel `GdkSurface`
</parameter_description>
</parameter>
</parameters>
@@ -14231,36 +15042,34 @@ the display just as gdk_display_beep().
<function name="gdk_surface_create_cairo_context">
<description>
-Creates a new #GdkCairoContext for rendering on @surface.
+Creates a new `GdkCairoContext` for rendering on @surface.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GdkCairoContext
+<return> the newly created `GdkCairoContext`
</return>
</function>
<function name="gdk_surface_create_gl_context">
<description>
-Creates a new #GdkGLContext matching the
-framebuffer format to the visual of the #GdkSurface. The context
-is disconnected from any particular surface or surface.
-
-If the creation of the #GdkGLContext failed, @error will be set.
+Creates a new `GdkGLContext` for the `GdkSurface`.
-Before using the returned #GdkGLContext, you will need to
-call gdk_gl_context_make_current() or gdk_gl_context_realize().
+The context is disconnected from any particular surface or surface.
+If the creation of the `GdkGLContext` failed, @error will be set.
+Before using the returned `GdkGLContext`, you will need to
+call [method@Gdk.GLContext.make_current] or [method@Gdk.GLContext.realize].
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
<parameter name="error">
@@ -14268,23 +15077,29 @@ call gdk_gl_context_make_current() or gdk_gl_context_realize().
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GdkGLContext, or
-%NULL on error
+<return> the newly created `GdkGLContext`,
+or %NULL on error
</return>
</function>
<function name="gdk_surface_create_similar_surface">
<description>
-Create a new surface that is as compatible as possible with the
-given @surface. For example the new surface will have the same
-fallback resolution and font options as @surface. Generally, the new
-surface will also use the same backend as @surface, unless that is
-not possible for some reason. The type of the returned surface may
-be examined with cairo_surface_get_type().
+Create a new Cairo surface that is as compatible as possible with the
+given @surface.
+
+For example the new surface will have the same fallback resolution
+and font options as @surface. Generally, the new surface will also
+use the same backend as @surface, unless that is not possible for
+some reason. The type of the returned surface may be examined with
+cairo_surface_get_type().
Initially the surface contents are all 0 (transparent if contents
have transparency, black otherwise.)
+This function always returns a valid pointer, but it will return a
+pointer to a “nil” surface if @other is already in an error state
+or any other error occurs.
+
</description>
<parameters>
@@ -14308,24 +15123,20 @@ have transparency, black otherwise.)
<return> a pointer to the newly allocated surface. The caller
owns the surface and should call cairo_surface_destroy() when done
with it.
-
-This function always returns a valid pointer, but it will return a
-pointer to a “nil” surface if @other is already in an error state
-or any other error occurs.
</return>
</function>
<function name="gdk_surface_create_vulkan_context">
<description>
-Creates a new #GdkVulkanContext for rendering on @surface.
+Creates a new `GdkVulkanContext` for rendering on @surface.
-If the creation of the #GdkVulkanContext failed, @error will be set.
+If the creation of the `GdkVulkanContext` failed, @error will be set.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
<parameter name="error">
@@ -14333,25 +15144,27 @@ If the creation of the #GdkVulkanContext failed, @error will be set.
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GdkVulkanContext, or
+<return> the newly created `GdkVulkanContext`, or
%NULL on error
</return>
</function>
<function name="gdk_surface_destroy">
<description>
-Destroys the window system resources associated with @surface and decrements @surface's
-reference count. The window system resources for all children of @surface are also
-destroyed, but the children’s reference counts are not decremented.
+Destroys the window system resources associated with @surface and
+decrements @surface's reference count.
-Note that a surface will not be destroyed automatically when its reference count
-reaches zero. You must call this function yourself before that happens.
+The window system resources for all children of @surface are also
+destroyed, but the children’s reference counts are not decremented.
+Note that a surface will not be destroyed automatically when its
+reference count reaches zero. You must call this function yourself
+before that happens.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
</parameters>
@@ -14360,80 +15173,83 @@ reaches zero. You must call this function yourself before that happens.
<function name="gdk_surface_get_cursor">
<description>
-Retrieves a #GdkCursor pointer for the cursor currently set on the
-specified #GdkSurface, or %NULL. If the return value is %NULL then
-there is no custom cursor set on the specified surface, and it is
-using the cursor for its parent surface.
+Retrieves a `GdkCursor` pointer for the cursor currently set on the
+`GdkSurface`.
+
+If the return value is %NULL then there is no custom cursor set on
+the surface, and it is using the cursor for its parent surface.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkCursor, or %NULL. The
-returned object is owned by the #GdkSurface and should not be
-unreferenced directly. Use gdk_surface_set_cursor() to unset the
-cursor of the surface
+<return> a `GdkCursor`, or %NULL. The
+returned object is owned by the `GdkSurface` and should not be
+unreferenced directly. Use [method@Gdk.Surface.set_cursor] to
+unset the cursor of the surface
</return>
</function>
<function name="gdk_surface_get_device_cursor">
<description>
-Retrieves a #GdkCursor pointer for the @device currently set on the
-specified #GdkSurface, or %NULL. If the return value is %NULL then
-there is no custom cursor set on the specified surface, and it is
-using the cursor for its parent surface.
+Retrieves a `GdkCursor` pointer for the @device currently set on the
+specified `GdkSurface`.
+
+If the return value is %NULL then there is no custom cursor set on the
+specified surface, and it is using the cursor for its parent surface.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface.
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
<parameter name="device">
-<parameter_description> a logical, pointer #GdkDevice.
+<parameter_description> a pointer `GdkDevice`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkCursor, or %NULL. The
-returned object is owned by the #GdkSurface and should not be
-unreferenced directly. Use gdk_surface_set_cursor() to unset the
-cursor of the surface
+<return> a `GdkCursor`, or %NULL. The
+returned object is owned by the `GdkSurface` and should not be
+unreferenced directly. Use [method@Gdk.Surface.set_cursor] to unset
+the cursor of the surface
</return>
</function>
<function name="gdk_surface_get_device_position">
<description>
-Obtains the current device position in doubles and modifier state.
-The position is given in coordinates relative to the upper left
-corner of @surface.
+Obtains the current device position and modifier state.
+
+The position is given in coordinates relative to the upper
+left corner of @surface.
Return: %TRUE if the device is over the surface
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface.
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
<parameter name="device">
-<parameter_description> pointer #GdkDevice to query to.
+<parameter_description> pointer `GdkDevice` to query to
</parameter_description>
</parameter>
<parameter name="x">
-<parameter_description> return location for the X coordinate of @device, or %NULL.
+<parameter_description> return locatio for the X coordinate of @device, or %NULL
</parameter_description>
</parameter>
<parameter name="y">
-<parameter_description> return location for the Y coordinate of @device, or %NULL.
+<parameter_description> return location for the Y coordinate of @device, or %NULL
</parameter_description>
</parameter>
<parameter name="mask">
-<parameter_description> return location for the modifier mask, or %NULL.
+<parameter_description> return location for the modifier mask, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -14442,25 +15258,26 @@ Return: %TRUE if the device is over the surface
<function name="gdk_surface_get_display">
<description>
-Gets the #GdkDisplay associated with a #GdkSurface.
+Gets the `GdkDisplay` associated with a `GdkSurface`.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkDisplay associated with @surface
+<return> the `GdkDisplay` associated with @surface
</return>
</function>
<function name="gdk_surface_get_frame_clock">
<description>
-Gets the frame clock for the surface. The frame clock for a surface
-never changes unless the surface is reparented to a new toplevel
-surface.
+Gets the frame clock for the surface.
+
+The frame clock for a surface never changes unless the surface is
+reparented to a new toplevel surface.
</description>
@@ -14479,13 +15296,13 @@ surface.
Returns the height of the given @surface.
Surface size is reported in ”application pixels”, not
-”device pixels” (see gdk_surface_get_scale_factor()).
+”device pixels” (see [method@Gdk.Surface.get_scale_factor]).
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
</parameters>
@@ -14495,14 +15312,16 @@ Surface size is reported in ”application pixels”, not
<function name="gdk_surface_get_mapped">
<description>
-Checks whether the surface has been mapped (with gdk_toplevel_present()
-or gdk_popup_present()).
+Checks whether the surface has been mapped.
+
+A surface is mapped with [method@Gdk.Toplevel.present]
+or [method@Gdk.Popup.present].
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
</parameters>
@@ -14513,17 +15332,16 @@ or gdk_popup_present()).
<function name="gdk_surface_get_scale_factor">
<description>
Returns the internal scale factor that maps from surface coordinates
-to the actual device pixels. On traditional systems this is 1, but
-on very high density outputs this can be a higher value (often 2).
+to the actual device pixels.
-A higher value means that drawing is automatically scaled up to
-a higher resolution, so any code doing drawing will automatically look
-nicer. However, if you are supplying pixel-based data the scale
-value can be used to determine whether to use a pixel resource
-with higher resolution data.
+On traditional systems this is 1, but on very high density outputs
+this can be a higher value (often 2). A higher value means that drawing
+is automatically scaled up to a higher resolution, so any code doing
+drawing will automatically look nicer. However, if you are supplying
+pixel-based data the scale value can be used to determine whether to
+use a pixel resource with higher resolution data.
-The scale of a surface may change during runtime, if this happens
-a configure event will be sent to the toplevel surface.
+The scale of a surface may change during runtime.
</description>
@@ -14542,13 +15360,13 @@ a configure event will be sent to the toplevel surface.
Returns the width of the given @surface.
Surface size is reported in ”application pixels”, not
-”device pixels” (see gdk_surface_get_scale_factor()).
+”device pixels” (see [method@Gdk.Surface.get_scale_factor]).
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
</parameters>
@@ -14558,15 +15376,17 @@ Surface size is reported in ”application pixels”, not
<function name="gdk_surface_hide">
<description>
+Hide the surface.
+
For toplevel surfaces, withdraws them, so they will no longer be
known to the window manager; for all surfaces, unmaps them, so
they won’t be displayed. Normally done automatically as
-part of gtk_widget_hide().
+part of [method Gtk Widget hide].
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
</parameters>
@@ -14575,13 +15395,13 @@ part of gtk_widget_hide().
<function name="gdk_surface_is_destroyed">
<description>
-Check to see if a surface is destroyed..
+Check to see if a surface is destroyed.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
</parameters>
@@ -14594,7 +15414,7 @@ Check to see if a surface is destroyed..
Create a new popup surface.
The surface will be attached to @parent and can be positioned
-relative to it using gdk_popup_present().
+relative to it using [method@Gdk.Popup.present].
</description>
@@ -14608,7 +15428,7 @@ relative to it using gdk_popup_present().
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkSurface
+<return> a new `GdkSurface`
</return>
</function>
@@ -14624,13 +15444,13 @@ Creates a new toplevel surface.
</parameter_description>
</parameter>
</parameters>
-<return> the new #GdkSurface
+<return> the new `GdkSurface`
</return>
</function>
<function name="gdk_surface_queue_render">
<description>
-Forces a #GdkSurface::render signal emission for @surface
+Forces a [signal@Gdk.Surface::render] signal emission for @surface
to be scheduled.
This function is useful for implementations that track invalid
@@ -14639,7 +15459,7 @@ regions on their own.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
</parameters>
@@ -14648,13 +15468,14 @@ regions on their own.
<function name="gdk_surface_request_layout">
<description>
-Request a %GDK_FRAME_CLOCK_PHASE_LAYOUT from the surface's
-frame clock. See gdk_frame_clock_request_phase().
+Request a layout phase from the surface's frame clock.
+
+See [method@Gdk.FrameClock.request_phase].
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
</parameters>
@@ -14663,24 +15484,23 @@ frame clock. See gdk_frame_clock_request_phase().
<function name="gdk_surface_set_cursor">
<description>
-Sets the default mouse pointer for a #GdkSurface.
+Sets the default mouse pointer for a `GdkSurface`.
+Passing %NULL for the @cursor argument means that @surface will use
+the cursor of its parent surface. Most surfaces should use this default.
Note that @cursor must be for the same display as @surface.
-Use gdk_cursor_new_from_name() or gdk_cursor_new_from_texture() to
-create the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR.
-Passing %NULL for the @cursor argument to gdk_surface_set_cursor() means
-that @surface will use the cursor of its parent surface. Most surfaces
-should use this default.
+Use [ctor@Gdk.Cursor.new_from_name] or [ctor@Gdk.Cursor.new_from_texture]
+to create the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
<parameter name="cursor">
-<parameter_description> a cursor
+<parameter_description> a `GdkCursor`
</parameter_description>
</parameter>
</parameters>
@@ -14689,25 +15509,26 @@ should use this default.
<function name="gdk_surface_set_device_cursor">
<description>
-Sets a specific #GdkCursor for a given device when it gets inside @surface.
-Use gdk_cursor_new_from_name() or gdk_cursor_new_from_texture() to create
-the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR. Passing
-%NULL for the @cursor argument to gdk_surface_set_cursor() means that
-@surface will use the cursor of its parent surface. Most surfaces should
-use this default.
+Sets a specific `GdkCursor` for a given device when it gets inside @surface.
+
+Passing %NULL for the @cursor argument means that @surface will use the
+cursor of its parent surface. Most surfaces should use this default.
+
+Use [ctor@Gdk.Cursor.new_from_name] or [ctor@Gdk.Cursor.new_from_texture]
+to create the cursor. To make the cursor invisible, use %GDK_BLANK_CURSOR.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
<parameter name="device">
-<parameter_description> a logical, pointer #GdkDevice
+<parameter_description> a pointer `GdkDevice`
</parameter_description>
</parameter>
<parameter name="cursor">
-<parameter_description> a #GdkCursor
+<parameter_description> a `GdkCursor`
</parameter_description>
</parameter>
</parameters>
@@ -14717,23 +15538,24 @@ use this default.
<function name="gdk_surface_set_input_region">
<description>
Apply the region to the surface for the purpose of event
-handling. Mouse events which happen while the pointer position
-corresponds to an unset bit in the mask will be passed on the
-surface below @surface.
+handling.
-An input region is typically used with RGBA surfaces.
-The alpha channel of the surface defines which pixels are
-invisible and allows for nicely antialiased borders,
-and the input region controls where the surface is
-“clickable”.
+Mouse events which happen while the pointer position corresponds
+to an unset bit in the mask will be passed on the surface below
+@surface.
-Use gdk_display_supports_input_shapes() to find out if
+An input region is typically used with RGBA surfaces. The alpha
+channel of the surface defines which pixels are invisible and
+allows for nicely antialiased borders, and the input region
+controls where the surface is “clickable”.
+
+Use [method@Gdk.Display.supports_input_shapes] to find out if
a particular backend supports input regions.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
<parameter name="region">
@@ -14746,6 +15568,8 @@ a particular backend supports input regions.
<function name="gdk_surface_set_opaque_region">
<description>
+Marks a region of the `GdkSurface` as opaque.
+
For optimisation purposes, compositing window managers may
like to not draw obscured regions of surfaces, or turn off blending
during for these regions. With RGB windows with no transparency,
@@ -14755,15 +15579,15 @@ or not.
This function only works for toplevel surfaces.
-GTK will update this property automatically if
-the @surface background is opaque, as we know where the opaque regions
-are. If your surface background is not opaque, please update this
-property in your #GtkWidgetClass.css_changed() handler.
+GTK will update this property automatically if the @surface background
+is opaque, as we know where the opaque regions are. If your surface
+background is not opaque, please update this property in your
+#GtkWidgetClass.css_changed() handler.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a top-level or non-native #GdkSurface
+<parameter_description> a top-level `GdkSurface`
</parameter_description>
</parameter>
<parameter name="region">
@@ -14776,13 +15600,10 @@ property in your #GtkWidgetClass.css_changed() handler.
<function name="gdk_surface_translate_coordinates">
<description>
-Translates the given coordinates from being
-relative to the @from surface to being relative
-to the @to surface.
+Translates coordinates between two surfaces.
-Note that this only works if @to and @from are
-popups or transient-for to the same toplevel
-(directly or indirectly).
+Note that this only works if @to and @from are popups or
+transient-for to the same toplevel (directly or indirectly).
</description>
@@ -14804,23 +15625,23 @@ popups or transient-for to the same toplevel
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the coordinates were successfully
-translated
+<return> %TRUE if the coordinates were successfully translated
</return>
</function>
<function name="gdk_texture_download">
<description>
-Downloads the @texture into local memory. This may be
-an expensive operation, as the actual texture data may
-reside on a GPU or on a remote display server.
+Downloads the @texture into local memory.
+
+This may be an expensive operation, as the actual texture data
+may reside on a GPU or on a remote display server.
The data format of the downloaded data is equivalent to
%CAIRO_FORMAT_ARGB32, so every downloaded pixel requires
4 bytes of memory.
Downloading a texture into a Cairo image surface:
-|[<!-- language="C" -->
+```c
surface = cairo_image_surface_create (CAIRO_FORMAT_ARGB32,
gdk_texture_get_width (texture),
gdk_texture_get_height (texture));
@@ -14828,12 +15649,12 @@ gdk_texture_download (texture,
cairo_image_surface_get_data (surface),
cairo_image_surface_get_stride (surface));
cairo_surface_mark_dirty (surface);
-]|
+```
</description>
<parameters>
<parameter name="texture">
-<parameter_description> a #GdkTexture
+<parameter_description> a `GdkTexture`
</parameter_description>
</parameter>
<parameter name="data">
@@ -14857,11 +15678,11 @@ Returns the height of the @texture, in pixels.
</description>
<parameters>
<parameter name="texture">
-<parameter_description> a #GdkTexture
+<parameter_description> a `GdkTexture`
</parameter_description>
</parameter>
</parameters>
-<return> the height of the #GdkTexture
+<return> the height of the `GdkTexture`
</return>
</function>
@@ -14873,33 +15694,34 @@ Returns the width of @texture, in pixels.
</description>
<parameters>
<parameter name="texture">
-<parameter_description> a #GdkTexture
+<parameter_description> a `GdkTexture`
</parameter_description>
</parameter>
</parameters>
-<return> the width of the #GdkTexture
+<return> the width of the `GdkTexture`
</return>
</function>
<function name="gdk_texture_new_for_pixbuf">
<description>
-Creates a new texture object representing the #GdkPixbuf.
+Creates a new texture object representing the `GdkPixbuf`.
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
+<parameter_description> a `GdkPixbuf`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkTexture
+<return> a new `GdkTexture`
</return>
</function>
<function name="gdk_texture_new_for_surface">
<description>
Creates a new texture object representing the surface.
+
@surface must be an image surface with format CAIRO_FORMAT_ARGB32.
@@ -14910,16 +15732,16 @@ Creates a new texture object representing the surface.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkTexture
+<return> a new `GdkTexture`
</return>
</function>
<function name="gdk_texture_new_from_file">
<description>
Creates a new texture by loading an image from a file.
-The file format is detected automatically, and can be any
-format that is supported by the gdk-pixbuf library, such as
-JPEG or PNG.
+
+The file format is detected automatically. The supported formats
+are PNG and JPEG, though more formats might be available.
If %NULL is returned, then @error will be set.
@@ -14927,7 +15749,7 @@ If %NULL is returned, then @error will be set.
</description>
<parameters>
<parameter name="file">
-<parameter_description> #GFile to load
+<parameter_description> `GFile` to load
</parameter_description>
</parameter>
<parameter name="error">
@@ -14935,21 +15757,21 @@ If %NULL is returned, then @error will be set.
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created #GdkTexture or %NULL if an error occurred.
+<return> A newly-created `GdkTexture` or %NULL if an error occurred.
</return>
</function>
<function name="gdk_texture_new_from_resource">
<description>
Creates a new texture by loading an image from a resource.
-The file format is detected automatically, and can be any
-format that is supported by the gdk-pixbuf library, such as
-JPEG or PNG.
+
+The file format is detected automatically. The supported formats
+are PNG and JPEG, though more formats might be available.
It is a fatal error if @resource_path does not specify a valid
image resource and the program will abort if that happens.
If you are unsure about the validity of a resource, use
-gdk_texture_new_from_file() to load it.
+[ctor@Gdk.Texture.new_from_file] to load it.
</description>
@@ -14959,7 +15781,7 @@ gdk_texture_new_from_file() to load it.
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created texture
+<return> A newly-created `GdkTexture`
</return>
</function>
@@ -14969,14 +15791,14 @@ Store the given @texture to the @filename as a PNG file.
This is a utility function intended for debugging and testing.
If you want more control over formats, proper error handling or
-want to store to a #GFile or other location, you might want to
+want to store to a `GFile` or other location, you might want to
look into using the gdk-pixbuf library.
</description>
<parameters>
<parameter name="texture">
-<parameter_description> a #GdkTexture
+<parameter_description> a `GdkTexture`
</parameter_description>
</parameter>
<parameter name="filename">
@@ -14990,7 +15812,8 @@ look into using the gdk-pixbuf library.
<function name="gdk_toplevel_begin_move">
<description>
-Begins an interactive move operation (for a toplevel surface).
+Begins an interactive move operation.
+
You might use this function to implement draggable titlebars.
</description>
@@ -15016,7 +15839,8 @@ You might use this function to implement draggable titlebars.
</parameter_description>
</parameter>
<parameter name="timestamp">
-<parameter_description> timestamp of mouse click that began the drag
+<parameter_description> timestamp of mouse click that began the drag (use
+[method@Gdk.Event.get_time])
</parameter_description>
</parameter>
</parameters>
@@ -15025,13 +15849,14 @@ You might use this function to implement draggable titlebars.
<function name="gdk_toplevel_begin_resize">
<description>
-Begins an interactive resize operation (for a toplevel surface).
+Begins an interactive resize operation.
+
You might use this function to implement a “window resize grip.”
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> a #GdkToplevel
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
<parameter name="edge">
@@ -15055,7 +15880,8 @@ You might use this function to implement a “window resize grip.”
</parameter_description>
</parameter>
<parameter name="timestamp">
-<parameter_description> timestamp of mouse click that began the drag (use gdk_event_get_time())
+<parameter_description> timestamp of mouse click that began the drag (use
+[method@Gdk.Event.get_time])
</parameter_description>
</parameter>
</parameters>
@@ -15066,13 +15892,13 @@ You might use this function to implement a “window resize grip.”
<description>
Sets keyboard focus to @surface.
-In most cases, gtk_window_present_with_time() should be used
-on a #GtkWindow, rather than calling this function.
+In most cases, [method@Gtk.Window.present_with_time] should be
+used on a [class@Gtk.Window], rather than calling this function.
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> a #GdkToplevel
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
<parameter name="timestamp">
@@ -15085,14 +15911,14 @@ on a #GtkWindow, rather than calling this function.
<function name="gdk_toplevel_get_state">
<description>
-Gets the bitwise OR of the currently active surface state flags,
-from the #GdkToplevelState enumeration.
+Gets the bitwise or of the currently active surface state flags,
+from the `GdkToplevelState` enumeration.
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> a #GdkToplevel
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
</parameters>
@@ -15102,13 +15928,14 @@ from the #GdkToplevelState enumeration.
<function name="gdk_toplevel_inhibit_system_shortcuts">
<description>
-Requests that the @toplevel inhibit the system shortcuts, asking the
-desktop environment/windowing system to let all keyboard events reach
-the surface, as long as it is focused, instead of triggering system
-actions.
+Requests that the @toplevel inhibit the system shortcuts.
+
+This is asking the desktop environment/windowing system to let all
+keyboard events reach the surface, as long as it is focused, instead
+of triggering system actions.
If granted, the rerouting remains active until the default shortcuts
-processing is restored with gdk_toplevel_restore_system_shortcuts(),
+processing is restored with [method@Gdk.Toplevel.restore_system_shortcuts],
or the request is revoked by the desktop environment, windowing system
or the user.
@@ -15121,18 +15948,17 @@ The windowing system or desktop environment may ask the user to grant
or deny the request or even choose to ignore the request entirely.
The caller can be notified whenever the request is granted or revoked
-by listening to the GdkToplevel::shortcuts-inhibited property.
-
+by listening to the [property@Gdk.Toplevel:shortcuts-inhibited] property.
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> the #GdkToplevel requesting system keyboard shortcuts
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
<parameter name="event">
-<parameter_description> the #GdkEvent that is triggering the inhibit
-request, or %NULL if none is available.
+<parameter_description> the `GdkEvent` that is triggering the inhibit
+request, or %NULL if none is available
</parameter_description>
</parameter>
</parameters>
@@ -15373,7 +16199,7 @@ The windowing system may choose to ignore the request.
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> a #GdkToplevel
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
</parameters>
@@ -15391,7 +16217,7 @@ The windowing system may choose to ignore the request.
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> a #GdkToplevel
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
</parameters>
@@ -15401,13 +16227,14 @@ The windowing system may choose to ignore the request.
<function name="gdk_toplevel_present">
<description>
-Present @toplevel after having processed the #GdkToplevelLayout rules.
+Present @toplevel after having processed the `GdkToplevelLayout` rules.
+
If the toplevel was previously not showing, it will be showed,
otherwise it will change layout according to @layout.
-GDK may emit the 'compute-size' signal to let the user of this toplevel
-compute the preferred size of the toplevel surface. See
-#GdkToplevel::compute-size for details.
+GDK may emit the [signal@Gdk.Toplevel::compute-size] signal to let
+the user of this toplevel compute the preferred size of the toplevel
+surface.
Presenting is asynchronous and the specified layout parameters are not
guaranteed to be respected.
@@ -15415,11 +16242,11 @@ guaranteed to be respected.
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> the #GdkToplevel to show
+<parameter_description> the `GdkToplevel` to show
</parameter_description>
</parameter>
<parameter name="layout">
-<parameter_description> the #GdkToplevelLayout object used to layout
+<parameter_description> the `GdkToplevelLayout` object used to layout
</parameter_description>
</parameter>
</parameters>
@@ -15429,12 +16256,14 @@ guaranteed to be respected.
<function name="gdk_toplevel_restore_system_shortcuts">
<description>
Restore default system keyboard shortcuts which were previously
-requested to be inhibited by gdk_toplevel_inhibit_system_shortcuts().
+inhibited.
+
+This undoes the effect of [method@Gdk.Toplevel.inhibit_system_shortcuts].
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> a #GdkToplevel
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
</parameters>
@@ -15443,6 +16272,8 @@ requested to be inhibited by gdk_toplevel_inhibit_system_shortcuts().
<function name="gdk_toplevel_set_decorated">
<description>
+Sets the toplevel to be decorated.
+
Setting @decorated to %FALSE hints the desktop environment
that the surface has its own, client-side decorations and
does not need to have window decorations added.
@@ -15450,7 +16281,7 @@ does not need to have window decorations added.
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> a #GdkToplevel
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
<parameter name="decorated">
@@ -15463,13 +16294,15 @@ does not need to have window decorations added.
<function name="gdk_toplevel_set_deletable">
<description>
+Sets the toplevel to be deletable.
+
Setting @deletable to %TRUE hints the desktop environment
that it should offer the user a way to close the surface.
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> a #GdkToplevel
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
<parameter name="deletable">
@@ -15495,7 +16328,7 @@ Note that some platforms don't support surface icons.
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> a #GdkToplevel
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
<parameter name="surfaces">
@@ -15509,18 +16342,20 @@ A list of textures to use as icon, of different sizes
<function name="gdk_toplevel_set_modal">
<description>
+Sets the toplevel to be modal.
+
The application can use this hint to tell the
window manager that a certain surface has modal
behaviour. The window manager can use this information
to handle modal surfaces in a special way.
You should only use this on surfaces for which you have
-previously called gdk_toplevel_set_transient_for().
+previously called [method@Gdk.Toplevel.set_transient_for].
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> A toplevel surface
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
<parameter name="modal">
@@ -15533,13 +16368,16 @@ previously called gdk_toplevel_set_transient_for().
<function name="gdk_toplevel_set_startup_id">
<description>
-When using GTK, typically you should use gtk_window_set_startup_id()
-instead of this low-level function.
+Sets the startup notification ID.
+
+When using GTK, typically you should use
+[method@Gtk.Window.set_startup_id] instead of this
+low-level function.
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> a #GdkToplevel
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
<parameter name="startup_id">
@@ -15552,13 +16390,15 @@ instead of this low-level function.
<function name="gdk_toplevel_set_title">
<description>
-Sets the title of a toplevel surface, to be displayed in the titlebar,
+Sets the title of a toplevel surface.
+
+The title maybe be displayed in the titlebar,
in lists of windows, etc.
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> a #GdkToplevel
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
<parameter name="title">
@@ -15571,22 +16411,24 @@ in lists of windows, etc.
<function name="gdk_toplevel_set_transient_for">
<description>
-Indicates to the window manager that @surface is a transient dialog
-associated with the application surface @parent. This allows the
-window manager to do things like center @surface on @parent and
-keep @surface above @parent.
+Sets a transient-for parent.
-See gtk_window_set_transient_for() if you’re using #GtkWindow or
-#GtkDialog.
+Indicates to the window manager that @surface is a transient
+dialog associated with the application surface @parent. This
+allows the window manager to do things like center @surface
+on @parent and keep @surface above @parent.
+
+See [method@Gtk.Window.set_transient_for] if you’re using
+[class@Gtk.Window] or [class@Gtk.Dialog].
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> a #GdkToplevel
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
<parameter name="parent">
-<parameter_description> another toplevel #GdkSurface
+<parameter_description> another toplevel `GdkSurface`
</parameter_description>
</parameter>
</parameters>
@@ -15606,11 +16448,11 @@ right-click on the window decorations.
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> a #GdkToplevel
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
<parameter name="event">
-<parameter_description> a #GdkEvent to show the menu for
+<parameter_description> a `GdkEvent` to show the menu for
</parameter_description>
</parameter>
</parameters>
@@ -15631,7 +16473,7 @@ toplevel can be presented.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GdkToplevelSize
+<parameter_description> a `GdkToplevelSize`
</parameter_description>
</parameter>
<parameter name="bounds_width">
@@ -15648,18 +16490,20 @@ toplevel can be presented.
<function name="gdk_toplevel_size_set_min_size">
<description>
+Sets the minimum size of the toplevel.
+
The minimum size corresponds to the limitations the toplevel can be shrunk
-to, without resulting in incorrect painting. A user of a #GdkToplevel should
+to, without resulting in incorrect painting. A user of a `GdkToplevel` should
calculate these given both the existing size, and the bounds retrieved from
-the #GdkToplevelSize object.
+the `GdkToplevelSize` object.
The minimum size should be within the bounds (see
-gdk_toplevel_size_get_bounds()).
+[method@Gdk.ToplevelSize.get_bounds]).
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GdkToplevelSize
+<parameter_description> a `GdkToplevelSize`
</parameter_description>
</parameter>
<parameter name="min_width">
@@ -15676,6 +16520,8 @@ gdk_toplevel_size_get_bounds()).
<function name="gdk_toplevel_size_set_shadow_width">
<description>
+Sets the shadows size of the toplevel.
+
The shadow width corresponds to the part of the computed surface size
that would consist of the shadow margin surrounding the window, would
there be any.
@@ -15683,7 +16529,7 @@ there be any.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GdkToplevelSize
+<parameter_description> a `GdkToplevelSize`
</parameter_description>
</parameter>
<parameter name="left">
@@ -15708,15 +16554,17 @@ there be any.
<function name="gdk_toplevel_size_set_size">
<description>
-Sets the size the toplevel prefers to be resized to. The size should be
-within the bounds (see gdk_toplevel_size_get_bounds()). The set size should
-be considered as a hint, and should not be assumed to be respected by the
-windowing system, or backend.
+Sets the size the toplevel prefers to be resized to.
+
+The size should be within the bounds (see
+[method@Gdk.ToplevelSize.get_bounds]). The set size should
+be considered as a hint, and should not be assumed to be
+respected by the windowing system, or backend.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GdkToplevelSize
+<parameter_description> a `GdkToplevelSize`
</parameter_description>
</parameter>
<parameter name="width">
@@ -15740,7 +16588,7 @@ tiled window states.
</description>
<parameters>
<parameter name="toplevel">
-<parameter_description> a #GdkToplevel
+<parameter_description> a `GdkToplevel`
</parameter_description>
</parameter>
</parameters>
@@ -15795,7 +16643,7 @@ Extracts the touchpad gesture phase from a touchpad event.
</description>
<parameters>
<parameter name="event">
-<parameter_description> a touchpad #GdkEvent
+<parameter_description> a touchpad event
</parameter_description>
</parameter>
</parameters>
@@ -15853,19 +16701,18 @@ Extracts the scale from a touchpad pinch event.
<function name="gdk_unicode_to_keyval">
<description>
-Convert from a ISO10646 character to a key symbol.
+Convert from a Unicode character to a key symbol.
</description>
<parameters>
<parameter name="wc">
-<parameter_description> a ISO10646 encoded character
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
<return> the corresponding GDK key symbol, if one exists.
-or, if there is no corresponding symbol,
-wc | 0x01000000
+or, if there is no corresponding symbol, wc | 0x01000000
</return>
</function>
@@ -15889,14 +16736,14 @@ Gets the Vulkan device that this context is using.
<description>
Gets the index of the image that is currently being drawn.
-This function can only be used between gdk_draw_context_begin_frame() and
-gdk_draw_context_end_frame() calls.
+This function can only be used between [method@Gdk.DrawContext.begin_frame]
+and [method@Gdk.DrawContext.end_frame] calls.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkVulkanContext
+<parameter_description> a `GdkVulkanContext`
</parameter_description>
</parameter>
</parameters>
@@ -15909,14 +16756,14 @@ gdk_draw_context_end_frame() calls.
Gets the Vulkan semaphore that protects access to the image that is
currently being drawn.
-This function can only be used between gdk_draw_context_begin_frame() and
-gdk_draw_context_end_frame() calls.
+This function can only be used between [method@Gdk.DrawContext.begin_frame]
+and [method@Gdk.DrawContext.end_frame] calls.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkVulkanContext
+<parameter_description> a `GdkVulkanContext`
</parameter_description>
</parameter>
</parameters>
@@ -15932,7 +16779,7 @@ Gets the image with index @id that this context is using.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkVulkanContext
+<parameter_description> a `GdkVulkanContext`
</parameter_description>
</parameter>
<parameter name="id">
@@ -15952,7 +16799,7 @@ Gets the image format that this context is using.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkVulkanContext
+<parameter_description> a `GdkVulkanContext`
</parameter_description>
</parameter>
</parameters>
@@ -15968,7 +16815,7 @@ Gets the Vulkan instance that is associated with @context.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkVulkanContext
+<parameter_description> a `GdkVulkanContext`
</parameter_description>
</parameter>
</parameters>
@@ -15984,7 +16831,7 @@ Gets the number of images that this context is using in its swap chain.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkVulkanContext
+<parameter_description> a `GdkVulkanContext`
</parameter_description>
</parameter>
</parameters>
@@ -16000,7 +16847,7 @@ Gets the Vulkan physical device that this context is using.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkVulkanContext
+<parameter_description> a `GdkVulkanContext`
</parameter_description>
</parameter>
</parameters>
@@ -16016,7 +16863,7 @@ Gets the Vulkan queue that this context is using.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkVulkanContext
+<parameter_description> a `GdkVulkanContext`
</parameter_description>
</parameter>
</parameters>
@@ -16027,13 +16874,14 @@ Gets the Vulkan queue that this context is using.
<function name="gdk_vulkan_context_get_queue_family_index">
<description>
Gets the family index for the queue that this context is using.
+
See vkGetPhysicalDeviceQueueFamilyProperties().
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkVulkanContext
+<parameter_description> a `GdkVulkanContext`
</parameter_description>
</parameter>
</parameters>
diff --git a/gdk/src/gdk_methods.defs b/gdk/src/gdk_methods.defs
index 1247d202..fd9ff1ed 100644
--- a/gdk/src/gdk_methods.defs
+++ b/gdk/src/gdk_methods.defs
@@ -1530,6 +1530,12 @@
)
)
+(define-method get_timestamp
+ (of-object "GdkDevice")
+ (c-name "gdk_device_get_timestamp")
+ (return-type "guint32")
+)
+
;; From gdkdevicepad.h
@@ -3383,6 +3389,30 @@
)
)
+(define-method set_shadow_width
+ (of-object "GdkPopupLayout")
+ (c-name "gdk_popup_layout_set_shadow_width")
+ (return-type "none")
+ (parameters
+ '("int" "left")
+ '("int" "right")
+ '("int" "top")
+ '("int" "bottom")
+ )
+)
+
+(define-method get_shadow_width
+ (of-object "GdkPopupLayout")
+ (c-name "gdk_popup_layout_get_shadow_width")
+ (return-type "none")
+ (parameters
+ '("int*" "left")
+ '("int*" "right")
+ '("int*" "top")
+ '("int*" "bottom")
+ )
+)
+
;; From gdkrectangle.h
diff --git a/gdk/src/gdk_signals.defs b/gdk/src/gdk_signals.defs
index 7a5223c4..d25b127f 100644
--- a/gdk/src/gdk_signals.defs
+++ b/gdk/src/gdk_signals.defs
@@ -977,6 +977,15 @@
;; From GdkSurface
+(define-signal event
+ (of-object "GdkSurface")
+ (return-type "gboolean")
+ (flags "Run Last")
+ (parameters
+ '("GdkEvent*" "p0")
+ )
+)
+
(define-signal layout
(of-object "GdkSurface")
(return-type "void")
@@ -996,15 +1005,6 @@
)
)
-(define-signal event
- (of-object "GdkSurface")
- (return-type "gboolean")
- (flags "Run Last")
- (parameters
- '("GdkEvent*" "p0")
- )
-)
-
(define-signal enter-monitor
(of-object "GdkSurface")
(return-type "void")
@@ -1080,6 +1080,16 @@
(default-value "0")
)
+(define-property scale-factor
+ (of-object "GdkSurface")
+ (prop-type "GParamInt")
+ (docs "Scale factor")
+ (readable #t)
+ (writable #f)
+ (construct-only #f)
+ (default-value "1")
+)
+
;; From GdkTexture
(define-property width
diff --git a/gtk/src/gtk_docs.xml b/gtk/src/gtk_docs.xml
index 9c70aef6..8ddcebfb 100644
--- a/gtk/src/gtk_docs.xml
+++ b/gtk/src/gtk_docs.xml
@@ -2,12 +2,12 @@
<signal name="GtkATContext::state-change">
<description>
Emitted when the attributes of the accessible for the
-#GtkATContext instance change.
+`GtkATContext` instance change.
</description>
<parameters>
<parameter name="self">
-<parameter_description> the #GtkATContext
+<parameter_description> the `GtkATContext`
</parameter_description>
</parameter>
</parameters>
@@ -16,7 +16,7 @@ Emitted when the attributes of the accessible for the
<property name="GtkATContext:accessible">
<description>
-The #GtkAccessible that created the #GtkATContext instance.
+The `GtkAccessible` that created the `GtkATContext` instance.
</description>
</property>
@@ -33,16 +33,17 @@ set or retrieved.
<property name="GtkATContext:display">
<description>
-The #GdkDisplay for the #GtkATContext.
+The `GdkDisplay` for the `GtkATContext`.
</description>
</property>
<signal name="GtkAboutDialog::activate-link">
<description>
-The signal which gets emitted to activate a URI.
+Emitted every time a URL is activated.
+
Applications may connect to it to override the default behaviour,
-which is to call gtk_show_uri().
+which is to call [func@Gtk.show_uri].
</description>
@@ -56,22 +57,25 @@ which is to call gtk_show_uri().
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the link has been activated
+<return> `TRUE` if the link has been activated
</return>
</signal>
<property name="GtkAboutDialog:artists">
<description>
-The people who contributed artwork to the program, as a %NULL-terminated
-array of strings. Each string may contain email addresses and URLs, which
-will be displayed as links, see the introduction for more details.
+The people who contributed artwork to the program, as a `NULL`-terminated
+array of strings.
+
+Each string may contain email addresses and URLs, which will be displayed
+as links.
</description>
</property>
<property name="GtkAboutDialog:authors">
<description>
-The authors of the program, as a %NULL-terminated array of strings.
+The authors of the program, as a `NULL`-terminated array of strings.
+
Each string may contain email addresses and URLs, which will be displayed
as links, see the introduction for more details.
@@ -80,9 +84,11 @@ as links, see the introduction for more details.
<property name="GtkAboutDialog:comments">
<description>
-Comments about the program. This string is displayed in a label
-in the main dialog, thus it should be a short explanation of
-the main purpose of the program, not a detailed list of features.
+Comments about the program.
+
+This string is displayed in a label in the main dialog, thus it
+should be a short explanation of the main purpose of the program,
+not a detailed list of features.
</description>
</property>
@@ -96,7 +102,8 @@ Copyright information for the program.
<property name="GtkAboutDialog:documenters">
<description>
-The people documenting the program, as a %NULL-terminated array of strings.
+The people documenting the program, as a `NULL`-terminated array of strings.
+
Each string may contain email addresses and URLs, which will be displayed
as links, see the introduction for more details.
@@ -105,17 +112,19 @@ as links, see the introduction for more details.
<property name="GtkAboutDialog:license">
<description>
-The license of the program. This string is displayed in a
-text view in a secondary dialog, therefore it is fine to use
-a long multi-paragraph text. Note that the text is only wrapped
-in the text view if the "wrap-license" property is set to %TRUE;
+The license of the program, as free form text.
+
+This string is displayed in a text view in a secondary dialog, therefore
+it is fine to use a long multi-paragraph text. Note that the text is only
+wrapped in the text view if the "wrap-license" property is set to `TRUE`;
otherwise the text itself must contain the intended linebreaks.
-When setting this property to a non-%NULL value, the
-#GtkAboutDialog:license-type property is set to %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
+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.
+
+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
be converted into clickable links.
</description>
@@ -123,20 +132,20 @@ be converted into clickable links.
<property name="GtkAboutDialog:license-type">
<description>
-The license of the program, as a value of the %GtkLicense enumeration.
+The license of the program.
-The #GtkAboutDialog will automatically fill out a standard disclaimer
+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
-specified in the #GtkAboutDialog:website property.
+If `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
-#GtkAboutDialog:license property are used.
+If `GTK_LICENSE_CUSTOM` is used, the current contents of the
+[property@Gtk.AboutDialog:license] property are used.
-For any other #GtkLicense value, the contents of the
-#GtkAboutDialog:license property are also set by this property as
+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.
</description>
@@ -144,16 +153,19 @@ a side effect.
<property name="GtkAboutDialog:logo">
<description>
-A logo for the about box. If it is %NULL, the default window icon
-set with gtk_window_set_default_icon_name() will be used.
+A logo for the about box.
+
+If it is `NULL`, the default window icon set with
+[id@gtk_window_set_default_icon_name] will be used.
</description>
</property>
<property name="GtkAboutDialog:logo-icon-name">
<description>
-A named icon to use as the logo for the about box. This property
-overrides the #GtkAboutDialog:logo property.
+A named icon to use as the logo for the about box.
+
+This property overrides the [property@Gtk.AboutDialog:logo] property.
</description>
</property>
@@ -161,7 +173,8 @@ overrides the #GtkAboutDialog:logo property.
<property name="GtkAboutDialog:program-name">
<description>
The name of the program.
-If this is not set, it defaults to g_get_application_name().
+
+If this is not set, it defaults to `g_get_application_name()`.
</description>
</property>
@@ -169,12 +182,13 @@ If this is not set, it defaults to g_get_application_name().
<property name="GtkAboutDialog:system-information">
<description>
Information about the system on which the program is running.
-This is displayed in a separate tab, therefore it is fine to use
-a long multi-paragraph text. Note that the text should contain
+
+This information is displayed in a separate tab, therefore it is fine
+to use a long multi-paragraph text. Note that the text should contain
the intended linebreaks.
-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
+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
be converted into clickable links.
</description>
@@ -182,7 +196,10 @@ be converted into clickable links.
<property name="GtkAboutDialog:translator-credits">
<description>
-Credits to the translators. This string should be marked as translatable.
+Credits to the translators.
+
+This string should be marked as translatable.
+
The string may contain email addresses and URLs, which will be displayed
as links, see the introduction for more details.
@@ -199,7 +216,8 @@ The version of the program.
<property name="GtkAboutDialog:website">
<description>
The URL for the link to the website of the program.
-This should be a string starting with "http://.
+
+This should be a string starting with `http://` or `https://`.
</description>
</property>
@@ -220,7 +238,7 @@ Whether to wrap the text in the license dialog.
<property name="GtkAccessible:accessible-role">
<description>
-The accessible role of the given #GtkAccessible implementation.
+The accessible role of the given `GtkAccessible` implementation.
The accessible role cannot be changed once set.
@@ -293,7 +311,7 @@ as %FALSE and %TRUE.
<enum name="GtkAccessibleProperty">
<description>
-The possible accessible properties of a #GtkAccessible.
+The possible accessible properties of a `GtkAccessible`.
</description>
<parameters>
@@ -406,7 +424,8 @@ of aria-valuenow for a range widget. Value type: string
<enum name="GtkAccessibleRelation">
<description>
-The possible accessible relations of a #GtkAccessible.
+The possible accessible relations of a `GtkAccessible`.
+
Accessible relations can be references to other widgets,
integers or strings.
@@ -514,7 +533,7 @@ set of listitems or treeitems. Value type: integer
<enum name="GtkAccessibleRole">
<description>
-The accessible role for a #GtkAccessible implementation.
+The accessible role for a `GtkAccessible` implementation.
Abstract roles are only used as part of the ontology; application
developers must not use abstract roles in their code.
@@ -885,7 +904,7 @@ descending has been applied.
<enum name="GtkAccessibleState">
<description>
-The possible accessible states of a #GtkAccessible.
+The possible accessible states of a `GtkAccessible`.
</description>
<parameters>
@@ -963,10 +982,20 @@ as %FALSE and %TRUE.
</parameters>
</enum>
+<property name="GtkActionBar:revealed">
+<description>
+Controls whether the action bar shows its contents.
+
+</description>
+</property>
+
<signal name="GtkAdjustment::changed">
<description>
-Emitted when one or more of the #GtkAdjustment properties have been
-changed, other than the #GtkAdjustment:value property.
+Emitted when one or more of the `GtkAdjustment` properties have been
+changed.
+
+Note that the [property@Gtk.Adjustment:value] property is
+covered by the [signal@Gtk.Adjustment::value-changed] signal.
</description>
<parameters>
@@ -980,7 +1009,7 @@ changed, other than the #GtkAdjustment:value property.
<signal name="GtkAdjustment::value-changed">
<description>
-Emitted when the #GtkAdjustment:value property has been changed.
+Emitted when the value has been changed.
</description>
<parameters>
@@ -1009,9 +1038,10 @@ The page increment of the adjustment.
<property name="GtkAdjustment:page-size">
<description>
The page size of the adjustment.
+
Note that the page-size is irrelevant and should be set to zero
if the adjustment is used for a simple scalar value, e.g. in a
-#GtkSpinButton.
+`GtkSpinButton`.
</description>
</property>
@@ -1026,8 +1056,8 @@ The step increment of the adjustment.
<property name="GtkAdjustment:upper">
<description>
The maximum value of the adjustment.
-Note that values will be restricted by
-`upper - page-size` if the page-size
+
+Note that values will be restricted by `upper - page-size` if the page-size
property is nonzero.
</description>
@@ -1042,12 +1072,11 @@ The value of the adjustment.
<enum name="GtkAlign">
<description>
-Controls how a widget deals with extra space in a single (x or y)
-dimension.
+Controls how a widget deals with extra space in a single dimension.
Alignment only matters if the widget receives a “too large” allocation,
-for example if you packed the widget with the #GtkWidget:hexpand
-property inside a #GtkBox, then the widget might get extra space.
+for example if you packed the widget with the [property@Gtk.Widget:hexpand]
+property inside a `GtkBox`, then the widget might get extra space.
If you have for example a 16x16 icon inside a 32x32 space, the icon
could be scaled and stretched, it could be centered, or it could be
positioned to one side of the space.
@@ -1091,32 +1120,30 @@ allocation
<property name="GtkAlternativeTrigger:first">
<description>
-The first #GtkShortcutTrigger to check.
+The first `GtkShortcutTrigger` to check.
</description>
</property>
<property name="GtkAlternativeTrigger:second">
<description>
-The second #GtkShortcutTrigger to check.
+The second `GtkShortcutTrigger` to check.
</description>
</property>
<property name="GtkAppChooser:content-type">
<description>
-The content type of the #GtkAppChooser object.
+The content type of the `GtkAppChooser` object.
-See [GContentType][gio-GContentType]
-for more information about content types.
+See `GContentType` for more information about content types.
</description>
</property>
<signal name="GtkAppChooserButton::changed">
<description>
-Emitted when the active application on the #GtkAppChooserButton
-changes.
+Emitted when the active application changes.
</description>
<parameters>
@@ -1130,9 +1157,10 @@ changes.
<signal name="GtkAppChooserButton::custom-item-activated">
<description>
-Emitted when a custom item, previously added with
-gtk_app_chooser_button_append_custom_item(), is activated from the
-dropdown menu.
+Emitted when a custom item is activated.
+
+Use [method@Gtk.AppChooserButton.append_custom_item],
+to add custom items.
</description>
<parameters>
@@ -1151,15 +1179,23 @@ dropdown menu.
<property name="GtkAppChooserButton:heading">
<description>
The text to show at the top of the dialog that can be
-opened from the button. The string may contain Pango markup.
+opened from the button.
+
+The string may contain Pango markup.
+
+</description>
+</property>
+
+<property name="GtkAppChooserButton:modal">
+<description>
+Whether the app chooser dialog should be modal.
</description>
</property>
<property name="GtkAppChooserButton:show-default-item">
<description>
-The #GtkAppChooserButton:show-default-item property determines
-whether the dropdown menu should show the default application
+Determines whether the dropdown menu shows the default application
on top for the provided content type.
</description>
@@ -1167,18 +1203,18 @@ on top for the provided content type.
<property name="GtkAppChooserButton:show-dialog-item">
<description>
-The #GtkAppChooserButton:show-dialog-item property determines
-whether the dropdown menu should show an item that triggers
-a #GtkAppChooserDialog when clicked.
+Determines whether the dropdown menu shows an item to open
+a `GtkAppChooserDialog`.
</description>
</property>
<property name="GtkAppChooserDialog:gfile">
<description>
-The GFile used by the #GtkAppChooserDialog.
-The dialog's #GtkAppChooserWidget content type will be guessed from the
-file, if present.
+The GFile used by the `GtkAppChooserDialog`.
+
+The dialog's `GtkAppChooserWidget` content type will
+be guessed from the file, if present.
</description>
</property>
@@ -1186,6 +1222,7 @@ file, if present.
<property name="GtkAppChooserDialog:heading">
<description>
The text to show at the top of the dialog.
+
The string may contain Pango markup.
</description>
@@ -1233,56 +1270,57 @@ Emitted when an application item is selected from the widget's list.
<property name="GtkAppChooserWidget:default-text">
<description>
-The #GtkAppChooserWidget:default-text property determines the text
-that appears in the widget when there are no applications for the
-given content type.
-See also gtk_app_chooser_widget_set_default_text().
+The text that appears in the widget when there are no applications
+for the given content type.
</description>
</property>
<property name="GtkAppChooserWidget:show-all">
<description>
-If the #GtkAppChooserWidget:show-all property is %TRUE, the app
-chooser presents all applications in a single list, without
-subsections for default, recommended or related applications.
+If %TRUE, the app chooser presents all applications
+in a single list, without subsections for default,
+recommended or related applications.
</description>
</property>
<property name="GtkAppChooserWidget:show-default">
<description>
-The ::show-default property determines whether the app chooser
-should show the default handler for the content type in a
-separate section. If %FALSE, the default handler is listed
-among the recommended applications.
+Determines whether the app chooser should show the default
+handler for the content type in a separate section.
+
+If %FALSE, the default handler is listed among the recommended
+applications.
</description>
</property>
<property name="GtkAppChooserWidget:show-fallback">
<description>
-The #GtkAppChooserWidget:show-fallback property determines whether
-the app chooser should show a section for fallback applications.
-If %FALSE, the fallback applications are listed among the other
-applications.
+Determines whether the app chooser should show a section
+for fallback applications.
+
+If %FALSE, the fallback applications are listed among the
+other applications.
</description>
</property>
<property name="GtkAppChooserWidget:show-other">
<description>
-The #GtkAppChooserWidget:show-other property determines whether
-the app chooser should show a section for other applications.
+Determines whether the app chooser should show a section
+for other applications.
</description>
</property>
<property name="GtkAppChooserWidget:show-recommended">
<description>
-The #GtkAppChooserWidget:show-recommended property determines
-whether the app chooser should show a section for recommended
-applications. If %FALSE, the recommended applications are listed
+Determines whether the app chooser should show a section
+for recommended applications.
+
+If %FALSE, the recommended applications are listed
among the other applications.
</description>
@@ -1290,16 +1328,17 @@ among the other applications.
<signal name="GtkApplication::query-end">
<description>
-Emitted when the session manager is about to end the session, only
-if #GtkApplication:register-session is %TRUE. Applications can
-connect to this signal and call gtk_application_inhibit() with
-%GTK_APPLICATION_INHIBIT_LOGOUT to delay the end of the session
-until state has been saved.
+Emitted when the session manager is about to end the session.
+
+This signal is only emitted if [property@Gtk.Application:register-session]
+is `TRUE`. Applications can connect to this signal and call
+[method@Gtk.Application.inhibit] with `GTK_APPLICATION_INHIBIT_LOGOUT`
+to delay the end of the session until state has been saved.
</description>
<parameters>
<parameter name="application">
-<parameter_description> the #GtkApplication which emitted the signal
+<parameter_description> the `GtkApplication` which emitted the signal
</parameter_description>
</parameter>
</parameters>
@@ -1308,17 +1347,17 @@ until state has been saved.
<signal name="GtkApplication::window-added">
<description>
-Emitted when a #GtkWindow is added to @application through
-gtk_application_add_window().
+Emitted when a [class@Gtk.Window] is added to `application` through
+[method@Gtk.Application.add_window].
</description>
<parameters>
<parameter name="application">
-<parameter_description> the #GtkApplication which emitted the signal
+<parameter_description> the `GtkApplication` which emitted the signal
</parameter_description>
</parameter>
<parameter name="window">
-<parameter_description> the newly-added #GtkWindow
+<parameter_description> the newly-added [class@Gtk.Window]
</parameter_description>
</parameter>
</parameters>
@@ -1327,47 +1366,68 @@ gtk_application_add_window().
<signal name="GtkApplication::window-removed">
<description>
-Emitted when a #GtkWindow is removed from @application,
-either as a side-effect of being destroyed or explicitly
-through gtk_application_remove_window().
+Emitted when a [class@Gtk.Window] is removed from `application`.
+
+This can happen as a side-effect of the window being destroyed
+or explicitly through [method@Gtk.Application.remove_window].
</description>
<parameters>
<parameter name="application">
-<parameter_description> the #GtkApplication which emitted the signal
+<parameter_description> the `GtkApplication` which emitted the signal
</parameter_description>
</parameter>
<parameter name="window">
-<parameter_description> the #GtkWindow that is being removed
+<parameter_description> the [class@Gtk.Window] that is being removed
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>
+<property name="GtkApplication:active-window">
+<description>
+The currently focused window of the application.
+
+</description>
+</property>
+
+<property name="GtkApplication:menubar">
+<description>
+The `GMenuModel` to be used for the application's menu bar.
+
+</description>
+</property>
+
<property name="GtkApplication:register-session">
<description>
-Set this property to %TRUE to register with the session manager.
-This will make GTK+ track the session state (such as the
-#GtkApplication:screensaver-active property).
+Set this property to `TRUE` to register with the session manager.
+
+This will make GTK track the session state (such as the
+[property@Gtk.Application:screensaver-active] property).
</description>
</property>
<property name="GtkApplication:screensaver-active">
<description>
-This property is %TRUE if GTK+ believes that the screensaver is
-currently active. GTK+ only tracks session state (including this)
-when #GtkApplication:register-session is set to %TRUE.
+This property is `TRUE` if GTK believes that the screensaver is
+currently active.
-Tracking the screensaver state is supported on Linux.
+GTK only tracks session state (including this) when
+[property@Gtk.Application:register-session] is set to %TRUE.
+
+Tracking the screensaver state is currently only supported on
+Linux.
</description>
</property>
<enum name="GtkApplicationInhibitFlags">
<description>
-Types of user actions that may be blocked by gtk_application_inhibit().
+Types of user actions that may be blocked by `GtkApplication`.
+
+See [method@Gtk.Application.inhibit].
</description>
<parameters>
@@ -1396,7 +1456,9 @@ marked as idle (and possibly locked)
<property name="GtkApplicationWindow:show-menubar">
<description>
If this property is %TRUE, the window will display a menubar
-unless it is shown by the desktop shell. See gtk_application_set_menubar().
+unless it is shown by the desktop shell.
+
+See [method@Gtk.Application.set_menubar].
If %FALSE, the window will not display a menubar, regardless
of whether the desktop shell is showing it or not.
@@ -1433,24 +1495,62 @@ Used to indicate the direction in which an arrow should point.
</parameters>
</enum>
+<property name="GtkAspectFrame:child">
+<description>
+The child widget.
+
+</description>
+</property>
+
+<property name="GtkAspectFrame:obey-child">
+<description>
+Whether the `GtkAspectFrame` should use the aspect ratio of its child.
+
+</description>
+</property>
+
+<property name="GtkAspectFrame:ratio">
+<description>
+The aspect ratio to be used by the `GtkAspectFrame`.
+
+This property is only used if
+[property@Gtk.AspectFrame:obey-child] is set to %FALSE.
+
+</description>
+</property>
+
+<property name="GtkAspectFrame:xalign">
+<description>
+The horizontal alignment of the child.
+
+</description>
+</property>
+
+<property name="GtkAspectFrame:yalign">
+<description>
+The vertical alignment of the child.
+
+</description>
+</property>
+
<signal name="GtkAssistant::apply">
<description>
-The ::apply signal is emitted when the apply button is clicked.
+Emitted when the apply button is clicked.
-The default behavior of the #GtkAssistant is to switch to the page
+The default behavior of the `GtkAssistant` is to switch to the page
after the current page, unless the current page is the last one.
A handler for the ::apply signal should carry out the actions for
which the wizard has collected data. If the action takes a long time
to complete, you might consider putting a page of type
%GTK_ASSISTANT_PAGE_PROGRESS after the confirmation page and handle
-this operation within the #GtkAssistant::prepare signal of the progress
-page.
+this operation within the [signal@Gtk.Assistant::prepare] signal of
+the progress page.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> the #GtkAssistant
+<parameter_description> the `GtkAssistant`
</parameter_description>
</parameter>
</parameters>
@@ -1459,12 +1559,12 @@ page.
<signal name="GtkAssistant::cancel">
<description>
-The ::cancel signal is emitted when then the cancel button is clicked.
+Emitted when then the cancel button is clicked.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> the #GtkAssistant
+<parameter_description> the `GtkAssistant`
</parameter_description>
</parameter>
</parameters>
@@ -1473,14 +1573,14 @@ The ::cancel signal is emitted when then the cancel button is clicked.
<signal name="GtkAssistant::close">
<description>
-The ::close signal is emitted either when the close button of
-a summary page is clicked, or when the apply button in the last
-page in the flow (of type %GTK_ASSISTANT_PAGE_CONFIRM) is clicked.
+Emitted either when the close button of a summary page is clicked,
+or when the apply button in the last page in the flow (of type
+%GTK_ASSISTANT_PAGE_CONFIRM) is clicked.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> the #GtkAssistant
+<parameter_description> the `GtkAssistant`
</parameter_description>
</parameter>
</parameters>
@@ -1494,7 +1594,7 @@ The action signal for the Escape binding.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> the #GtkAssistant
+<parameter_description> the `GtkAssistant`
</parameter_description>
</parameter>
</parameters>
@@ -1503,8 +1603,8 @@ The action signal for the Escape binding.
<signal name="GtkAssistant::prepare">
<description>
-The ::prepare signal is emitted when a new page is set as the
-assistant's current page, before making the new page visible.
+Emitted when a new page is set as the assistant's current page,
+before making the new page visible.
A handler for this signal can do any preparations which are
necessary before showing @page.
@@ -1512,7 +1612,7 @@ necessary before showing @page.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> the #GtkAssistant
+<parameter_description> the `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="page">
@@ -1523,6 +1623,13 @@ necessary before showing @page.
<return></return>
</signal>
+<property name="GtkAssistant:pages">
+<description>
+`GListModel` containing the pages.
+
+</description>
+</property>
+
<property name="GtkAssistant:use-header-bar">
<description>
%TRUE if the assistant uses a #GtkHeaderBar for action buttons
@@ -1534,11 +1641,19 @@ property, but you should only set it to %TRUE or %FALSE.
</description>
</property>
+<property name="GtkAssistantPage:child">
+<description>
+The child widget.
+
+</description>
+</property>
+
<property name="GtkAssistantPage:complete">
<description>
-Setting the "complete" property to %TRUE marks a page as
-complete (i.e.: all the required fields are filled out). GTK uses
-this information to control the sensitivity of the navigation buttons.
+Whether all required fields are filled in.
+
+GTK uses this information to control the sensitivity
+of the navigation buttons.
</description>
</property>
@@ -1559,8 +1674,9 @@ The title of the page.
<enum name="GtkAssistantPageType">
<description>
-An enum for determining the page role inside the #GtkAssistant. It's
-used to handle buttons sensitivity and visibility.
+Determines the page role inside a `GtkAssistant`.
+
+The role is used to handle buttons sensitivity and visibility.
Note that an assistant needs to end its page flow with a page of type
%GTK_ASSISTANT_PAGE_CONFIRM, %GTK_ASSISTANT_PAGE_SUMMARY or
@@ -1609,11 +1725,13 @@ add its own buttons through gtk_assistant_add_action_widget().
<enum name="GtkBaselinePosition">
<description>
+Baseline position in a row of widgets.
+
Whenever a container has some form of natural row it may align
children in that row along a common typographical baseline. If
the amount of vertical space in the row is taller than the total
requested height of the baseline-aligned children then it can use a
-#GtkBaselinePosition to select where to put the baseline inside the
+`GtkBaselinePosition` to select where to put the baseline inside the
extra available space.
</description>
@@ -1635,35 +1753,42 @@ extra available space.
<property name="GtkBookmarkList:attributes">
<description>
-The attributes to query
+The attributes to query.
+
+</description>
+</property>
+
+<property name="GtkBookmarkList:filename">
+<description>
+The bookmark file to load.
</description>
</property>
<property name="GtkBookmarkList:io-priority">
<description>
-Priority used when loading
+Priority used when loading.
</description>
</property>
<property name="GtkBookmarkList:loading">
<description>
-%TRUE if files are being loaded
+%TRUE if files are being loaded.
</description>
</property>
<property name="GtkBoolFilter:expression">
<description>
-The boolean expression to evaluate on item
+The boolean expression to evaluate on item.
</description>
</property>
<property name="GtkBoolFilter:invert">
<description>
-If the expression result should be inverted
+If the expression result should be inverted.
</description>
</property>
@@ -1717,11 +1842,31 @@ Describes how the border of a UI element should be rendered.
</parameters>
</enum>
+<property name="GtkBox:baseline-position">
+<description>
+The position of the baseline aligned widgets if extra space is available.
+
+</description>
+</property>
+
+<property name="GtkBox:homogeneous">
+<description>
+Whether the children should all be the same size.
+
+</description>
+</property>
+
+<property name="GtkBox:spacing">
+<description>
+The amount of space between children.
+
+</description>
+</property>
+
<property name="GtkBoxLayout:baseline-position">
<description>
The position of the allocated baseline within the extra space
-allocated to each child of the widget using a box layout
-manager.
+allocated to each child.
This property is only relevant for horizontal layouts containing
at least one child with a baseline alignment.
@@ -1732,16 +1877,14 @@ at least one child with a baseline alignment.
<property name="GtkBoxLayout:homogeneous">
<description>
Whether the box layout should distribute the available space
-homogeneously among the children of the widget using it as a
-layout manager.
+equally among the children.
</description>
</property>
<property name="GtkBoxLayout:spacing">
<description>
-The space between each child of the widget using the box
-layout as its layout manager.
+The space to put between the children.
</description>
</property>
@@ -1763,7 +1906,8 @@ The scope the builder is operating in
<property name="GtkBuilder:translation-domain">
<description>
The translation domain used when translating property values that
-have been marked as translatable in interface descriptions.
+have been marked as translatable.
+
If the translation domain is %NULL, #GtkBuilder uses gettext(),
otherwise g_dgettext().
@@ -1773,10 +1917,11 @@ otherwise g_dgettext().
<enum name="GtkBuilderClosureFlags">
<description>
The list of flags that can be passed to gtk_builder_create_closure().
+
New values may be added in the future for new features, so external
-implementations of GtkBuilderScopeInterface should test the flags for unknown
-values and raise a %GTK_BUILDER_ERROR_INVALID_ATTRIBUTE error when they
-encounter one.
+implementations of [interface@Gtk.BuilderScope] should test the flags
+for unknown values and raise a %GTK_BUILDER_ERROR_INVALID_ATTRIBUTE error
+when they encounter one.
</description>
<parameters>
@@ -1871,31 +2016,31 @@ when symbols are set to be kept private. Compiling code with -rdynamic or using
<property name="GtkBuilderListItemFactory:bytes">
<description>
-bytes containing the UI definition
+`GBytes` containing the UI definition.
</description>
</property>
<property name="GtkBuilderListItemFactory:resource">
<description>
-resource containing the UI definition
+Path of the resource containing the UI definition.
</description>
</property>
<property name="GtkBuilderListItemFactory:scope">
<description>
-scope to use when instantiating listitems
+`GtkBuilderScope` to use when instantiating listitems
</description>
</property>
<signal name="GtkButton::activate">
<description>
-The ::activate signal on GtkButton is an action signal and
-emitting it causes the button to animate press then release.
-Applications should never connect to this signal, but use the
-#GtkButton::clicked signal.
+Emitted to animate press then release.
+
+This is an action signal. Applications should never connect
+to this signal, but use the [signal@Gtk.Button::clicked] signal.
</description>
<parameters>
@@ -1921,6 +2066,42 @@ Emitted when the button has been activated (pressed and released).
<return></return>
</signal>
+<property name="GtkButton:child">
+<description>
+The child widget.
+
+</description>
+</property>
+
+<property name="GtkButton:has-frame">
+<description>
+Whether the button has a frame.
+
+</description>
+</property>
+
+<property name="GtkButton:icon-name">
+<description>
+The name of the icon used to automatically populate the button.
+
+</description>
+</property>
+
+<property name="GtkButton:label">
+<description>
+Text of the label inside the button, if the button contains a label widget.
+
+</description>
+</property>
+
+<property name="GtkButton:use-underline">
+<description>
+If set, an underline in the text indicates that the following character is
+to be used as mnemonic.
+
+</description>
+</property>
+
<enum name="GtkButtonRole">
<description>
The role specifies the desired appearance of a #GtkModelButton.
@@ -1948,9 +2129,10 @@ The role specifies the desired appearance of a #GtkModelButton.
<enum name="GtkButtonsType">
<description>
-Prebuilt sets of buttons for the dialog. If
-none of these choices are appropriate, simply use %GTK_BUTTONS_NONE
-then call gtk_dialog_add_buttons().
+Prebuilt sets of buttons for `GtkDialog`.
+
+If none of these choices are appropriate, simply use
+%GTK_BUTTONS_NONE and call [method@Gtk.Dialog.add_buttons].
> Please note that %GTK_BUTTONS_OK, %GTK_BUTTONS_YES_NO
> and %GTK_BUTTONS_OK_CANCEL are discouraged by the
@@ -2057,8 +2239,9 @@ Emitted when user switched to the previous year.
<property name="GtkCalendar:day">
<description>
-The selected day (as a number between 1 and 31, or 0
-to unselect the currently selected day).
+The selected day (as a number between 1 and 31).
+
+This can be set to 0 to unselect the currently selected day.
This property gets initially set to the current day.
</description>
@@ -2067,6 +2250,7 @@ This property gets initially set to the current day.
<property name="GtkCalendar:month">
<description>
The selected month (as a number between 0 and 11).
+
This property gets initially set to the current month.
</description>
@@ -2096,6 +2280,7 @@ Determines whether week numbers are displayed.
<property name="GtkCalendar:year">
<description>
The selected year.
+
This property gets initially set to the current year.
</description>
@@ -2998,9 +3183,39 @@ since 2.10
</description>
</property>
+<property name="GtkCenterBox:baseline-position">
+<description>
+The position of the baseline aligned widget if extra space is available.
+
+</description>
+</property>
+
+<signal name="GtkCheckButton::activate">
+<description>
+Emitted to when the check button is activated.
+
+The `::activate` signal on `GtkCheckButton` is an action signal and
+emitting it causes the button to animate press then release.
+
+Applications should never connect to this signal, but use the
+[signal@Gtk.CheckButton::toggled] signal.
+
+Since: 4.2
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
<signal name="GtkCheckButton::toggled">
<description>
-Emitted when the buttons's #GtkCheckButton:active flag changes.
+Emitted when the buttons's [property@Gtk.CheckButton:active]
+property changes.
</description>
<parameters>
@@ -3008,15 +3223,58 @@ Emitted when the buttons's #GtkCheckButton:active flag changes.
<return></return>
</signal>
+<property name="GtkCheckButton:active">
+<description>
+If the check button is active.
+
+Setting `active` to %TRUE will add the `:checked:` state to both
+the check button and the indicator CSS node.
+
+</description>
+</property>
+
+<property name="GtkCheckButton:group">
+<description>
+The check button whose group this widget belongs to.
+
+</description>
+</property>
+
+<property name="GtkCheckButton:inconsistent">
+<description>
+If the check button is in an “in between” state.
+
+The inconsistent state only affects visual appearance,
+not the semantics of the button.
+
+</description>
+</property>
+
+<property name="GtkCheckButton:label">
+<description>
+Text of the label inside the check button, if it contains a label widget.
+
+</description>
+</property>
+
+<property name="GtkCheckButton:use-underline">
+<description>
+If set, an underline in the text indicates that the following
+character is to be used as mnemonic.
+
+</description>
+</property>
+
<signal name="GtkColorButton::color-set">
<description>
-The ::color-set signal is emitted when the user selects a color.
-When handling this signal, use gtk_color_chooser_get_rgba() to
-find out which color was just selected.
+Emitted when the user selects a color.
+
+When handling this signal, use [method@Gtk.ColorChooser.get_rgba]
+to find out which color was just selected.
-Note that this signal is only emitted when the user
-changes the color. If you need to react to programmatic color changes
-as well, use the notify::color signal.
+Note that this signal is only emitted when the user changes the color.
+If you need to react to programmatic color changes as well, use
+the notify::color signal.
</description>
<parameters>
@@ -3028,10 +3286,16 @@ as well, use the notify::color signal.
<return></return>
</signal>
+<property name="GtkColorButton:modal">
+<description>
+Whether the color chooser dialog should be modal.
+
+</description>
+</property>
+
<property name="GtkColorButton:show-editor">
<description>
-Set this property to %TRUE to skip the palette
-in the dialog and go directly to the color editor.
+Whether the color chooser should open in editor mode.
This property should be used in cases where the palette
in the editor would be redundant, such as when the color
@@ -3042,7 +3306,7 @@ button is already part of a palette.
<property name="GtkColorButton:title">
<description>
-The title of the color selection dialog
+The title of the color chooser dialog
</description>
</property>
@@ -3050,6 +3314,7 @@ The title of the color selection dialog
<signal name="GtkColorChooser::color-activated">
<description>
Emitted when a color is activated from the color chooser.
+
This usually happens when the user clicks a color swatch,
or a color is selected and the user presses one of the keys
Space, Shift+Space, Return or Enter.
@@ -3070,19 +3335,21 @@ Space, Shift+Space, Return or Enter.
<property name="GtkColorChooser:rgba">
<description>
-The ::rgba property contains the currently selected color,
-as a #GdkRGBA struct. The property can be set to change
-the current selection programmatically.
+The currently selected color, as a `GdkRGBA` struct.
+
+The property can be set to change the current selection
+programmatically.
</description>
</property>
<property name="GtkColorChooser:use-alpha">
<description>
-When ::use-alpha is %TRUE, colors may have alpha (translucency)
-information. When it is %FALSE, the #GdkRGBA struct obtained
-via the #GtkColorChooser:rgba property will be forced to have
-alpha == 1.
+Whether colors may have alpha (translucency).
+
+When ::use-alpha is %FALSE, the `GdkRGBA` struct obtained
+via the [property@Gtk.ColorChooser:rgba] property will be
+forced to have alpha == 1.
Implementations are expected to show alpha by rendering the color
over a non-uniform background (like a checkerboard pattern).
@@ -3092,25 +3359,26 @@ over a non-uniform background (like a checkerboard pattern).
<property name="GtkColorChooserWidget:show-editor">
<description>
-The ::show-editor property is %TRUE when the color chooser
-is showing the single-color editor. It can be set to switch
-the color chooser into single-color editing mode.
+%TRUE when the color chooser is showing the single-color editor.
+
+It can be set to switch the color chooser into single-color editing mode.
</description>
</property>
<signal name="GtkColumnView::activate">
<description>
-The ::activate signal is emitted when a row has been activated by the user,
-usually via activating the GtkListBase|list.activate-item action.
+Emitted when a row has been activated by the user, usually via activating
+the GtkListBase|list.activate-item action.
This allows for a convenient way to handle activation in a columnview.
-See gtk_list_item_set_activatable() for details on how to use this signal.
+See [method@Gtk.ListItem.set_activatable] for details on how to use this
+signal.
</description>
<parameters>
<parameter name="self">
-<parameter_description> The #GtkColumnView
+<parameter_description> The `GtkColumnView`
</parameter_description>
</parameter>
<parameter name="position">
@@ -3123,77 +3391,77 @@ See gtk_list_item_set_activatable() for details on how to use this signal.
<property name="GtkColumnView:columns">
<description>
-The list of columns
+The list of columns.
</description>
</property>
<property name="GtkColumnView:enable-rubberband">
<description>
-Allow rubberband selection
+Allow rubberband selection.
</description>
</property>
<property name="GtkColumnView:model">
<description>
-Model for the items displayed
+Model for the items displayed.
</description>
</property>
<property name="GtkColumnView:reorderable">
<description>
-Whether columns are reorderable
+Whether columns are reorderable.
</description>
</property>
<property name="GtkColumnView:show-column-separators">
<description>
-Show separators between columns
+Show separators between columns.
</description>
</property>
<property name="GtkColumnView:show-row-separators">
<description>
-Show separators between rows
+Show separators between rows.
</description>
</property>
<property name="GtkColumnView:single-click-activate">
<description>
-Activate rows on single click and select them on hover
+Activate rows on single click and select them on hover.
</description>
</property>
<property name="GtkColumnView:sorter">
<description>
-Sorter with the sorting choices of the user
+Sorter with the sorting choices of the user.
</description>
</property>
<property name="GtkColumnViewColumn:column-view">
<description>
-#GtkColumnView this column is a part of
+The `GtkColumnView` this column is a part of.
</description>
</property>
<property name="GtkColumnViewColumn:expand">
<description>
-Column gets share of extra width allocated to the view
+Column gets share of extra width allocated to the view.
</description>
</property>
<property name="GtkColumnViewColumn:factory">
<description>
-Factory for populating list items
+Factory for populating list items.
</description>
</property>
@@ -3215,40 +3483,39 @@ Menu model used to create the context menu for the column header.
<property name="GtkColumnViewColumn:resizable">
<description>
-Whether this column is resizable
+Whether this column is resizable.
</description>
</property>
<property name="GtkColumnViewColumn:sorter">
<description>
-Sorter for sorting items according to this column
+Sorter for sorting items according to this column.
</description>
</property>
<property name="GtkColumnViewColumn:title">
<description>
-Title displayed in the header
+Title displayed in the header.
</description>
</property>
<property name="GtkColumnViewColumn:visible">
<description>
-Whether this column is visible
+Whether this column is visible.
</description>
</property>
<signal name="GtkComboBox::changed">
<description>
-The changed signal is emitted when the active
-item is changed. The can be due to the user selecting
-a different item from the list, or due to a
-call to gtk_combo_box_set_active_iter().
-It will also be emitted while typing into the entry of a combo box
-with an entry.
+Emitted when the active item is changed.
+
+The can be due to the user selecting a different item from the list,
+or due to a call to [method@Gtk.ComboBox.set_active_iter]. It will
+also be emitted while typing into the entry of a combo box with an entry.
</description>
<parameters>
@@ -3262,19 +3529,18 @@ with an entry.
<signal name="GtkComboBox::format-entry-text">
<description>
-For combo boxes that are created with an entry (See GtkComboBox:has-entry).
+Emitted to allow changing how the text in a combo box's entry is displayed.
-A signal which allows you to change how the text displayed in a combo box's
-entry is displayed.
+See [property@Gtk.ComboBox:has-entry].
Connect a signal handler which returns an allocated string representing
-@path. That string will then be used to set the text in the combo box's entry.
-The default signal handler uses the text from the GtkComboBox::entry-text-column
-model column.
+@path. That string will then be used to set the text in the combo box's
+entry. The default signal handler uses the text from the
+[property@Gtk.ComboBox:entry-text-column] model column.
Here's an example signal handler which fetches data from the model and
displays it in the entry.
-|[<!-- language="C" -->
+```c
static char *
format_entry_text_callback (GtkComboBox *combo,
const char *path,
@@ -3293,7 +3559,7 @@ THE_DOUBLE_VALUE_COLUMN, &value,
return g_strdup_printf ("%g", value);
}
-]|
+```
</description>
@@ -3303,20 +3569,21 @@ return g_strdup_printf ("%g", value);
</parameter_description>
</parameter>
<parameter name="path">
-<parameter_description> the GtkTreePath string from the combo box's current model to format text for
+<parameter_description> the [struct@Gtk.TreePath] string from the combo box's current model
+to format text for
</parameter_description>
</parameter>
</parameters>
<return> a newly allocated string representing @path
-for the current GtkComboBox model.
+for the current `GtkComboBox` model.
</return>
</signal>
<signal name="GtkComboBox::move-active">
<description>
-The ::move-active signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to move the active selection.
+Emitted to move the active selection.
+
+This is an [keybinding signal](class.SignalAction.html).
</description>
<parameters>
@@ -3325,7 +3592,7 @@ which gets emitted to move the active selection.
</parameter_description>
</parameter>
<parameter name="scroll_type">
-<parameter_description> a #GtkScrollType
+<parameter_description> a `GtkScrollType`
</parameter_description>
</parameter>
</parameters>
@@ -3334,9 +3601,9 @@ which gets emitted to move the active selection.
<signal name="GtkComboBox::popdown">
<description>
-The ::popdown signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to popdown the combo box list.
+Emitted to popdown the combo box list.
+
+This is an [keybinding signal](class.SignalAction.html).
The default bindings for this signal are Alt+Up and Escape.
@@ -3352,9 +3619,9 @@ The default bindings for this signal are Alt+Up and Escape.
<signal name="GtkComboBox::popup">
<description>
-The ::popup signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to popup the combo box list.
+Emitted to popup the combo box list.
+
+This is an [keybinding signal](class.SignalAction.html).
The default binding for this signal is Alt+Down.
@@ -3370,11 +3637,12 @@ The default binding for this signal is Alt+Down.
<property name="GtkComboBox:active">
<description>
-The item which is currently active. If the model is a non-flat treemodel,
-and the active item is not an immediate child of the root of the tree,
-this property has the value
-`gtk_tree_path_get_indices (path)[0]`,
-where `path` is the #GtkTreePath of the active item.
+The item which is currently active.
+
+If the model is a non-flat treemodel, and the active item is not an
+immediate child of the root of the tree, this property has the value
+`gtk_tree_path_get_indices (path)[0]`, where `path` is the
+[struct@Gtk.TreePath] of the active item.
</description>
</property>
@@ -3394,10 +3662,19 @@ the model is empty.
</description>
</property>
+<property name="GtkComboBox:child">
+<description>
+The child widget.
+
+</description>
+</property>
+
<property name="GtkComboBox:entry-text-column">
<description>
-The column in the combo box's model to associate with strings from the entry
-if the combo was created with #GtkComboBox:has-entry = %TRUE.
+The model column to associate with strings from the entry.
+
+This is property only relevant if the combo was created with
+[property@Gtk.ComboBox:has-entry] is %TRUE.
</description>
</property>
@@ -3411,24 +3688,22 @@ Whether the combo box has an entry.
<property name="GtkComboBox:has-frame">
<description>
-The has-frame property controls whether a frame
-is drawn around the entry.
+The `has-frame` property controls whether a frame is drawn around the entry.
</description>
</property>
<property name="GtkComboBox:id-column">
<description>
-The column in the combo box's model that provides string
-IDs for the values in the model, if != -1.
+The model column that provides string IDs for the values
+in the model, if != -1.
</description>
</property>
<property name="GtkComboBox:model">
<description>
-The model from which the combo box takes the values shown
-in the list.
+The model from which the combo box takes its values.
</description>
</property>
@@ -3444,6 +3719,7 @@ allocated width of the combo box.
<property name="GtkComboBox:popup-shown">
<description>
Whether the combo boxes dropdown is popped up.
+
Note that this property is mainly useful, because
it allows you to connect to notify::popup-shown.
@@ -3452,15 +3728,15 @@ it allows you to connect to notify::popup-shown.
<property name="GtkConstraint:constant">
<description>
-The constant value to be added to the #GtkConstraint:source-attribute.
+The constant value to be added to the [property@Gtk.Constraint:source-attribute].
</description>
</property>
<property name="GtkConstraint:multiplier">
<description>
-The multiplication factor to be applied to the
-#GtkConstraint:source-attribute.
+The multiplication factor to be applied to
+the [property@Gtk.Constraint:source-attribute].
</description>
</property>
@@ -3476,15 +3752,17 @@ The order relation between the terms of the constraint.
<description>
The source of the constraint.
-The constraint will set the #GtkConstraint:target-attribute of the
-target using the #GtkConstraint:source-attribute of the source.
+The constraint will set the [property@Gtk.Constraint:target-attribute]
+of the target using the [property@Gtk.Constraint:source-attribute]
+of the source.
</description>
</property>
<property name="GtkConstraint:source-attribute">
<description>
-The attribute of the #GtkConstraint:source read by the constraint.
+The attribute of the [property@Gtk.Constraint:source] read by the
+constraint.
</description>
</property>
@@ -3494,7 +3772,7 @@ The attribute of the #GtkConstraint:source read by the constraint.
The strength of the constraint.
The strength can be expressed either using one of the symbolic values
-of the #GtkConstraintStrength enumeration, or any positive integer
+of the [enum@Gtk.ConstraintStrength] enumeration, or any positive integer
value.
</description>
@@ -3508,6 +3786,8 @@ The constraint will set the #GtkConstraint:target-attribute of the
target using the #GtkConstraint:source-attribute of the source
widget.
+
+
</description>
</property>
@@ -3520,7 +3800,7 @@ The attribute of the #GtkConstraint:target set by the constraint.
<enum name="GtkConstraintAttribute">
<description>
-The widget attributes that can be used when creating a #GtkConstraint.
+The widget attributes that can be used when creating a `GtkConstraint`.
</description>
<parameters>
@@ -3614,7 +3894,7 @@ The minimum width of the guide.
<property name="GtkConstraintGuide:name">
<description>
-A name that identifies the #GtkConstraintGuide, for debugging.
+A name that identifies the `GtkConstraintGuide`, for debugging.
</description>
</property>
@@ -3635,7 +3915,7 @@ The preferred, or natural, width of the guide.
<property name="GtkConstraintGuide:strength">
<description>
-The #GtkConstraintStrength to be used for the constraint on
+The `GtkConstraintStrength` to be used for the constraint on
the natural size of the guide.
</description>
@@ -3726,8 +4006,9 @@ Domain for VFL parsing errors.
<enum name="GtkCornerType">
<description>
Specifies which corner a child widget should be placed in when packed into
-a #GtkScrolledWindow. This is effectively the opposite of where the scroll
-bars are placed.
+a `GtkScrolledWindow.`
+
+This is effectively the opposite of where the scroll bars are placed.
</description>
<parameters>
@@ -3817,12 +4098,14 @@ implemented
<signal name="GtkCssProvider::parsing-error">
<description>
-Signals that a parsing error occurred. the @path, @line and @position
-describe the actual location of the error as accurately as possible.
+Signals that a parsing error occurred.
+
+The @path, @line and @position describe the actual location of
+the error as accurately as possible.
Parsing errors are never fatal, so the parsing will resume after
-the error. Errors may however cause parts of the given
-data or even all of it to not be parsed at all. So it is a useful idea
+the error. Errors may however cause parts of the given data or
+even all of it to not be parsed at all. So it is a useful idea
to check that the parsing succeeds by connecting to this signal.
Note that this signal may be emitted at any time as the css provider
@@ -3849,7 +4132,7 @@ than when a loading function was called.
<enum name="GtkDeleteType">
<description>
-See also: #GtkEntry::delete-from-cursor.
+Passed to various keybinding signals for deleting text.
</description>
<parameters>
@@ -3896,10 +4179,9 @@ paragraph. Like C-k in Emacs (or its reverse).
<signal name="GtkDialog::close">
<description>
-The ::close signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user uses a keybinding to close
-the dialog.
+Emitted when the user uses a keybinding to close the dialog.
+
+This is a [keybinding signal](class.SignalAction.html).
The default binding for this signal is the Escape key.
@@ -3911,9 +4193,11 @@ The default binding for this signal is the Escape key.
<signal name="GtkDialog::response">
<description>
-Emitted when an action widget is clicked, the dialog receives a
-delete event, or the application programmer calls gtk_dialog_response().
-On a delete event, the response ID is #GTK_RESPONSE_DELETE_EVENT.
+Emitted when an action widget is clicked.
+
+The signal is also emitted when the dialog receives a
+delete event, and when [method@Gtk.Dialog.response] is called.
+On a delete event, the response ID is %GTK_RESPONSE_DELETE_EVENT.
Otherwise, it depends on which action widget was clicked.
</description>
@@ -3932,12 +4216,25 @@ Otherwise, it depends on which action widget was clicked.
<property name="GtkDialog:use-header-bar">
<description>
-%TRUE if the dialog uses a #GtkHeaderBar for action buttons
+%TRUE if the dialog uses a headerbar for action buttons
instead of the action-area.
For technical reasons, this property is declared as an integer
property, but you should only set it to %TRUE or %FALSE.
+## Creating a dialog with headerbar
+
+Builtin `GtkDialog` subclasses such as [class@Gtk.ColorChooserDialog]
+set this property according to platform conventions (using the
+[property@Gtk.Settings:gtk-dialogs-use-header] setting).
+
+Here is how you can achieve the same:
+
+```c
+g_object_get (settings, "gtk-dialogs-use-header", &header, NULL);
+dialog = g_object_new (GTK_TYPE_DIALOG, header, TRUE, NULL);
+```
+
</description>
</property>
@@ -3948,13 +4245,11 @@ Flags used to influence dialog construction.
</description>
<parameters>
<parameter name="GTK_DIALOG_MODAL">
-<parameter_description> Make the constructed dialog modal,
-see gtk_window_set_modal()
+<parameter_description> Make the constructed dialog modal
</parameter_description>
</parameter>
<parameter name="GTK_DIALOG_DESTROY_WITH_PARENT">
-<parameter_description> Destroy the dialog when its
-parent is destroyed, see gtk_window_set_destroy_with_parent()
+<parameter_description> Destroy the dialog when its parent is destroyed
</parameter_description>
</parameter>
<parameter name="GTK_DIALOG_USE_HEADER_BAR">
@@ -4000,42 +4295,42 @@ Focus movement types.
<property name="GtkDirectoryList:attributes">
<description>
-The attributes to query
+The attributes to query.
</description>
</property>
<property name="GtkDirectoryList:error">
<description>
-Error encountered while loading files
+Error encountered while loading files.
</description>
</property>
<property name="GtkDirectoryList:file">
<description>
-File to query
+File to query.
</description>
</property>
<property name="GtkDirectoryList:io-priority">
<description>
-Priority used when loading
+Priority used when loading.
</description>
</property>
<property name="GtkDirectoryList:loading">
<description>
-%TRUE if files are being loaded
+%TRUE if files are being loaded.
</description>
</property>
<property name="GtkDirectoryList:monitored">
<description>
-%TRUE if the directory is monitored for changed
+%TRUE if the directory is monitored for changed.
</description>
</property>
@@ -4049,18 +4344,19 @@ The widget to display as drag icon.
<signal name="GtkDragSource::drag-begin">
<description>
-The ::drag-begin signal is emitted on the drag source when a drag
-is started. It can be used to e.g. set a custom drag icon with
-gtk_drag_source_set_icon().
+Emitted on the drag source when a drag is started.
+
+It can be used to e.g. set a custom drag icon with
+[method@Gtk.DragSource.set_icon].
</description>
<parameters>
<parameter name="source">
-<parameter_description> the #GtkDragSource
+<parameter_description> the `GtkDragSource`
</parameter_description>
</parameter>
<parameter name="drag">
-<parameter_description> the #GdkDrag object
+<parameter_description> the `GdkDrag` object
</parameter_description>
</parameter>
</parameters>
@@ -4069,8 +4365,9 @@ gtk_drag_source_set_icon().
<signal name="GtkDragSource::drag-cancel">
<description>
-The ::drag-cancel signal is emitted on the drag source when a drag has
-failed. The signal handler may handle a failed drag operation based on
+Emitted on the drag source when a drag has failed.
+
+The signal handler may handle a failed drag operation based on
the type of error. It should return %TRUE if the failure has been handled
and the default "drag operation failed" animation should not be shown.
@@ -4078,11 +4375,11 @@ and the default "drag operation failed" animation should not be shown.
</description>
<parameters>
<parameter name="source">
-<parameter_description> the #GtkDragSource
+<parameter_description> the `GtkDragSource`
</parameter_description>
</parameter>
<parameter name="drag">
-<parameter_description> the #GdkDrag object
+<parameter_description> the `GdkDrag` object
</parameter_description>
</parameter>
<parameter name="reason">
@@ -4096,18 +4393,20 @@ and the default "drag operation failed" animation should not be shown.
<signal name="GtkDragSource::drag-end">
<description>
-The ::drag-end signal is emitted on the drag source when a drag is
-finished. A typical reason to connect to this signal is to undo
-things done in #GtkDragSource::prepare or #GtkDragSource::drag-begin.
+Emitted on the drag source when a drag is finished.
+
+A typical reason to connect to this signal is to undo
+things done in [signal@Gtk.DragSource::prepare] or
+[signal@Gtk.DragSource::drag-begin] handlers.
</description>
<parameters>
<parameter name="source">
-<parameter_description> the #GtkDragSource
+<parameter_description> the `GtkDragSource`
</parameter_description>
</parameter>
<parameter name="drag">
-<parameter_description> the #GdkDrag object
+<parameter_description> the `GdkDrag` object
</parameter_description>
</parameter>
<parameter name="delete_data">
@@ -4121,17 +4420,18 @@ and the data should be deleted
<signal name="GtkDragSource::prepare">
<description>
-The ::prepare signal is emitted when a drag is about to be initiated.
-It returns the * #GdkContentProvider to use for the drag that is about
+Emitted when a drag is about to be initiated.
+
+It returns the `GdkContentProvider` to use for the drag that is about
to start. The default handler for this signal returns the value of
-the #GtkDragSource:content property, so if you set up that property
-ahead of time, you don't need to connect to this signal.
+the [property@Gtk.DragSource:content] property, so if you set up that
+property ahead of time, you don't need to connect to this signal.
</description>
<parameters>
<parameter name="source">
-<parameter_description> the #GtkDragSource
+<parameter_description> the `GtkDragSource`
</parameter_description>
</parameter>
<parameter name="x">
@@ -4143,7 +4443,7 @@ ahead of time, you don't need to connect to this signal.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkContentProvider, or %NULL
+<return> a `GdkContentProvider`, or %NULL
</return>
</signal>
@@ -4151,7 +4451,7 @@ ahead of time, you don't need to connect to this signal.
<description>
The actions that are supported by drag operations from the source.
-Note that you must handle the #GtkDragSource::drag-end signal
+Note that you must handle the [signal@Gtk.DragSource::drag-end] signal
if the actions include %GDK_ACTION_MOVE.
</description>
@@ -4159,23 +4459,23 @@ if the actions include %GDK_ACTION_MOVE.
<property name="GtkDragSource:content">
<description>
-The data that is offered by drag operations from this source,
-in the form of a #GdkContentProvider.
+The data that is offered by drag operations from this source.
</description>
</property>
<signal name="GtkDrawingArea::resize">
<description>
-The ::resize signal is emitted once when the widget is realized, and
-then each time the widget is changed while realized. This is useful
-in order to keep state up to date with the widget size, like for
-instance a backing surface.
+Emitted once when the widget is realized, and then each time the widget
+is changed while realized.
+
+This is useful in order to keep state up to date with the widget size,
+like for instance a backing surface.
</description>
<parameters>
<parameter name="area">
-<parameter_description> the #GtkDrawingArea that emitted the signal
+<parameter_description> the `GtkDrawingArea` that emitted the signal
</parameter_description>
</parameter>
<parameter name="width">
@@ -4192,14 +4492,14 @@ instance a backing surface.
<property name="GtkDrawingArea:content-height">
<description>
-The content height. See gtk_drawing_area_set_content_height() for details.
+The content height.
</description>
</property>
<property name="GtkDrawingArea:content-width">
<description>
-The content width. See gtk_drawing_area_set_content_width() for details.
+The content width.
</description>
</property>
@@ -4264,28 +4564,31 @@ Emitted when the pointer moves inside the widget.
<property name="GtkDropControllerMotion:contains-pointer">
<description>
-Whether the pointer of a drag and drop operation is in the controller's
-widget or a descendant.
-See also #GtkDropControllerMotion:is-pointer.
+Whether the pointer of a Drag-and-Drop operation is in
+the controller's widget or a descendant.
+
+See also [property@Gtk.DropControllerMotion:is-pointer].
When handling crossing events, this property is updated
-before #GtkDropControllerMotion::enter but after
-#GtkDropControllerMotion::leave is emitted.
+before [signal@Gtk.DropControllerMotion::enter], but after
+[signal@Gtk.DropControllerMotion::leave] is emitted.
</description>
</property>
<property name="GtkDropControllerMotion:drop">
<description>
-The ongoing drop operation over the controller's widget or its descendant.
+The ongoing drop operation over the controller's widget or
+its descendant.
+
If no drop operation is going on, this property returns %NULL.
-The event controller should not modify the @drop, but it might want to query
-its properties.
+The event controller should not modify the @drop, but it might
+want to query its properties.
When handling crossing events, this property is updated
-before #GtkDropControllerMotion::enter but after
-#GtkDropControllerMotion::leave is emitted.
+before [signal@Gtk.DropControllerMotion::enter], but after
+[signal@Gtk.DropControllerMotion::leave] is emitted.
</description>
</property>
@@ -4293,12 +4596,13 @@ before #GtkDropControllerMotion::enter but after
<property name="GtkDropControllerMotion:is-pointer">
<description>
Whether the pointer is in the controllers widget itself,
-as opposed to in a descendent widget. See also
-#GtkDropControllerMotion:contains-pointer.
+as opposed to in a descendent widget.
+
+See also [property@Gtk.DropControllerMotion:contains-pointer].
When handling crossing events, this property is updated
-before #GtkDropControllerMotion::enter but after
-#GtkDropControllerMotion::leave is emitted.
+before [signal@Gtk.DropControllerMotion::enter], but after
+[signal@Gtk.DropControllerMotion::leave] is emitted.
</description>
</property>
@@ -4307,7 +4611,8 @@ before #GtkDropControllerMotion::enter but after
<description>
Whether to show a search entry in the popup.
-Note that search requires #GtkDropDown:expression to be set.
+Note that search requires [property@Gtk.DropDown:expression]
+to be set.
</description>
</property>
@@ -4315,9 +4620,11 @@ Note that search requires #GtkDropDown:expression to be set.
<property name="GtkDropDown:expression">
<description>
An expression to evaluate to obtain strings to match against the search
-term (see #GtkDropDown:enable-search). If #GtkDropDown:factory is not set,
-the expression is also used to bind strings to labels produced by a
-default factory.
+term.
+
+See [property@Gtk.DropDown:enable-search] for how to enable search.
+If [property@Gtk.DropDown:factory] is not set, the expression is also
+used to bind strings to labels produced by a default factory.
</description>
</property>
@@ -4333,7 +4640,7 @@ Factory for populating list items.
<description>
The factory for populating list items in the popup.
-If this is not set, #GtkDropDown:factory is used.
+If this is not set, [property@Gtk.DropDown:factory] is used.
</description>
</property>
@@ -4347,8 +4654,10 @@ Model for the displayed items.
<property name="GtkDropDown:selected">
<description>
-The position of the selected item in #GtkDropDown:model,
-or #GTK_INVALID_LIST_POSITION if no item is selected.
+The position of the selected item.
+
+If no item is selected, the property has the value
+%GTK_INVALID_LIST_POSITION.
</description>
</property>
@@ -4362,31 +4671,32 @@ The selected item.
<signal name="GtkDropTarget::accept">
<description>
-The ::accept signal is emitted on the drop site when a drop operation
-is about to begin.
+Emitted on the drop site when a drop operation is about to begin.
+
If the drop is not accepted, %FALSE will be returned and the drop target
will ignore the drop. If %TRUE is returned, the drop is accepted for now
-but may be rejected later via a call to gtk_drop_target_reject() or
-ultimately by returning %FALSE from GtkDropTarget::drop
+but may be rejected later via a call to [method@Gtk.DropTarget.reject]
+or ultimately by returning %FALSE from a [signal@Gtk.DropTarget::drop]
+handler.
The default handler for this signal decides whether to accept the drop
based on the formats provided by the @drop.
-If the decision whether the drop will be accepted or rejected needs
-inspecting the data, this function should return %TRUE, the
-GtkDropTarget:preload property should be set and the value
-should be inspected via the GObject::notify:value signal and then call
-gtk_drop_target_reject().
+If the decision whether the drop will be accepted or rejected depends
+on the data, this function should return %TRUE, the
+[property@Gtk.DropTarget:preload] property should be set and the value
+should be inspected via the ::notify:value signal, calling
+[method@Gtk.DropTarget.reject] if required.
</description>
<parameters>
<parameter name="self">
-<parameter_description> the #GtkDropTarget
+<parameter_description> the `GtkDropTarget`
</parameter_description>
</parameter>
<parameter name="drop">
-<parameter_description> the #GdkDrop
+<parameter_description> the `GdkDrop`
</parameter_description>
</parameter>
</parameters>
@@ -4396,10 +4706,11 @@ gtk_drop_target_reject().
<signal name="GtkDropTarget::drop">
<description>
-The ::drop signal is emitted on the drop site when the user drops
-the data onto the widget. The signal handler must determine whether
-the pointer position is in a drop zone or not. If it is not in a drop
-zone, it returns %FALSE and no further processing is necessary.
+Emitted on the drop site when the user drops the data onto the widget.
+
+The signal handler must determine whether the pointer position is in
+a drop zone or not. If it is not in a drop zone, it returns %FALSE
+and no further processing is necessary.
Otherwise, the handler returns %TRUE. In this case, this handler will
accept the drop. The handler is responsible for rading the given @value
@@ -4409,7 +4720,7 @@ and performing the drop operation.
</description>
<parameters>
<parameter name="self">
-<parameter_description> the #GtkDropTarget
+<parameter_description> the `GtkDropTarget`
</parameter_description>
</parameter>
<parameter name="value">
@@ -4431,14 +4742,15 @@ and performing the drop operation.
<signal name="GtkDropTarget::enter">
<description>
-The ::enter signal is emitted on the drop site when the pointer
-enters the widget. It can be used to set up custom highlighting.
+Emitted on the drop site when the pointer enters the widget.
+
+It can be used to set up custom highlighting.
</description>
<parameters>
<parameter name="self">
-<parameter_description> the #GtkDropTarget
+<parameter_description> the `GtkDropTarget`
</parameter_description>
</parameter>
<parameter name="x">
@@ -4450,21 +4762,22 @@ enters the widget. It can be used to set up custom highlighting.
</parameter_description>
</parameter>
</parameters>
-<return> Preferred action for this drag operation or 0 if dropping is not
-supported at the current @x,@y location.
+<return> Preferred action for this drag operation or 0 if
+dropping is not supported at the current @x,@y location.
</return>
</signal>
<signal name="GtkDropTarget::leave">
<description>
-The ::leave signal is emitted on the drop site when the pointer
-leaves the widget. Its main purpose it to undo things done in
-#GtkDropTarget::enter.
+Emitted on the drop site when the pointer leaves the widget.
+
+Its main purpose it to undo things done in
+[signal@Gtk.DropTarget::enter].
</description>
<parameters>
<parameter name="self">
-<parameter_description> the #GtkDropTarget
+<parameter_description> the `GtkDropTarget`
</parameter_description>
</parameter>
</parameters>
@@ -4473,14 +4786,13 @@ leaves the widget. Its main purpose it to undo things done in
<signal name="GtkDropTarget::motion">
<description>
-The ::motion signal is emitted while the pointer is moving
-over the drop target.
+Emitted while the pointer is moving over the drop target.
</description>
<parameters>
<parameter name="self">
-<parameter_description> the #GtkDropTarget
+<parameter_description> the `GtkDropTarget`
</parameter_description>
</parameter>
<parameter name="x">
@@ -4492,28 +4804,28 @@ over the drop target.
</parameter_description>
</parameter>
</parameters>
-<return> Preferred action for this drag operation or 0 if dropping is not
-supported at the current @x,@y location.
+<return> Preferred action for this drag operation or 0 if
+dropping is not supported at the current @x,@y location.
</return>
</signal>
<property name="GtkDropTarget:actions">
<description>
-The #GdkDragActions that this drop target supports
+The `GdkDragActions` that this drop target supports.
</description>
</property>
<property name="GtkDropTarget:drop">
<description>
-The #GdkDrop that is currently being performed
+The `GdkDrop` that is currently being performed.
</description>
</property>
<property name="GtkDropTarget:formats">
<description>
-The #GdkContentFormats that determine the supported data formats
+The `GdkContentFormats` that determine the supported data formats.
</description>
</property>
@@ -4527,15 +4839,16 @@ Setting this property allows finer grained reaction to an ongoing
drop at the cost of loading more data.
The default value for this property is %FALSE to avoid downloading
-huge amounts of data by accident.
+huge amounts of data by accident.
+
For example, if somebody drags a full document of gigabytes of text
from a text editor across a widget with a preloading drop target,
this data will be downloaded, even if the data is ultimately dropped
elsewhere.
For a lot of data formats, the amount of data is very small (like
-%GDK_TYPE_RGBA), so enabling this property does not hurt at all.
-And for local-only drag'n'drop operations, no data transfer is done,
+%GDK_TYPE_RGBA), so enabling this property does not hurt at all.
+And for local-only Drag-and-Drop operations, no data transfer is done,
so enabling it there is free.
</description>
@@ -4543,25 +4856,28 @@ so enabling it there is free.
<property name="GtkDropTarget:value">
<description>
-The value for this drop operation or %NULL if the data has not been
-loaded yet or no drop operation is going on.
+The value for this drop operation.
-Data may be available before the GtkDropTarget::drop signal gets emitted -
-for example when the GtkDropTarget:preload property is set.
-You can use the GObject::notify signal to be notified of available data.
+This is %NULL if the data has not been loaded yet or no drop
+operation is going on.
+
+Data may be available before the [signal@Gtk.DropTarget::drop]
+signal gets emitted - for example when the [property@Gtk.DropTarget:preload]
+property is set. You can use the ::notify signal to be notified
+of available data.
</description>
</property>
<signal name="GtkDropTargetAsync::accept">
<description>
-The ::accept signal is emitted on the drop site when a drop operation
-is about to begin.
+Emitted on the drop site when a drop operation is about to begin.
If the drop is not accepted, %FALSE will be returned and the drop target
will ignore the drop. If %TRUE is returned, the drop is accepted for now
-but may be rejected later via a call to gtk_drop_target_async_reject() or
-ultimately by returning %FALSE from #GtkDropTargetAsync::drop.
+but may be rejected later via a call to [method@Gtk.DropTargetAsync.reject_drop]
+or ultimately by returning %FALSE from a [signal@Gtk.DropTargetAsync::drop]
+handler.
The default handler for this signal decides whether to accept the drop
based on the formats provided by the @drop.
@@ -4569,13 +4885,13 @@ based on the formats provided by the @drop.
If the decision whether the drop will be accepted or rejected needs
further processing, such as inspecting the data, this function should
return %TRUE and proceed as is @drop was accepted and if it decides to
-reject the drop later, it should call gtk_drop_target_async_reject_drop().
+reject the drop later, it should call [method@Gtk.DropTargetAsync.reject_drop].
</description>
<parameters>
<parameter name="self">
-<parameter_description> the #GtkDropTargetAsync
+<parameter_description> the `GtkDropTargetAsync`
</parameter_description>
</parameter>
<parameter name="drop">
@@ -4589,14 +4905,15 @@ reject the drop later, it should call gtk_drop_target_async_reject_drop().
<signal name="GtkDropTargetAsync::drag-enter">
<description>
-The ::drag-enter signal is emitted on the drop site when the pointer
-enters the widget. It can be used to set up custom highlighting.
+Emitted on the drop site when the pointer enters the widget.
+
+It can be used to set up custom highlighting.
</description>
<parameters>
<parameter name="self">
-<parameter_description> the #GtkDropTargetAsync
+<parameter_description> the `GtkDropTargetAsync`
</parameter_description>
</parameter>
<parameter name="drop">
@@ -4612,20 +4929,21 @@ enters the widget. It can be used to set up custom highlighting.
</parameter_description>
</parameter>
</parameters>
-<return> Preferred action for this drag operation.
+<return> Preferred action for this drag operation.
</return>
</signal>
<signal name="GtkDropTargetAsync::drag-leave">
<description>
-The ::drag-leave signal is emitted on the drop site when the pointer
-leaves the widget. Its main purpose it to undo things done in
-#GtkDropTargetAsync::drag-enter.
+Emitted on the drop site when the pointer leaves the widget.
+
+Its main purpose it to undo things done in
+`GtkDropTargetAsync`::drag-enter.
</description>
<parameters>
<parameter name="self">
-<parameter_description> the #GtkDropTargetAsync
+<parameter_description> the `GtkDropTargetAsync`
</parameter_description>
</parameter>
<parameter name="drop">
@@ -4638,14 +4956,13 @@ leaves the widget. Its main purpose it to undo things done in
<signal name="GtkDropTargetAsync::drag-motion">
<description>
-The ::drag-motion signal is emitted while the pointer is moving
-over the drop target.
+Emitted while the pointer is moving over the drop target.
</description>
<parameters>
<parameter name="self">
-<parameter_description> the #GtkDropTargetAsync
+<parameter_description> the `GtkDropTargetAsync`
</parameter_description>
</parameter>
<parameter name="drop">
@@ -4661,30 +4978,32 @@ over the drop target.
</parameter_description>
</parameter>
</parameters>
-<return> Preferred action for this drag operation.
+<return> Preferred action for this drag operation.
</return>
</signal>
<signal name="GtkDropTargetAsync::drop">
<description>
-The ::drop signal is emitted on the drop site when the user drops
-the data onto the widget. The signal handler must determine whether
-the pointer position is in a drop zone or not. If it is not in a drop
-zone, it returns %FALSE and no further processing is necessary.
+Emitted on the drop site when the user drops the data onto the widget.
+
+The signal handler must determine whether the pointer position is in a
+drop zone or not. If it is not in a drop zone, it returns %FALSE and no
+further processing is necessary.
Otherwise, the handler returns %TRUE. In this case, this handler will
-accept the drop. The handler must ensure that gdk_drop_finish() is
-called to let the source know that the drop is done. The call to
-gdk_drop_finish() must only be done when all data has been received.
+accept the drop. The handler must ensure that [method Gdk Drop.finish]
+is called to let the source know that the drop is done. The call to
+[method Gdk Drop.finish] must only be done when all data has been received.
-To receive the data, use one of the read functions provides by #GdkDrop
-such as gdk_drop_read_async() or gdk_drop_read_value_async().
+To receive the data, use one of the read functions provided by
+[class Gdk Drop] such as [method Gdk Drop.read_async] or
+[method Gdk Drop.read_value_async].
</description>
<parameters>
<parameter name="self">
-<parameter_description> the #GtkDropTargetAsync
+<parameter_description> the `GtkDropTargetAsync`
</parameter_description>
</parameter>
<parameter name="drop">
@@ -4706,22 +5025,22 @@ such as gdk_drop_read_async() or gdk_drop_read_value_async().
<property name="GtkDropTargetAsync:actions">
<description>
-The #GdkDragActions that this drop target supports
+The `GdkDragActions` that this drop target supports.
</description>
</property>
<property name="GtkDropTargetAsync:formats">
<description>
-The #GdkContentFormats that determines the supported data formats
+The `GdkContentFormats` that determines the supported data formats.
</description>
</property>
<signal name="GtkEditable::changed">
<description>
-The ::changed signal is emitted at the end of a single
-user-visible operation on the contents of the #GtkEditable.
+Emitted at the end of a single user-visible operation on the
+contents.
E.g., a paste operation that replaces the contents of the
selection will cause only one signal emission (even though it
@@ -4741,15 +5060,15 @@ to be emitted).
<signal name="GtkEditable::delete-text">
<description>
-This signal is emitted when text is deleted from
-the widget by the user. The default handler for
-this signal will normally be responsible for deleting
-the text, so by connecting to this signal and then
-stopping the signal with g_signal_stop_emission(), it
-is possible to modify the range of deleted text, or
-prevent it from being deleted entirely. The @start_pos
-and @end_pos parameters are interpreted as for
-gtk_editable_delete_text().
+Emitted when text is deleted from the widget by the user.
+
+The default handler for this signal will normally be responsible for
+deleting the text, so by connecting to this signal and then stopping
+the signal with g_signal_stop_emission(), it is possible to modify the
+range of deleted text, or prevent it from being deleted entirely.
+
+The @start_pos and @end_pos parameters are interpreted as for
+[method@Gtk.Editable.delete_text].
</description>
<parameters>
@@ -4771,13 +5090,12 @@ gtk_editable_delete_text().
<signal name="GtkEditable::insert-text">
<description>
-This signal is emitted when text is inserted into
-the widget by the user. The default handler for
-this signal will normally be responsible for inserting
-the text, so by connecting to this signal and then
-stopping the signal with g_signal_stop_emission(), it
-is possible to modify the inserted text, or prevent
-it from being inserted entirely.
+Emitted when text is inserted into the widget by the user.
+
+The default handler for this signal will normally be responsible
+for inserting the text, so by connecting to this signal and then
+stopping the signal with g_signal_stop_emission(), it is possible
+to modify the inserted text, or prevent it from being inserted entirely.
</description>
<parameters>
@@ -4805,6 +5123,64 @@ should point after the newly inserted text.
<return></return>
</signal>
+<property name="GtkEditable:cursor-position">
+<description>
+The current position of the insertion cursor in chars.
+
+</description>
+</property>
+
+<property name="GtkEditable:editable">
+<description>
+Whether the entry contents can be edited.
+
+</description>
+</property>
+
+<property name="GtkEditable:enable-undo">
+<description>
+If undo/redo should be enabled for the editable.
+
+</description>
+</property>
+
+<property name="GtkEditable:max-width-chars">
+<description>
+The desired maximum width of the entry, in characters.
+
+</description>
+</property>
+
+<property name="GtkEditable:selection-bound">
+<description>
+The position of the opposite end of the selection from the cursor in chars.
+
+</description>
+</property>
+
+<property name="GtkEditable:text">
+<description>
+The contents of the entry.
+
+</description>
+</property>
+
+<property name="GtkEditable:width-chars">
+<description>
+Number of characters to leave space for in the entry.
+
+</description>
+</property>
+
+<property name="GtkEditable:xalign">
+<description>
+The horizontal alignment, from 0 (left) to 1 (right).
+
+Reversed for RTL layouts.
+
+</description>
+</property>
+
<property name="GtkEditableLabel:editing">
<description>
This property is %TRUE while the widget is in edit mode.
@@ -4814,13 +5190,12 @@ This property is %TRUE while the widget is in edit mode.
<signal name="GtkEmojiChooser::emoji-picked">
<description>
-The ::emoji-picked signal is emitted when the user selects an
-Emoji.
+Emitted when the user selects an Emoji.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> the #GtkEmojiChooser
+<parameter_description> the `GtkEmojiChooser`
</parameter_description>
</parameter>
<parameter name="text">
@@ -4833,9 +5208,9 @@ Emoji.
<signal name="GtkEntry::activate">
<description>
-The ::activate signal is forwarded from the
-#GtkText::activated signal, which is a keybinding
-signal for all forms of the Enter key.
+Emitted when the entry is activated.
+
+The keybindings for this signal are all forms of the Enter key.
</description>
<parameters>
@@ -4849,8 +5224,7 @@ signal for all forms of the Enter key.
<signal name="GtkEntry::icon-press">
<description>
-The ::icon-press signal is emitted when an activatable icon
-is clicked.
+Emitted when an activatable icon is clicked.
</description>
<parameters>
@@ -4868,8 +5242,8 @@ is clicked.
<signal name="GtkEntry::icon-release">
<description>
-The ::icon-release signal is emitted on the button release from a
-mouse click over an activatable icon.
+Emitted on the button release from a mouse click
+over an activatable icon.
</description>
<parameters>
@@ -4887,8 +5261,8 @@ mouse click over an activatable icon.
<signal name="GtkEntry::show-emoji-icon">
<description>
-When this is %TRUE, the entry will show an emoji icon in the secondary
-icon position that brings up the Emoji chooser when clicked.
+Whether the entry will sohw an Emoji icon in the secondary icon position
+to open the Emoji chooser.
</description>
<parameters>
@@ -4906,6 +5280,13 @@ A list of tabstops to apply to the text of the entry.
<return></return>
</signal>
+<property name="GtkEntry:activates-default">
+<description>
+Whether to activate the default widget when Enter is pressed.
+
+</description>
+</property>
+
<property name="GtkEntry:attributes">
<description>
A list of Pango attributes to apply to the text of the entry.
@@ -4913,7 +5294,14 @@ A list of Pango attributes to apply to the text of the entry.
This is mainly useful to change the size or weight of the text.
The #PangoAttribute's @start_index and @end_index must refer to the
-#GtkEntryBuffer text, i.e. without the preedit string.
+[class@Gtk.EntryBuffer] text, i.e. without the preedit string.
+
+</description>
+</property>
+
+<property name="GtkEntry:buffer">
+<description>
+The buffer object which actually stores the text.
</description>
</property>
@@ -4925,10 +5313,24 @@ The auxiliary completion object to use with the entry.
</description>
</property>
+<property name="GtkEntry:enable-emoji-completion">
+<description>
+Whether to suggest Emoji replacements for :-delimited names
+like `:heart:`.
+
+</description>
+</property>
+
<property name="GtkEntry:extra-menu">
<description>
-A menu model whose contents will be appended to
-the context menu.
+A menu model whose contents will be appended to the context menu.
+
+</description>
+</property>
+
+<property name="GtkEntry:has-frame">
+<description>
+Whehter the entry should draw a frame.
</description>
</property>
@@ -4936,19 +5338,21 @@ the context menu.
<property name="GtkEntry:im-module">
<description>
Which IM (input method) module should be used for this entry.
-See #GtkIMContext.
-Setting this to a non-%NULL value overrides the
-system-wide IM module setting. See the GtkSettings
-#GtkSettings:gtk-im-module property.
+See [class@Gtk.IMContext].
+
+Setting this to a non-%NULL value overrides the system-wide IM
+module setting. See the GtkSettings [property@Gtk.Settings:gtk-im-module]
+property.
</description>
</property>
<property name="GtkEntry:input-hints">
<description>
-Additional hints (beyond #GtkEntry:input-purpose) that
-allow input methods to fine-tune their behaviour.
+Additional hints that allow input methods to fine-tune their behavior.
+
+Also see [property@Gtk.Entry:input-purpose]
</description>
</property>
@@ -4962,28 +5366,42 @@ methods to adjust their behaviour.
Note that setting the purpose to %GTK_INPUT_PURPOSE_PASSWORD or
%GTK_INPUT_PURPOSE_PIN is independent from setting
-#GtkEntry:visibility.
+[property@Gtk.Entry:visibility].
+
+</description>
+</property>
+
+<property name="GtkEntry:invisible-char">
+<description>
+The character to use when masking entry contents (“password mode”).
</description>
</property>
<property name="GtkEntry:invisible-char-set">
<description>
-Whether the invisible char has been set for the #GtkEntry.
+Whether the invisible char has been set for the `GtkEntry`.
+
+</description>
+</property>
+
+<property name="GtkEntry:max-length">
+<description>
+Maximum number of characters for this entry.
</description>
</property>
<property name="GtkEntry:overwrite-mode">
<description>
-If text is overwritten when typing in the #GtkEntry.
+If text is overwritten when typing in the `GtkEntry`.
</description>
</property>
<property name="GtkEntry:placeholder-text">
<description>
-The text that will be displayed in the #GtkEntry when it is empty
+The text that will be displayed in the `GtkEntry` when it is empty
and unfocused.
</description>
@@ -4993,8 +5411,9 @@ and unfocused.
<description>
Whether the primary icon is activatable.
-GTK emits the #GtkEntry::icon-press and #GtkEntry::icon-release
-signals only on sensitive, activatable icons.
+GTK emits the [signal@Gtk.Entry::icon-press] and
+[signal@Gtk.Entry::icon-release] signals only on sensitive,
+activatable icons.
Sensitive, but non-activatable icons can be used for purely
informational purposes.
@@ -5004,7 +5423,7 @@ informational purposes.
<property name="GtkEntry:primary-icon-gicon">
<description>
-The #GIcon to use for the primary icon for the entry.
+The `GIcon` to use for the primary icon for the entry.
</description>
</property>
@@ -5018,7 +5437,7 @@ The icon name to use for the primary icon for the entry.
<property name="GtkEntry:primary-icon-paintable">
<description>
-A #GdkPaintable to use as the primary icon for the entry.
+A `GdkPaintable` to use as the primary icon for the entry.
</description>
</property>
@@ -5028,8 +5447,8 @@ A #GdkPaintable to use as the primary icon for the entry.
Whether the primary icon is sensitive.
An insensitive icon appears grayed out. GTK does not emit the
-#GtkEntry::icon-press and #GtkEntry::icon-release signals and
-does not allow DND from insensitive icons.
+[signal@Gtk.Entry::icon-press] and [signal@Gtk.Entry::icon-release]
+signals and does not allow DND from insensitive icons.
An icon should be set insensitive if the action that would trigger
when clicked is currently not available.
@@ -5046,10 +5465,9 @@ The representation which is used for the primary icon of the entry.
<property name="GtkEntry:primary-icon-tooltip-markup">
<description>
-The contents of the tooltip on the primary icon, which is marked up
-with the [Pango text markup language][PangoMarkupFormat].
+The contents of the tooltip on the primary icon, with markup.
-Also see gtk_entry_set_icon_tooltip_markup().
+Also see [method@Gtk.Entry.set_icon_tooltip_markup].
</description>
</property>
@@ -5058,7 +5476,7 @@ Also see gtk_entry_set_icon_tooltip_markup().
<description>
The contents of the tooltip on the primary icon.
-Also see gtk_entry_set_icon_tooltip_text().
+Also see [method@Gtk.Entry.set_icon_tooltip_text].
</description>
</property>
@@ -5073,7 +5491,16 @@ The current fraction of the task that's been completed.
<property name="GtkEntry:progress-pulse-step">
<description>
The fraction of total entry width to move the progress
-bouncing block for each call to gtk_entry_progress_pulse().
+bouncing block for each pulse.
+
+See [method@Gtk.Entry.progress_pulse].
+
+</description>
+</property>
+
+<property name="GtkEntry:scroll-offset">
+<description>
+Number of pixels of the entry scrolled off the screen to the left.
</description>
</property>
@@ -5082,8 +5509,9 @@ bouncing block for each call to gtk_entry_progress_pulse().
<description>
Whether the secondary icon is activatable.
-GTK emits the #GtkEntry::icon-press and #GtkEntry::icon-release
-signals only on sensitive, activatable icons.
+GTK emits the [signal@Gtk.Entry::icon-press] and
+[signal@Gtk.Entry::icon-release] signals only on sensitive,
+activatable icons.
Sensitive, but non-activatable icons can be used for purely
informational purposes.
@@ -5093,7 +5521,7 @@ informational purposes.
<property name="GtkEntry:secondary-icon-gicon">
<description>
-The #GIcon to use for the secondary icon for the entry.
+The `GIcon` to use for the secondary icon for the entry.
</description>
</property>
@@ -5107,7 +5535,7 @@ The icon name to use for the secondary icon for the entry.
<property name="GtkEntry:secondary-icon-paintable">
<description>
-A #GdkPaintable to use as the secondary icon for the entry.
+A `GdkPaintable` to use as the secondary icon for the entry.
</description>
</property>
@@ -5117,8 +5545,8 @@ A #GdkPaintable to use as the secondary icon for the entry.
Whether the secondary icon is sensitive.
An insensitive icon appears grayed out. GTK does not emit the
-#GtkEntry::icon-press and #GtkEntry::icon-release signals and
-does not allow DND from insensitive icons.
+[signal@Gtk.Entry::icon-press[ and [signal@Gtk.Entry::icon-release]
+signals and does not allow DND from insensitive icons.
An icon should be set insensitive if the action that would trigger
when clicked is currently not available.
@@ -5135,10 +5563,9 @@ The representation which is used for the secondary icon of the entry.
<property name="GtkEntry:secondary-icon-tooltip-markup">
<description>
-The contents of the tooltip on the secondary icon, which is marked up
-with the [Pango text markup language][PangoMarkupFormat].
+The contents of the tooltip on the secondary icon, with markup.
-Also see gtk_entry_set_icon_tooltip_markup().
+Also see [method@Gtk.Entry.set_icon_tooltip_markup].
</description>
</property>
@@ -5147,14 +5574,14 @@ Also see gtk_entry_set_icon_tooltip_markup().
<description>
The contents of the tooltip on the secondary icon.
-Also see gtk_entry_set_icon_tooltip_text().
+Also see [method@Gtk.Entry.set_icon_tooltip_text].
</description>
</property>
<property name="GtkEntry:text-length">
<description>
-The length of the text in the #GtkEntry.
+The length of the text in the `GtkEntry`.
</description>
</property>
@@ -5166,11 +5593,20 @@ When %TRUE, pasted multi-line text is truncated to the first line.
</description>
</property>
+<property name="GtkEntry:visibility">
+<description>
+Whether the entry should show the “invisible char” instead of the
+actual text (“password mode”).
+
+</description>
+</property>
+
<signal name="GtkEntryBuffer::deleted-text">
<description>
-The text is altered in the default handler for this signal. If you want
-access to the text after the text has been modified, use
-%G_CONNECT_AFTER.
+The text is altered in the default handler for this signal.
+
+If you want access to the text after the text has been modified,
+use %G_CONNECT_AFTER.
</description>
<parameters>
@@ -5239,13 +5675,14 @@ The contents of the buffer.
<signal name="GtkEntryCompletion::cursor-on-match">
<description>
-Gets emitted when a match from the cursor is on a match
-of the list. The default behaviour is to replace the contents
+Emitted when a match from the cursor is on a match of the list.
+
+The default behaviour is to replace the contents
of the entry with the contents of the text column in the row
pointed to by @iter.
Note that @model is the model that was passed to
-gtk_entry_completion_set_model().
+[method@Gtk.EntryCompletion.set_model].
</description>
@@ -5255,11 +5692,11 @@ gtk_entry_completion_set_model().
</parameter_description>
</parameter>
<parameter name="model">
-<parameter_description> the #GtkTreeModel containing the matches
+<parameter_description> the `GtkTreeModel` containing the matches
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTreeIter positioned at the selected match
+<parameter_description> a `GtkTreeIter` positioned at the selected match
</parameter_description>
</parameter>
</parameters>
@@ -5269,7 +5706,8 @@ gtk_entry_completion_set_model().
<signal name="GtkEntryCompletion::insert-prefix">
<description>
-Gets emitted when the inline autocompletion is triggered.
+Emitted when the inline autocompletion is triggered.
+
The default behaviour is to make the entry display the
whole prefix and select the newly inserted part.
@@ -5296,13 +5734,14 @@ next '/'.
<signal name="GtkEntryCompletion::match-selected">
<description>
-Gets emitted when a match from the list is selected.
+Emitted when a match from the list is selected.
+
The default behaviour is to replace the contents of the
entry with the contents of the text column in the row
pointed to by @iter.
Note that @model is the model that was passed to
-gtk_entry_completion_set_model().
+[method@Gtk.EntryCompletion.set_model].
</description>
@@ -5312,11 +5751,11 @@ gtk_entry_completion_set_model().
</parameter_description>
</parameter>
<parameter name="model">
-<parameter_description> the #GtkTreeModel containing the matches
+<parameter_description> the `GtkTreeModel` containing the matches
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTreeIter positioned at the selected match
+<parameter_description> a `GtkTreeIter` positioned at the selected match
</parameter_description>
</parameter>
</parameters>
@@ -5326,10 +5765,10 @@ gtk_entry_completion_set_model().
<signal name="GtkEntryCompletion::no-matches">
<description>
-Gets emitted when the filter model has zero
+Emitted when the filter model has zero
number of rows in completion_complete method.
-(In other words when GtkEntryCompletion is out of
-suggestions)
+
+In other words when `GtkEntryCompletion` is out of suggestions.
</description>
<parameters>
@@ -5343,11 +5782,11 @@ suggestions)
<property name="GtkEntryCompletion:cell-area">
<description>
-The #GtkCellArea used to layout cell renderers in the treeview column.
+The `GtkCellArea` used to layout cell renderers in the treeview column.
If no area is specified when creating the entry completion with
-gtk_entry_completion_new_with_area() a horizontally oriented
-#GtkCellAreaBox will be used.
+[ctor@Gtk.EntryCompletion.new_with_area], a horizontally oriented
+[class@Gtk.CellAreaBox] will be used.
</description>
</property>
@@ -5355,9 +5794,10 @@ gtk_entry_completion_new_with_area() a horizontally oriented
<property name="GtkEntryCompletion:inline-completion">
<description>
Determines whether the common prefix of the possible completions
-should be inserted automatically in the entry. Note that this
-requires text-column to be set, even if you are using a custom
-match function.
+should be inserted automatically in the entry.
+
+Note that this requires text-column to be set, even if you are
+using a custom match function.
</description>
</property>
@@ -5389,9 +5829,10 @@ resized to the width of the entry.
<property name="GtkEntryCompletion:popup-single-match">
<description>
Determines whether the completions popup window will shown
-for a single possible completion. You probably want to set
-this to %FALSE if you are using
-[inline completion][GtkEntryCompletion--inline-completion].
+for a single possible completion.
+
+You probably want to set this to %FALSE if you are using
+[property@Gtk.EntryCompletion:inline-completion].
</description>
</property>
@@ -5399,6 +5840,7 @@ this to %FALSE if you are using
<property name="GtkEntryCompletion:text-column">
<description>
The column of the model containing the strings.
+
Note that the strings must be UTF-8.
</description>
@@ -5444,21 +5886,22 @@ The propagation phase at which this controller will handle events.
<property name="GtkEventController:widget">
<description>
-The widget receiving the #GdkEvents that the controller will handle.
+The widget receiving the `GdkEvents` that the controller will handle.
</description>
</property>
<signal name="GtkEventControllerFocus::enter">
<description>
-This signal is emitted whenever the focus enters into the
-widget or one of its descendents.
+Emitted whenever the focus enters into the widget or one
+of its descendents.
Note that this means you may not get an ::enter signal
even though the widget becomes the focus location, in
certain cases (such as when the focus moves from a descendent
of the widget to the widget itself). If you are interested
-in these cases, you can monitor the #GtkEventControllerFocus:is-focus
+in these cases, you can monitor the
+[property@Gtk.EventControllerFocus:is-focus]
property for changes.
</description>
@@ -5473,16 +5916,15 @@ property for changes.
<signal name="GtkEventControllerFocus::leave">
<description>
-This signal is emitted whenever the focus leaves the
-widget hierarchy that is rooted at the widget that the
-controller is attached to.
+Emitted whenever the focus leaves the widget hierarchy
+that is rooted at the widget that the controller is attached to.
Note that this means you may not get a ::leave signal
even though the focus moves away from the widget, in
certain cases (such as when the focus moves from the widget
to a descendent). If you are interested in these cases, you
-can monitor the #GtkEventControllerFocus:is-focus property
-for changes.
+can monitor the [property@Gtk.EventControllerFocus:is-focus]
+property for changes.
</description>
<parameters>
@@ -5496,36 +5938,39 @@ for changes.
<property name="GtkEventControllerFocus:contains-focus">
<description>
-Whether focus is contain in the controllers widget. See
-See #GtkEventControllerFocus:is-focus for whether the focus is in the widget itself
-or inside a descendent.
+%TRUE if focus is contained in the controllers widget.
+
+See [property@Gtk.EventControllerFocus:is-focus] for whether
+the focus is in the widget itself or inside a descendent.
When handling focus events, this property is updated
-before #GtkEventControllerFocus::enter or
-#GtkEventControllerFocus::leave are emitted.
+before [signal@Gtk.EventControllerFocus::enter] or
+[signal@Gtk.EventControllerFocus::leave] are emitted.
</description>
</property>
<property name="GtkEventControllerFocus:is-focus">
<description>
-Whether focus is in the controllers widget itself,
-opposed to in a descendent widget. See also
-#GtkEventControllerFocus:contains-focus.
+%TRUE if focus is in the controllers widget itself,
+as opposed to in a descendent widget.
+
+See also [property@Gtk.EventControllerFocus:contains-focus].
When handling focus events, this property is updated
-before #GtkEventControllerFocus::enter or
-#GtkEventControllerFocus::leave are emitted.
+before [signal@Gtk.EventControllerFocus::enter] or
+[signal@Gtk.EventControllerFocus::leave] are emitted.
</description>
</property>
<signal name="GtkEventControllerKey::im-update">
<description>
-This signal is emitted whenever the input method context filters away a
-keypress and prevents the @controller receiving it. See
-gtk_event_controller_key_set_im_context() and
-gtk_im_context_filter_keypress().
+Emitted whenever the input method context filters away
+a keypress and prevents the @controller receiving it.
+
+See [method@Gtk.EventControllerKey.set_im_context] and
+[method@Gtk.IMContext.filter_keypress].
</description>
<parameters>
@@ -5539,7 +5984,7 @@ gtk_im_context_filter_keypress().
<signal name="GtkEventControllerKey::key-pressed">
<description>
-This signal is emitted whenever a key is pressed.
+Emitted whenever a key is pressed.
</description>
@@ -5567,7 +6012,7 @@ This signal is emitted whenever a key is pressed.
<signal name="GtkEventControllerKey::key-released">
<description>
-This signal is emitted whenever a key is released.
+Emitted whenever a key is released.
</description>
<parameters>
@@ -5593,8 +6038,7 @@ This signal is emitted whenever a key is released.
<signal name="GtkEventControllerKey::modifiers">
<description>
-This signal is emitted whenever the state of modifier keys and pointer
-buttons change.
+Emitted whenever the state of modifier keys and pointer buttons change.
</description>
<parameters>
@@ -5623,11 +6067,11 @@ Emitted for each GDK event delivered to @controller.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> the object which received the signal.
+<parameter_description> the object which received the signal
</parameter_description>
</parameter>
<parameter name="event">
-<parameter_description> the #GdkEvent which triggered this signal
+<parameter_description> the `GdkEvent` which triggered this signal
</parameter_description>
</parameter>
</parameters>
@@ -5697,11 +6141,12 @@ Emitted when the pointer moves inside the widget.
<property name="GtkEventControllerMotion:contains-pointer">
<description>
Whether the pointer is in the controllers widget or a descendant.
-See also #GtkEventControllerMotion:is-pointer.
+
+See also [property@Gtk.EventControllerMotion:is-pointer].
When handling crossing events, this property is updated
-before #GtkEventControllerMotion::enter but after
-#GtkEventControllerMotion::leave is emitted.
+before [signal@Gtk.EventControllerMotion::enter], but after
+[signal@Gtk.EventControllerMotion::leave] is emitted.
</description>
</property>
@@ -5709,20 +6154,23 @@ before #GtkEventControllerMotion::enter but after
<property name="GtkEventControllerMotion:is-pointer">
<description>
Whether the pointer is in the controllers widget itself,
-as opposed to in a descendent widget. See also
-#GtkEventControllerMotion:contains-pointer.
+as opposed to in a descendent widget.
+
+See also [property@Gtk.EventControllerMotion:contains-pointer].
When handling crossing events, this property is updated
-before #GtkEventControllerMotion::enter but after
-#GtkEventControllerMotion::leave is emitted.
+before [signal@Gtk.EventControllerMotion::enter], but after
+[signal@Gtk.EventControllerMotion::leave] is emitted.
</description>
</property>
<signal name="GtkEventControllerScroll::decelerate">
<description>
-Emitted after scroll is finished if the #GTK_EVENT_CONTROLLER_SCROLL_KINETIC
-flag is set. @vel_x and @vel_y express the initial velocity that was
+Emitted after scroll is finished if the
+%GTK_EVENT_CONTROLLER_SCROLL_KINETIC flag is set.
+
+@vel_x and @vel_y express the initial velocity that was
imprinted by the scroll events. @vel_x and @vel_y are expressed in
pixels/ms.
@@ -5765,14 +6213,16 @@ amount specified by @dx and @dy.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the scroll event was handled, %FALSE otherwise.
+<return> %TRUE if the scroll event was handled,
+%FALSE otherwise.
</return>
</signal>
<signal name="GtkEventControllerScroll::scroll-begin">
<description>
-Signals that a new scrolling operation has begun. It will
-only be emitted on devices capable of it.
+Signals that a new scrolling operation has begun.
+
+It will only be emitted on devices capable of it.
</description>
<parameters>
@@ -5786,8 +6236,9 @@ only be emitted on devices capable of it.
<signal name="GtkEventControllerScroll::scroll-end">
<description>
-Signals that a new scrolling operation has finished. It will
-only be emitted on devices capable of it.
+Signals that a scrolling operation has finished.
+
+It will only be emitted on devices capable of it.
</description>
<parameters>
@@ -5801,14 +6252,14 @@ only be emitted on devices capable of it.
<property name="GtkEventControllerScroll:flags">
<description>
-The flags affecting event controller behavior
+The flags affecting event controller behavior.
</description>
</property>
<enum name="GtkEventControllerScrollFlags">
<description>
-Describes the behavior of a #GtkEventControllerScroll.
+Describes the behavior of a `GtkEventControllerScroll`.
</description>
<parameters>
@@ -5829,8 +6280,7 @@ Describes the behavior of a #GtkEventControllerScroll.
</parameter_description>
</parameter>
<parameter name="GTK_EVENT_CONTROLLER_SCROLL_KINETIC">
-<parameter_description> Emit #GtkEventControllerScroll::decelerate
-after continuous scroll finishes.
+<parameter_description> Emit ::decelerate after continuous scroll finishes.
</parameter_description>
</parameter>
<parameter name="GTK_EVENT_CONTROLLER_SCROLL_BOTH_AXES">
@@ -5842,7 +6292,7 @@ after continuous scroll finishes.
<enum name="GtkEventSequenceState">
<description>
-Describes the state of a #GdkEventSequence in a #GtkGesture.
+Describes the state of a `GdkEventSequence` in a `GtkGesture`.
</description>
<parameters>
@@ -5863,18 +6313,46 @@ Describes the state of a #GdkEventSequence in a #GtkGesture.
<signal name="GtkExpander::activate">
<description>
-Activates the #GtkExpander.
+Activates the `GtkExpander`.
</description>
<parameters>
<parameter name="expander">
-<parameter_description> the #GtkExpander that emitted the signal
+<parameter_description> the `GtkExpander` that emitted the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>
+<property name="GtkExpander:child">
+<description>
+The child widget.
+
+</description>
+</property>
+
+<property name="GtkExpander:expanded">
+<description>
+Whether the expander has been opened to reveal the child.
+
+</description>
+</property>
+
+<property name="GtkExpander:label">
+<description>
+The text of the expanders label.
+
+</description>
+</property>
+
+<property name="GtkExpander:label-widget">
+<description>
+A widget to display instead of the usual expander label.
+
+</description>
+</property>
+
<property name="GtkExpander:resize-toplevel">
<description>
When this property is %TRUE, the expander will resize the toplevel
@@ -5883,6 +6361,27 @@ widget containing the expander upon expanding and collapsing.
</description>
</property>
+<property name="GtkExpander:use-markup">
+<description>
+Whether the text in the label is Pango markup.
+
+</description>
+</property>
+
+<property name="GtkExpander:use-underline">
+<description>
+Whether an underline in the text indicates a mnemonic.
+
+</description>
+</property>
+
+<property name="GtkFileChooser:action">
+<description>
+The type of operation that the file chooser is performing.
+
+</description>
+</property>
+
<property name="GtkFileChooser:create-folders">
<description>
Whether a file chooser not in %GTK_FILE_CHOOSER_ACTION_OPEN mode
@@ -5891,9 +6390,16 @@ will offer the user to create new folders.
</description>
</property>
+<property name="GtkFileChooser:filter">
+<description>
+The current filter for selecting files that are displayed.
+
+</description>
+</property>
+
<property name="GtkFileChooser:filters">
<description>
-A #GListModel containing the filters that have been
+A `GListModel` containing the filters that have been
added with gtk_file_chooser_add_filter().
The returned object should not be modified. It may
@@ -5902,9 +6408,16 @@ or may not be updated for later changes.
</description>
</property>
+<property name="GtkFileChooser:select-multiple">
+<description>
+Whether to allow multiple files to be selected.
+
+</description>
+</property>
+
<property name="GtkFileChooser:shortcut-folders">
<description>
-A #GListModel containing the shortcut folders that have been
+A `GListModel` containing the shortcut folders that have been
added with gtk_file_chooser_add_shortcut_folder().
The returned object should not be modified. It may
@@ -5915,7 +6428,7 @@ or may not be updated for later changes.
<enum name="GtkFileChooserAction">
<description>
-Describes whether a #GtkFileChooser is being used to open existing files
+Describes whether a `GtkFileChooser` is being used to open existing files
or to save to a possibly new file.
</description>
@@ -5943,7 +6456,7 @@ existing folder.
<enum name="GtkFileChooserError">
<description>
These identify the various errors that can occur while calling
-#GtkFileChooser functions.
+`GtkFileChooser` functions.
</description>
<parameters>
@@ -5986,13 +6499,14 @@ The text used for the label on the cancel button in the dialog, or
<signal name="GtkFileChooserWidget::desktop-folder">
<description>
-The ::desktop-folder signal is a [keybinding signal][GtkSignalAction]
-which gets emitted when the user asks for it.
+Emitted when the user asks for it.
+
+This is a [keybinding signal](class.SignalAction.html).
This is used to make the file chooser show the user's Desktop
folder in the file list.
-The default binding for this signal is `Alt + D`.
+The default binding for this signal is <kbd>Alt</kbd>-<kbd>D</kbd>.
</description>
<parameters>
@@ -6006,16 +6520,18 @@ The default binding for this signal is `Alt + D`.
<signal name="GtkFileChooserWidget::down-folder">
<description>
-The ::down-folder signal is a [keybinding signal][GtkSignalAction]
-which gets emitted when the user asks for it.
+Emitted when the user asks for it.
-This is used to make the file chooser go to a child of the current folder
-in the file hierarchy. The subfolder that will be used is displayed in the
-path bar widget of the file chooser. For example, if the path bar is showing
-"/foo/bar/baz", with bar currently displayed, then this will cause the file
-chooser to switch to the "baz" subfolder.
+This is a [keybinding signal](class.SignalAction.html).
-The default binding for this signal is `Alt + Down`.
+This is used to make the file chooser go to a child of the
+current folder in the file hierarchy. The subfolder that will
+be used is displayed in the path bar widget of the file chooser.
+For example, if the path bar is showing "/foo/bar/baz", with bar
+currently displayed, then this will cause the file chooser to
+switch to the "baz" subfolder.
+
+The default binding for this signal is <kbd>Alt</kbd>-<kbd>Down</kbd>.
</description>
<parameters>
@@ -6029,13 +6545,14 @@ The default binding for this signal is `Alt + Down`.
<signal name="GtkFileChooserWidget::home-folder">
<description>
-The ::home-folder signal is a [keybinding signal][GtkSignalAction]
-which gets emitted when the user asks for it.
+Emitted when the user asks for it.
+
+This is a [keybinding signal](class.SignalAction.html).
This is used to make the file chooser show the user's home
folder in the file list.
-The default binding for this signal is `Alt + Home`.
+The default binding for this signal is <kbd>Alt</kbd>-<kbd>Home</kbd>.
</description>
<parameters>
@@ -6049,17 +6566,19 @@ The default binding for this signal is `Alt + Home`.
<signal name="GtkFileChooserWidget::location-popup">
<description>
-The ::location-popup signal is a [keybinding signal][GtkSignalAction]
-which gets emitted when the user asks for it.
+Emitted when the user asks for it.
+
+This is a [keybinding signal](class.SignalAction.html).
This is used to make the file chooser show a "Location" prompt which
the user can use to manually type the name of the file he wishes to select.
-The default bindings for this signal are `Control + L` with a @path string
-of "" (the empty string). It is also bound to `/` with a @path string of
-"`/`" (a slash): this lets you type `/` and immediately type a path name.
-On Unix systems, this is bound to `~` (tilde) with a @path string of "~"
-itself for access to home directories.
+The default bindings for this signal are <kbd>Control</kbd>-<kbd>L</kbd>
+with a @path string of "" (the empty string). It is also bound to
+<kbd>/</kbd> with a @path string of "`/`" (a slash): this lets you
+type `/` and immediately type a path name. On Unix systems, this is
+bound to <kbd>~</kbd> (tilde) with a @path string of "~" itself for
+access to home directories.
</description>
<parameters>
@@ -6077,13 +6596,14 @@ itself for access to home directories.
<signal name="GtkFileChooserWidget::location-popup-on-paste">
<description>
-The ::location-popup-on-paste signal is a [keybinding signal][GtkSignalAction]
-which gets emitted when the user asks for it.
+Emitted when the user asks for it.
+
+This is a [keybinding signal](class.SignalAction.html).
-This is used to make the file chooser show a "Location" prompt when the user
-pastes into a #GtkFileChooserWidget.
+This is used to make the file chooser show a "Location" prompt
+when the user pastes into a `GtkFileChooserWidget`.
-The default binding for this signal is `Control + V`.
+The default binding for this signal is <kbd>Control</kbd>-<kbd>V</kbd>.
</description>
<parameters>
@@ -6097,13 +6617,15 @@ The default binding for this signal is `Control + V`.
<signal name="GtkFileChooserWidget::location-toggle-popup">
<description>
-The ::location-toggle-popup signal is a [keybinding signal][GtkSignalAction]
-which gets emitted when the user asks for it.
+Emitted when the user asks for it.
-This is used to toggle the visibility of a "Location" prompt which the user
-can use to manually type the name of the file he wishes to select.
+This is a [keybinding signal](class.SignalAction.html).
-The default binding for this signal is `Control + L`.
+This is used to toggle the visibility of a "Location" prompt
+which the user can use to manually type the name of the file
+he wishes to select.
+
+The default binding for this signal is <kbd>Control</kbd>-<kbd>L</kbd>.
</description>
<parameters>
@@ -6117,12 +6639,13 @@ The default binding for this signal is `Control + L`.
<signal name="GtkFileChooserWidget::places-shortcut">
<description>
-The ::places-shortcut signal is a [keybinding signal][GtkSignalAction]
-which gets emitted when the user asks for it.
+Emitted when the user asks for it.
+
+This is a [keybinding signal](class.SignalAction.html).
This is used to move the focus to the places sidebar.
-The default binding for this signal is `Alt + P`.
+The default binding for this signal is <kbd>Alt</kbd>-<kbd>P</kbd>.
</description>
<parameters>
@@ -6136,18 +6659,20 @@ The default binding for this signal is `Alt + P`.
<signal name="GtkFileChooserWidget::quick-bookmark">
<description>
-The ::quick-bookmark signal is a [keybinding signal][GtkSignalAction]
-which gets emitted when the user asks for it.
+Emitted when the user asks for it.
-This is used to make the file chooser switch to the bookmark specified
-in the @bookmark_index parameter. For example, if you have three bookmarks,
-you can pass 0, 1, 2 to this signal to switch to each of them, respectively.
+This is a [keybinding signal](class.SignalAction.html).
-The default binding for this signal is `Alt + 1`, `Alt + 2`,
-etc. until `Alt + 0`. Note that in the default binding, that
-`Alt + 1` is actually defined to switch to the bookmark at index
-0, and so on successively; `Alt + 0` is defined to switch to the
-bookmark at index 10.
+This is used to make the file chooser switch to the bookmark
+specified in the @bookmark_index parameter. For example, if
+you have three bookmarks, you can pass 0, 1, 2 to this signal
+to switch to each of them, respectively.
+
+The default binding for this signal is <kbd>Alt</kbd>-<kbd>1</kbd>,
+<kbd>Alt</kbd>-<kbd>2</kbd>, etc. until
<kbd>Alt</kbd>-<kbd>0</kbd>.
+Note that in the default binding, that <kbd>Alt</kbd>-<kbd>1</kbd> is
+actually defined to switch to the bookmark at index 0, and so on
+successively.
</description>
<parameters>
@@ -6165,12 +6690,13 @@ bookmark at index 10.
<signal name="GtkFileChooserWidget::recent-shortcut">
<description>
-The ::recent-shortcut signal is a [keybinding signal][GtkSignalAction]
-which gets emitted when the user asks for it.
+Emitted when the user asks for it.
+
+This is a [keybinding signal](class.SignalAction.html).
This is used to make the file chooser show the Recent location.
-The default binding for this signal is `Alt + R`.
+The default binding for this signal is <kbd>Alt</kbd>-<kbd>R</kbd>.
</description>
<parameters>
@@ -6184,12 +6710,13 @@ The default binding for this signal is `Alt + R`.
<signal name="GtkFileChooserWidget::search-shortcut">
<description>
-The ::search-shortcut signal is a [keybinding signal][GtkSignalAction]
-which gets emitted when the user asks for it.
+Emitted when the user asks for it.
+
+This is a [keybinding signal](class.SignalAction.html).
This is used to make the file chooser show the search entry.
-The default binding for this signal is `Alt + S`.
+The default binding for this signal is <kbd>Alt</kbd>-<kbd>S</kbd>.
</description>
<parameters>
@@ -6203,12 +6730,13 @@ The default binding for this signal is `Alt + S`.
<signal name="GtkFileChooserWidget::show-hidden">
<description>
-The ::show-hidden signal is a [keybinding signal][GtkSignalAction]
-which gets emitted when the user asks for it.
+Emitted when the user asks for it.
+
+This is a [keybinding signal](class.SignalAction.html).
This is used to make the file chooser display hidden files.
-The default binding for this signal is `Control + H`.
+The default binding for this signal is <kbd>Control</kbd>-<kbd>H</kbd>.
</description>
<parameters>
@@ -6222,13 +6750,14 @@ The default binding for this signal is `Control + H`.
<signal name="GtkFileChooserWidget::up-folder">
<description>
-The ::up-folder signal is a [keybinding signal][GtkSignalAction]
-which gets emitted when the user asks for it.
+Emitted when the user asks for it.
-This is used to make the file chooser go to the parent of the current folder
-in the file hierarchy.
+This is a [keybinding signal](class.SignalAction.html).
-The default binding for this signal is `Alt + Up`.
+This is used to make the file chooser go to the parent
+of the current folder in the file hierarchy.
+
+The default binding for this signal is <kbd>Alt</kbd>-<kbd>Up</kbd>.
</description>
<parameters>
@@ -6244,21 +6773,24 @@ The default binding for this signal is `Alt + Up`.
<description>
The human-readable name of the filter.
-This is the string that will be displayed in the file selector user
-interface if there is a selectable list of filters.
+This is the string that will be displayed in the file chooser
+user interface if there is a selectable list of filters.
</description>
</property>
<signal name="GtkFilter::changed">
<description>
-This signal is emitted whenever the filter changed. Users of the filter
-should then check items again via gtk_filter_match().
+Emitted whenever the filter changed.
-#GtkFilterListModel handles this signal automatically.
+Users of the filter should then check items again via
+[method@Gtk.Filter.match].
-Depending on the @change parameter, not all items need to be changed, but
-only some. Refer to the #GtkFilterChange documentation for details.
+`GtkFilterListModel` handles this signal automatically.
+
+Depending on the @change parameter, not all items need
+to be checked, but only some. Refer to the [enum@Gtk.FilterChange]
+documentation for details.
</description>
<parameters>
@@ -6307,28 +6839,28 @@ still return %FALSE, others now may, too.
<property name="GtkFilterListModel:filter">
<description>
-The filter for this model
+The filter for this model.
</description>
</property>
<property name="GtkFilterListModel:incremental">
<description>
-If the model should filter items incrementally
+If the model should filter items incrementally.
</description>
</property>
<property name="GtkFilterListModel:model">
<description>
-The model being filtered
+The model being filtered.
</description>
</property>
<property name="GtkFilterListModel:pending">
<description>
-Number of items not yet filtered
+Number of items not yet filtered.
</description>
</property>
@@ -6361,23 +6893,30 @@ gtk_filter_match() will alays return %TRUE.
</parameters>
</enum>
+<property name="GtkFixedLayoutChild:transform">
+<description>
+The transform of the child.
+
+</description>
+</property>
+
<property name="GtkFlattenListModel:model">
<description>
-The model being flattened
+The model being flattened.
</description>
</property>
<signal name="GtkFlowBox::activate-cursor-child">
<description>
-The ::activate-cursor-child signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user activates the @box.
+Emitted when the user activates the @box.
+
+This is a [keybinding signal](class.SignalAction.html).
</description>
<parameters>
<parameter name="box">
-<parameter_description> the #GtkFlowBox on which the signal is emitted
+<parameter_description> the `GtkFlowBox` on which the signal is emitted
</parameter_description>
</parameter>
</parameters>
@@ -6386,13 +6925,12 @@ which gets emitted when the user activates the @box.
<signal name="GtkFlowBox::child-activated">
<description>
-The ::child-activated signal is emitted when a child has been
-activated by the user.
+Emitted when a child has been activated by the user.
</description>
<parameters>
<parameter name="box">
-<parameter_description> the #GtkFlowBox on which the signal is emitted
+<parameter_description> the `GtkFlowBox` on which the signal is emitted
</parameter_description>
</parameter>
<parameter name="child">
@@ -6405,10 +6943,9 @@ activated by the user.
<signal name="GtkFlowBox::move-cursor">
<description>
-The ::move-cursor signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user initiates a cursor movement.
+Emitted when the user initiates a cursor movement.
+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.
@@ -6417,15 +6954,17 @@ The default bindings for this signal come in two variants,
the variant with the Shift modifier extends the selection,
the variant without the Shift modifier does not.
There are too many key combinations to list them all here.
-- Arrow keys move by individual children
-- Home/End keys move to the ends of the box
-- PageUp/PageDown keys move vertically by pages
+
+- <kbd>←</kbd>, <kbd>→</kbd>, <kbd>↑</kbd>, <kbd>↓</kbd>
+move by individual children
+- <kbd>Home</kbd>, <kbd>End</kbd> move to the ends of the box
+- <kbd>PgUp</kbd>, <kbd>PgDn</kbd> move vertically by pages
</description>
<parameters>
<parameter name="box">
-<parameter_description> the #GtkFlowBox on which the signal is emitted
+<parameter_description> the `GtkFlowBox` on which the signal is emitted
</parameter_description>
</parameter>
<parameter name="step">
@@ -6452,17 +6991,17 @@ There are too many key combinations to list them all here.
<signal name="GtkFlowBox::select-all">
<description>
-The ::select-all signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to select all children of the box, if
-the selection mode permits it.
+Emitted to select all children of the box,
+if the selection mode permits it.
+
+This is a [keybinding signal](class.SignalAction.html).
-The default bindings for this signal is Ctrl-a.
+The default bindings for this signal is <kbd>Ctrl</kbd>-<kbd>a</kbd>.
</description>
<parameters>
<parameter name="box">
-<parameter_description> the #GtkFlowBox on which the signal is emitted
+<parameter_description> the `GtkFlowBox` on which the signal is emitted
</parameter_description>
</parameter>
</parameters>
@@ -6471,17 +7010,16 @@ The default bindings for this signal is Ctrl-a.
<signal name="GtkFlowBox::selected-children-changed">
<description>
-The ::selected-children-changed signal is emitted when the
-set of selected children changes.
+Emitted when the set of selected children changes.
-Use gtk_flow_box_selected_foreach() or
-gtk_flow_box_get_selected_children() to obtain the
+Use [method@Gtk.FlowBox.selected_foreach] or
+[method@Gtk.FlowBox.get_selected_children] to obtain the
selected children.
</description>
<parameters>
<parameter name="box">
-<parameter_description> the #GtkFlowBox on which the signal is emitted
+<parameter_description> the `GtkFlowBox` on which the signal is emitted
</parameter_description>
</parameter>
</parameters>
@@ -6490,16 +7028,16 @@ selected children.
<signal name="GtkFlowBox::toggle-cursor-child">
<description>
-The ::toggle-cursor-child signal is a
-[keybinding signal][GtkSignalAction]
-which toggles the selection of the child that has the focus.
+Emitted to toggle the selection of the child that has the focus.
+
+This is a [keybinding signal](class.SignalAction.html).
-The default binding for this signal is Ctrl-Space.
+The default binding for this signal is <kbd>Ctrl</kbd>-<kbd>Space</kbd>.
</description>
<parameters>
<parameter name="box">
-<parameter_description> the #GtkFlowBox on which the signal is emitted
+<parameter_description> the `GtkFlowBox` on which the signal is emitted
</parameter_description>
</parameter>
</parameters>
@@ -6508,17 +7046,17 @@ The default binding for this signal is Ctrl-Space.
<signal name="GtkFlowBox::unselect-all">
<description>
-The ::unselect-all signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to unselect all children of the box, if
-the selection mode permits it.
+Emitted to unselect all children of the box,
+if the selection mode permits it.
+
+This is a [keybinding signal](class.SignalAction.html).
-The default bindings for this signal is Ctrl-Shift-a.
+The default bindings for this signal is
<kbd>Ctrl</kbd>-<kbd>Shift</kbd>-<kbd>a</kbd>.
</description>
<parameters>
<parameter name="box">
-<parameter_description> the #GtkFlowBox on which the signal is emitted
+<parameter_description> the `GtkFlowBox` on which the signal is emitted
</parameter_description>
</parameter>
</parameters>
@@ -6577,20 +7115,22 @@ The amount of vertical space between two children.
<property name="GtkFlowBox:selection-mode">
<description>
-The selection mode used by the flow box.
+The selection mode used by the flow box.
</description>
</property>
<signal name="GtkFlowBoxChild::activate">
<description>
-The ::activate signal is emitted when the user activates
-a child widget in a #GtkFlowBox, either by clicking or
-double-clicking, or by using the Space or Enter key.
+Emitted when the user activates a child widget in a `GtkFlowBox`.
+
+This can be happen either by clicking or double-clicking,
+or via a keybinding.
-While this signal is used as a
-[keybinding signal][GtkSignalAction],
-it can be used by applications for their own purposes.
+This is a [keybinding signal](class.SignalAction.html),
+but it can be used by applications for their own purposes.
+
+The default bindings are <kbd>Space</kbd> and <kbd>Enter</kbd>.
</description>
<parameters>
@@ -6602,26 +7142,48 @@ it can be used by applications for their own purposes.
<return></return>
</signal>
+<property name="GtkFlowBoxChild:child">
+<description>
+The child widget.
+
+</description>
+</property>
+
+<property name="GtkFlwoBox:accept-unpaired-release">
+<description>
+Whether to accept unpaired release events.
+
+</description>
+</property>
+
<signal name="GtkFontButton::font-set">
<description>
-The ::font-set signal is emitted when the user selects a font.
-When handling this signal, use gtk_font_chooser_get_font()
+Emitted when the user selects a font.
+
+When handling this signal, use [method@Gtk.FontChooser.get_font]
to find out which font was just selected.
-Note that this signal is only emitted when the user
-changes the font. If you need to react to programmatic font changes
-as well, use the notify::font signal.
+Note that this signal is only emitted when the user changes the font.
+If you need to react to programmatic font changes as well, use
+the notify::font signal.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> the object which received the signal.
+<parameter_description> the object which received the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>
+<property name="GtkFontButton:modal">
+<description>
+Whether the font chooser dialog should be modal.
+
+</description>
+</property>
+
<property name="GtkFontButton:title">
<description>
The title of the font chooser dialog.
@@ -6631,16 +7193,14 @@ The title of the font chooser dialog.
<property name="GtkFontButton:use-font">
<description>
-If this property is set to %TRUE, the label will be drawn
-in the selected font.
+Whether the buttons label will be drawn in the selected font.
</description>
</property>
<property name="GtkFontButton:use-size">
<description>
-If this property is set to %TRUE, the label will be drawn
-with the selected font size.
+Whether the buttons label will use the selected font size.
</description>
</property>
@@ -6648,6 +7208,7 @@ with the selected font size.
<signal name="GtkFontChooser::font-activated">
<description>
Emitted when a font is activated.
+
This usually happens when the user double clicks an item,
or an item is selected and the user presses one of the keys
Space, Shift+Space, Return or Enter.
@@ -6675,14 +7236,16 @@ The font description as a string, e.g. "Sans Italic 12".
<property name="GtkFontChooser:font-desc">
<description>
-The font description as a #PangoFontDescription.
+The font description as a `PangoFontDescription`.
</description>
</property>
<property name="GtkFontChooser:font-features">
<description>
-The selected font features, in a format that is compatible with
+The selected font features.
+
+The format of the string is compatible with
CSS and with Pango attributes.
</description>
@@ -6690,9 +7253,7 @@ CSS and with Pango attributes.
<property name="GtkFontChooser:language">
<description>
-The language for which the #GtkFontChooser:font-features were
-selected, in a format that is compatible with CSS and with Pango
-attributes.
+The language for which the font features were selected.
</description>
</property>
@@ -6720,8 +7281,8 @@ Whether to show an entry to change the preview text.
<enum name="GtkFontChooserLevel">
<description>
-This enumeration specifies the granularity of font selection
-that is desired in a font chooser.
+Specifies the granularity of font selection
+that is desired in a `GtkFontChooser`.
This enumeration may be extended in the future; applications should
ignore unknown values.
@@ -6763,23 +7324,51 @@ the selected font has any features or axes.
</description>
</property>
+<property name="GtkFrame:child">
+<description>
+The child widget.
+
+</description>
+</property>
+
+<property name="GtkFrame:label">
+<description>
+Text of the frame's label.
+
+</description>
+</property>
+
+<property name="GtkFrame:label-widget">
+<description>
+Widget to display in place of the usual frame label.
+
+</description>
+</property>
+
+<property name="GtkFrame:label-xalign">
+<description>
+The horizontal alignment of the label.
+
+</description>
+</property>
+
<signal name="GtkGLArea::create-context">
<description>
-The ::create-context signal is emitted when the widget is being
-realized, and allows you to override how the GL context is
-created. This is useful when you want to reuse an existing GL
-context, or if you want to try creating different kinds of GL
-options.
+Emitted when the widget is being realized.
+
+This allows you to override how the GL context is created.
+This is useful when you want to reuse an existing GL context,
+or if you want to try creating different kinds of GL options.
If context creation fails then the signal handler can use
-gtk_gl_area_set_error() to register a more detailed error
+[method@Gtk.GLArea.set_error] to register a more detailed error
of how the construction failed.
</description>
<parameters>
<parameter name="area">
-<parameter_description> the #GtkGLArea that emitted the signal
+<parameter_description> the `GtkGLArea` that emitted the signal
</parameter_description>
</parameter>
<parameter name="error">
@@ -6787,15 +7376,14 @@ of how the construction failed.
</parameter_description>
</parameter>
</parameters>
-<return> a newly created #GdkGLContext;
-the #GtkGLArea widget will take ownership of the returned value.
+<return> a newly created `GdkGLContext`;
+the `GtkGLArea` widget will take ownership of the returned value.
</return>
</signal>
<signal name="GtkGLArea::render">
<description>
-The ::render signal is emitted every time the contents
-of the #GtkGLArea should be redrawn.
+Emitted every time the contents of the `GtkGLArea` should be redrawn.
The @context is bound to the @area prior to emitting this function,
and the buffers are painted to the window once the emission terminates.
@@ -6804,11 +7392,11 @@ and the buffers are painted to the window once the emission terminates.
</description>
<parameters>
<parameter name="area">
-<parameter_description> the #GtkGLArea that emitted the signal
+<parameter_description> the `GtkGLArea` that emitted the signal
</parameter_description>
</parameter>
<parameter name="context">
-<parameter_description> the #GdkGLContext used by @area
+<parameter_description> the `GdkGLContext` used by @area
</parameter_description>
</parameter>
</parameters>
@@ -6819,10 +7407,12 @@ and the buffers are painted to the window once the emission terminates.
<signal name="GtkGLArea::resize">
<description>
-The ::resize signal is emitted once when the widget is realized, and
-then each time the widget is changed while realized. This is useful
-in order to keep GL state up to date with the widget size, like for
-instance camera properties which may depend on the width/height ratio.
+Emitted once when the widget is realized, and then each time the widget
+is changed while realized.
+
+This is useful in order to keep GL state up to date with the widget size,
+like for instance camera properties which may depend on the width/height
+ratio.
The GL context for the area is guaranteed to be current when this signal
is emitted.
@@ -6832,7 +7422,7 @@ The default handler sets up the GL viewport.
</description>
<parameters>
<parameter name="area">
-<parameter_description> the #GtkGLArea that emitted the signal
+<parameter_description> the `GtkGLArea` that emitted the signal
</parameter_description>
</parameter>
<parameter name="width">
@@ -6849,13 +7439,14 @@ The default handler sets up the GL viewport.
<property name="GtkGLArea:auto-render">
<description>
-If set to %TRUE the #GtkGLArea::render signal will be emitted every time
-the widget draws. This is the default and is useful if drawing the widget
-is faster.
+If set to %TRUE the ::render signal will be emitted every time
+the widget draws.
+
+This is the default and is useful if drawing the widget is faster.
If set to %FALSE the data from previous rendering is kept around and will
be used for drawing the widget the next time, unless the window is resized.
-In order to force a rendering gtk_gl_area_queue_render() must be called.
+In order to force a rendering [method@Gtk.GLArea.queue_render] must be called.
This mode is useful when the scene changes seldom, but takes a long time
to redraw.
@@ -6864,9 +7455,9 @@ to redraw.
<property name="GtkGLArea:context">
<description>
-The #GdkGLContext used by the #GtkGLArea widget.
+The `GdkGLContext` used by the `GtkGLArea` widget.
-The #GtkGLArea widget is responsible for creating the #GdkGLContext
+The `GtkGLArea` widget is responsible for creating the `GdkGLContext`
instance. If you need to render with other kinds of buffers (stencil,
depth, etc), use render buffers.
@@ -6891,22 +7482,23 @@ target framebuffer.
<property name="GtkGLArea:use-es">
<description>
-If set to %TRUE the widget will try to create a #GdkGLContext using
+If set to %TRUE the widget will try to create a `GdkGLContext` using
OpenGL ES instead of OpenGL.
-See also: gdk_gl_context_set_use_es()
-
</description>
</property>
<signal name="GtkGesture::begin">
<description>
-This signal is emitted when the gesture is recognized. This means the
-number of touch sequences matches #GtkGesture:n-points.
+Emitted when the gesture is recognized.
-Note: These conditions may also happen when an extra touch (eg. a third touch
-on a 2-touches gesture) is lifted, in that situation @sequence won't pertain
-to the current set of active touches, so don't rely on this being true.
+This means the number of touch sequences matches
+[property@Gtk.Gesture:n-points].
+
+Note: These conditions may also happen when an extra touch
+(eg. a third touch on a 2-touches gesture) is lifted, in that
+situation @sequence won't pertain to the current set of active
+touches, so don't rely on this being true.
</description>
<parameters>
@@ -6915,7 +7507,8 @@ to the current set of active touches, so don't rely on this being true.
</parameter_description>
</parameter>
<parameter name="sequence">
-<parameter_description> the #GdkEventSequence that made the gesture to be recognized
+<parameter_description> the `GdkEventSequence` that made the gesture
+to be recognized
</parameter_description>
</parameter>
</parameters>
@@ -6924,12 +7517,16 @@ to the current set of active touches, so don't rely on this being true.
<signal name="GtkGesture::cancel">
<description>
-This signal is emitted whenever a sequence is cancelled. This usually
-happens on active touches when gtk_event_controller_reset() is called
-on @gesture (manually, due to grabs...), or the individual @sequence
-was claimed by parent widgets' controllers (see gtk_gesture_set_sequence_state()).
+Emitted whenever a sequence is cancelled.
+
+This usually happens on active touches when
+[method@Gtk.EventController.reset] is called on @gesture
+(manually, due to grabs...), or the individual @sequence
+was claimed by parent widgets' controllers (see
+[method@Gtk.Gesture.set_sequence_state]).
-@gesture must forget everything about @sequence as a reaction to this signal.
+@gesture must forget everything about @sequence as in
+response to this signal.
</description>
<parameters>
@@ -6938,7 +7535,7 @@ was claimed by parent widgets' controllers (see gtk_gesture_set_sequence_state()
</parameter_description>
</parameter>
<parameter name="sequence">
-<parameter_description> the #GdkEventSequence that was cancelled
+<parameter_description> the `GdkEventSequence` that was cancelled
</parameter_description>
</parameter>
</parameters>
@@ -6947,14 +7544,15 @@ was claimed by parent widgets' controllers (see gtk_gesture_set_sequence_state()
<signal name="GtkGesture::end">
<description>
-This signal is emitted when @gesture either stopped recognizing the event
-sequences as something to be handled, or the number of touch sequences became
-higher or lower than #GtkGesture:n-points.
+Emitted when @gesture either stopped recognizing the event
+sequences as something to be handled, or the number of touch
+sequences became higher or lower than [property@Gtk.Gesture:n-points].
-Note: @sequence might not pertain to the group of sequences that were
-previously triggering recognition on @gesture (ie. a just pressed touch
-sequence that exceeds #GtkGesture:n-points). This situation may be detected
-by checking through gtk_gesture_handles_sequence().
+Note: @sequence might not pertain to the group of sequences that
+were previously triggering recognition on @gesture (ie. a just
+pressed touch sequence that exceeds [property@Gtk.Gesture:n-points]).
+This situation may be detected by checking through
+[method@Gtk.Gesture.handles_sequence].
</description>
<parameters>
@@ -6963,7 +7561,8 @@ by checking through gtk_gesture_handles_sequence().
</parameter_description>
</parameter>
<parameter name="sequence">
-<parameter_description> the #GdkEventSequence that made gesture recognition to finish
+<parameter_description> the `GdkEventSequence` that made gesture
+recognition to finish
</parameter_description>
</parameter>
</parameters>
@@ -6972,9 +7571,10 @@ by checking through gtk_gesture_handles_sequence().
<signal name="GtkGesture::sequence-state-changed">
<description>
-This signal is emitted whenever a sequence state changes. See
-gtk_gesture_set_sequence_state() to know more about the expectable
-sequence lifetimes.
+Emitted whenever a sequence state changes.
+
+See [method@Gtk.Gesture.set_sequence_state] to know
+more about the expectable sequence lifetimes.
</description>
<parameters>
@@ -6983,7 +7583,7 @@ sequence lifetimes.
</parameter_description>
</parameter>
<parameter name="sequence">
-<parameter_description> the #GdkEventSequence that was cancelled
+<parameter_description> the `GdkEventSequence` that was cancelled
</parameter_description>
</parameter>
<parameter name="state">
@@ -6996,8 +7596,9 @@ sequence lifetimes.
<signal name="GtkGesture::update">
<description>
-This signal is emitted whenever an event is handled while the gesture is
-recognized. @sequence is guaranteed to pertain to the set of active touches.
+Emitted whenever an event is handled while the gesture is recognized.
+
+@sequence is guaranteed to pertain to the set of active touches.
</description>
<parameters>
@@ -7006,7 +7607,7 @@ recognized. @sequence is guaranteed to pertain to the set of active touches.
</parameter_description>
</parameter>
<parameter name="sequence">
-<parameter_description> the #GdkEventSequence that was updated
+<parameter_description> the `GdkEventSequence` that was updated
</parameter_description>
</parameter>
</parameters>
@@ -7015,14 +7616,15 @@ recognized. @sequence is guaranteed to pertain to the set of active touches.
<property name="GtkGesture:n-points">
<description>
-The number of touch points that trigger recognition on this gesture,
+The number of touch points that trigger
+recognition on this gesture.
</description>
</property>
<signal name="GtkGestureClick::pressed">
<description>
-This signal is emitted whenever a button or touch press happens.
+Emitted whenever a button or touch press happens.
</description>
<parameters>
@@ -7048,10 +7650,12 @@ This signal is emitted whenever a button or touch press happens.
<signal name="GtkGestureClick::released">
<description>
-This signal is emitted when a button or touch is released. @n_press
-will report the number of press that is paired to this event, note
-that #GtkGestureClick::stopped may have been emitted between the
-press and its release, @n_press will only start over at the next press.
+Emitted when a button or touch is released.
+
+@n_press will report the number of press that is paired to
+this event, note that [signal@Gtk.GestureClick::stopped] may
+have been emitted between the press and its release, @n_press
+will only start over at the next press.
</description>
<parameters>
@@ -7077,8 +7681,7 @@ press and its release, @n_press will only start over at the next press.
<signal name="GtkGestureClick::stopped">
<description>
-This signal is emitted whenever any time/distance threshold has
-been exceeded.
+Emitted whenever any time/distance threshold has been exceeded.
</description>
<parameters>
@@ -7092,11 +7695,12 @@ been exceeded.
<signal name="GtkGestureClick::unpaired-release">
<description>
-This signal is emitted whenever the gesture receives a release
-event that had no previous corresponding press. Due to implicit
-grabs, this can only happen on situations where input is grabbed
-elsewhere mid-press or the pressed widget voluntarily relinquishes
-its implicit grab.
+Emitted whenever the gesture receives a release
+event that had no previous corresponding press.
+
+Due to implicit grabs, this can only happen on situations
+where input is grabbed elsewhere mid-press or the pressed
+widget voluntarily relinquishes its implicit grab.
</description>
<parameters>
@@ -7126,7 +7730,7 @@ its implicit grab.
<signal name="GtkGestureDrag::drag-begin">
<description>
-This signal is emitted whenever dragging starts.
+Emitted whenever dragging starts.
</description>
<parameters>
@@ -7148,7 +7752,7 @@ This signal is emitted whenever dragging starts.
<signal name="GtkGestureDrag::drag-end">
<description>
-This signal is emitted whenever the dragging is finished.
+Emitted whenever the dragging is finished.
</description>
<parameters>
@@ -7170,7 +7774,7 @@ This signal is emitted whenever the dragging is finished.
<signal name="GtkGestureDrag::drag-update">
<description>
-This signal is emitted whenever the dragging point moves.
+Emitted whenever the dragging point moves.
</description>
<parameters>
@@ -7192,8 +7796,8 @@ This signal is emitted whenever the dragging point moves.
<signal name="GtkGestureLongPress::cancelled">
<description>
-This signal is emitted whenever a press moved too far, or was released
-before #GtkGestureLongPress::pressed happened.
+Emitted whenever a press moved too far, or was released
+before [signal@Gtk.GestureLongPress::pressed] happened.
</description>
<parameters>
@@ -7207,7 +7811,7 @@ before #GtkGestureLongPress::pressed happened.
<signal name="GtkGestureLongPress::pressed">
<description>
-This signal is emitted whenever a press goes unmoved/unreleased longer than
+Emitted whenever a press goes unmoved/unreleased longer than
what the GTK defaults tell.
</description>
@@ -7228,10 +7832,16 @@ what the GTK defaults tell.
<return></return>
</signal>
+<property name="GtkGestureLongPress:delay-factor">
+<description>
+Factor by which to modify the default timeout.
+
+</description>
+</property>
+
<signal name="GtkGesturePan::pan">
<description>
-This signal is emitted once a panning gesture along the
-expected axis is detected.
+Emitted once a panning gesture along the expected axis is detected.
</description>
<parameters>
@@ -7260,8 +7870,7 @@ The expected orientation of pan gestures.
<signal name="GtkGestureRotate::angle-changed">
<description>
-This signal is emitted when the angle between both tracked points
-changes.
+Emitted when the angle between both tracked points changes.
</description>
<parameters>
@@ -7290,8 +7899,9 @@ Mouse button number to listen to, or 0 to listen for any button.
<property name="GtkGestureSingle:exclusive">
<description>
-Whether the gesture is exclusive. Exclusive gestures only listen to pointer
-and pointer emulated events.
+Whether the gesture is exclusive.
+
+Exclusive gestures only listen to pointer and pointer emulated events.
</description>
</property>
@@ -7305,12 +7915,12 @@ Whether the gesture handles only touch events.
<signal name="GtkGestureStylus::down">
<description>
-A signal emitted when the stylus touches the device.
+Emitted when the stylus touches the device.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> the #GtkGestureStylus that emitted the signal
+<parameter_description> the `GtkGestureStylus` that emitted the signal
</parameter_description>
</parameter>
<parameter name="x">
@@ -7327,12 +7937,12 @@ A signal emitted when the stylus touches the device.
<signal name="GtkGestureStylus::motion">
<description>
-A signal emitted when the stylus moves while touching the device.
+Emitted when the stylus moves while touching the device.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> the #GtkGestureStylus that emitted the signal
+<parameter_description> the `GtkGestureStylus` that emitted the signal
</parameter_description>
</parameter>
<parameter name="x">
@@ -7349,12 +7959,12 @@ A signal emitted when the stylus moves while touching the device.
<signal name="GtkGestureStylus::proximity">
<description>
-A signal emitted when the stylus is in proximity of the device.
+Emitted when the stylus is in proximity of the device.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> the #GtkGestureStylus that emitted the signal
+<parameter_description> the `GtkGestureStylus` that emitted the signal
</parameter_description>
</parameter>
<parameter name="x">
@@ -7371,12 +7981,12 @@ A signal emitted when the stylus is in proximity of the device.
<signal name="GtkGestureStylus::up">
<description>
-A signal emitted when the stylus no longer touches the device.
+Emitted when the stylus no longer touches the device.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> the #GtkGestureStylus that emitted the signal
+<parameter_description> the `GtkGestureStylus` that emitted the signal
</parameter_description>
</parameter>
<parameter name="x">
@@ -7393,8 +8003,9 @@ A signal emitted when the stylus no longer touches the device.
<signal name="GtkGestureSwipe::swipe">
<description>
-This signal is emitted when the recognized gesture is finished, velocity
-and direction are a product of previously recorded events.
+Emitted when the recognized gesture is finished.
+
+Velocity and direction are a product of previously recorded events.
</description>
<parameters>
@@ -7416,8 +8027,7 @@ and direction are a product of previously recorded events.
<signal name="GtkGestureZoom::scale-changed">
<description>
-This signal is emitted whenever the distance between both tracked
-sequences changes.
+Emitted whenever the distance between both tracked sequences changes.
</description>
<parameters>
@@ -7433,6 +8043,41 @@ sequences changes.
<return></return>
</signal>
+<property name="GtkGrid:baseline-row">
+<description>
+The row to align to the baseline when valign is %GTK_ALIGN_BASELINE.
+
+</description>
+</property>
+
+<property name="GtkGrid:column-homogeneous">
+<description>
+If %TRUE, the columns are all the same width.
+
+</description>
+</property>
+
+<property name="GtkGrid:column-spacing">
+<description>
+The amount of space between two consecutive columns.
+
+</description>
+</property>
+
+<property name="GtkGrid:row-homogeneous">
+<description>
+If %TRUE, the rows are all the same height.
+
+</description>
+</property>
+
+<property name="GtkGrid:row-spacing">
+<description>
+The amount of space between two consecutive rows.
+
+</description>
+</property>
+
<property name="GtkGridLayout:baseline-row">
<description>
The row to align to the baseline, when #GtkWidget:valign is set
@@ -7499,16 +8144,17 @@ The number of rows the child spans to.
<signal name="GtkGridView::activate">
<description>
-The ::activate signal is emitted when a cell has been activated by the user,
+Emitted when a cell has been activated by the user,
usually via activating the GtkGridView|list.activate-item action.
This allows for a convenient way to handle activation in a gridview.
-See GtkListItem:activatable for details on how to use this signal.
+See [property@Gtk.ListItem:activatable] for details on how to use
+this signal.
</description>
<parameters>
<parameter name="self">
-<parameter_description> The #GtkGridView
+<parameter_description> The `GtkGridView`
</parameter_description>
</parameter>
<parameter name="position">
@@ -7521,57 +8167,55 @@ See GtkListItem:activatable for details on how to use this signal.
<property name="GtkGridView:enable-rubberband">
<description>
-Allow rubberband selection
+Allow rubberband selection.
</description>
</property>
<property name="GtkGridView:factory">
<description>
-Factory for populating list items
+Factory for populating list items.
</description>
</property>
<property name="GtkGridView:max-columns">
<description>
-Maximum number of columns per row
+Maximum number of columns per row.
-If this number is smaller than GtkGridView:min-columns, that value
-is used instead.
+If this number is smaller than [property@Gtk.GridView:min-columns],
+that value is used instead.
</description>
</property>
<property name="GtkGridView:min-columns">
<description>
-Minimum number of columns per row
+Minimum number of columns per row.
</description>
</property>
<property name="GtkGridView:model">
<description>
-Model for the items displayed
+Model for the items displayed.
</description>
</property>
<property name="GtkGridView:single-click-activate">
<description>
-Activate rows on single click and select them on hover
+Activate rows on single click and select them on hover.
</description>
</property>
<property name="GtkHeaderBar:decoration-layout">
<description>
-The decoration layout for buttons. If this property is
-not set, the #GtkSettings:gtk-decoration-layout setting
-is used.
+The decoration layout for buttons.
-See gtk_header_bar_set_decoration_layout() for information
-about the format of this string.
+If this property is not set, the
+[property@Gtk.Settings:gtk-decoration-layout] setting is used.
</description>
</property>
@@ -7581,9 +8225,9 @@ about the format of this string.
Whether to show title buttons like close, minimize, maximize.
Which buttons are actually shown and where is determined
-by the #GtkHeaderBar:decoration-layout property, and by
-the state of the window (e.g. a close button will not be
-shown if the window can't be closed).
+by the [property@Gtk.HeaderBar:decoration-layout] property,
+and by the state of the window (e.g. a close button will not
+be shown if the window can't be closed).
</description>
</property>
@@ -7703,7 +8347,7 @@ gtk_im_context_set_surrounding() method.
<enum name="GtkIconLookupFlags">
<description>
-Used to specify options for gtk_icon_theme_lookup_icon()
+Used to specify options for gtk_icon_theme_lookup_icon().
</description>
<parameters>
@@ -7753,9 +8397,10 @@ Built-in icon sizes.
Icon sizes default to being inherited. Where they cannot be
inherited, text size is the default.
-All widgets which use GtkIconSize set the normal-icons or large-icons
-style classes correspondingly, and let themes determine the actual size
-to be used with the -gtk-icon-size CSS property.
+All widgets which use `GtkIconSize` set the normal-icons or
+large-icons style classes correspondingly, and let themes
+determine the actual size to be used with the
+`-gtk-icon-size` CSS property.
</description>
<parameters>
@@ -7776,9 +8421,11 @@ to be used with the -gtk-icon-size CSS property.
<signal name="GtkIconTheme::changed">
<description>
-Emitted when the current icon theme is switched or GTK detects
-that a change has occurred in the contents of the current
-icon theme.
+Emitted when the icon theme changes.
+
+This can happen becuase current icon theme is switched or
+because GTK detects that a change has occurred in the
+contents of the current icon theme.
</description>
<parameters>
@@ -7844,7 +8491,7 @@ object associated to the display of the icontheme object.
<enum name="GtkIconThemeError">
<description>
-Error codes for GtkIconTheme operations.
+Error codes for `GtkIconTheme` operations.
</description>
<parameters>
@@ -8215,10 +8862,18 @@ An enum for determining where a dropped item goes.
</parameters>
</enum>
+<property name="GtkImage:file">
+<description>
+The `GFile to display.
+
+</description>
+</property>
+
<property name="GtkImage:gicon">
<description>
-The GIcon displayed in the GtkImage. For themed icons,
-If the icon theme is changed, the image will be updated
+The `GIcon` displayed in the GtkImage.
+
+For themed icons, If the icon theme is changed, the image will be updated
automatically.
</description>
@@ -8226,17 +8881,34 @@ automatically.
<property name="GtkImage:icon-name">
<description>
-The name of the icon in the icon theme. If the icon theme is
-changed, the image will be updated automatically.
+The name of the icon in the icon theme.
+
+If the icon theme is changed, the image will be updated automatically.
+
+</description>
+</property>
+
+<property name="GtkImage:icon-size">
+<description>
+The symbolic size to display icons at.
+
+</description>
+</property>
+
+<property name="GtkImage:paintable">
+<description>
+The `GdkPaintable` to display.
</description>
</property>
<property name="GtkImage:pixel-size">
<description>
-The "pixel-size" property can be used to specify a fixed size
-overriding the #GtkImage:icon-size property for images of type
-%GTK_IMAGE_ICON_NAME.
+The size in pixels to display icons at.
+
+If set to a value != -1, this property overrides the
+[property@Gtk.Image:icon-size] property for images of type
+`GTK_IMAGE_ICON_NAME`.
</description>
</property>
@@ -8248,25 +8920,34 @@ A path to a resource file to display.
</description>
</property>
+<property name="GtkImage:storage-type">
+<description>
+The representation being used for image data.
+
+</description>
+</property>
+
<property name="GtkImage:use-fallback">
<description>
-Whether the icon displayed in the GtkImage will use
-standard icon names fallback. The value of this property
-is only relevant for images of type %GTK_IMAGE_ICON_NAME
-and %GTK_IMAGE_GICON.
+Whether the icon displayed in the `GtkImage` will use
+standard icon names fallback.
+
+The value of this property is only relevant for images of type
+%GTK_IMAGE_ICON_NAME and %GTK_IMAGE_GICON.
</description>
</property>
<enum name="GtkImageType">
<description>
-Describes the image data representation used by a #GtkImage. If you
-want to get the image from the widget, you can only get the
-currently-stored representation. e.g. if the
-gtk_image_get_storage_type() returns #GTK_IMAGE_PAINTABLE, then you can
-call gtk_image_get_paintable(). For empty images, you can request any
-storage type (call any of the "get" functions), but they will all
-return %NULL values.
+Describes the image data representation used by a [class@Gtk.Image].
+
+If you want to get the image from the widget, you can only get the
+currently-stored representation; for instance, if the gtk_image_get_storage_type()
+returns %GTK_IMAGE_PAINTABLE, then you can call gtk_image_get_paintable().
+
+For empty images, you can request any storage type (call any of the "get"
+functions), but they will all return %NULL values.
</description>
<parameters>
@@ -8291,10 +8972,9 @@ return %NULL values.
<signal name="GtkInfoBar::close">
<description>
-The ::close signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user uses a keybinding to dismiss
-the info bar.
+Gets emitted when the user uses a keybinding to dismiss the info bar.
+
+The ::close signal is a [keybinding signal](class.SignalAction.html).
The default binding for this signal is the Escape key.
@@ -8306,9 +8986,11 @@ The default binding for this signal is the Escape key.
<signal name="GtkInfoBar::response">
<description>
-Emitted when an action widget is clicked or the application programmer
-calls gtk_info_bar_response(). The @response_id depends on which action
-widget was clicked.
+Emitted when an action widget is clicked.
+
+The signal is also emitted when the application programmer
+calls [method@Gtk.InfoBar.response]. The @response_id depends
+on which action widget was clicked.
</description>
<parameters>
@@ -8333,6 +9015,13 @@ The type may be used to determine the appearance of the info bar.
</description>
</property>
+<property name="GtkInfoBar:revealed">
+<description>
+Whether the info bar shows its contents.
+
+</description>
+</property>
+
<property name="GtkInfoBar:show-close-button">
<description>
Whether to include a standard close button.
@@ -8343,8 +9032,10 @@ Whether to include a standard close button.
<enum name="GtkInputHints">
<description>
Describes hints that might be taken into account by input methods
-or applications. Note that input methods may already tailor their
-behaviour according to the #GtkInputPurpose of the entry.
+or applications.
+
+Note that input methods may already tailor their behaviour according
+to the `GtkInputPurpose` of the entry.
Some common sense is expected when using these flags - mixing
%GTK_INPUT_HINT_LOWERCASE with any of the uppercase hints makes no sense.
@@ -8415,9 +9106,10 @@ update personalized data (like typing history)
<enum name="GtkInputPurpose">
<description>
-Describes primary purpose of the input widget. This information is
-useful for on-screen keyboards and similar input methods to decide
-which keys should be presented to the user.
+Describes primary purpose of the input widget.
+
+This information is useful for on-screen keyboards and similar input
+methods to decide which keys should be presented to the user.
Note that the purpose is not meant to impose a totally strict rule
about allowed characters, and does not replace input validation.
@@ -8485,7 +9177,7 @@ interpret unknown values as “free form”.
<enum name="GtkJustification">
<description>
-Used for justifying the text inside a #GtkLabel widget.
+Used for justifying the text inside a `GtkLabel` widget.
</description>
<parameters>
@@ -8524,8 +9216,9 @@ The key modifiers for the trigger.
<signal name="GtkLabel::activate-current-link">
<description>
-A [keybinding signal][GtkSignalAction]
-which gets emitted when the user activates a link in the label.
+Gets emitted when the user activates a link in the label.
+
+The ::activate-current-link is a [keybinding signal](class.SignalAction.html).
Applications may also emit the signal with g_signal_emit_by_name()
if they need to control activation of URIs programmatically.
@@ -8544,7 +9237,8 @@ The default bindings for this signal are all forms of the Enter key.
<signal name="GtkLabel::activate-link">
<description>
-The signal which gets emitted to activate a URI.
+Gets emitted to activate a URI.
+
Applications may connect to it to override the default behaviour,
which is to call gtk_show_uri().
@@ -8566,9 +9260,9 @@ which is to call gtk_show_uri().
<signal name="GtkLabel::copy-clipboard">
<description>
-The ::copy-clipboard signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to copy the selection to the clipboard.
+Gets emitted to copy the slection to the clipboard.
+
+The ::copy-clipboard signal is a [keybinding signal](class.SignalAction.html).
The default binding for this signal is Ctrl-c.
@@ -8584,11 +9278,11 @@ The default binding for this signal is Ctrl-c.
<signal name="GtkLabel::move-cursor">
<description>
-The ::move-cursor signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user initiates a cursor movement.
-If the cursor is not visible in @entry, this signal causes
-the viewport to be moved instead.
+Gets emitted when the user initiates a cursor movement.
+
+The ::move-cursor signal is a [keybinding signal](class.SignalAction.html).
+If the cursor is not visible in @entry, this signal causes the viewport to
+be moved instead.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name() if they need to control the cursor
@@ -8624,27 +9318,42 @@ There are too many key combinations to list them all here.
<return></return>
</signal>
+<property name="GtkLabel:attributes">
+<description>
+A list of style attributes to apply to the text of the label.
+
+</description>
+</property>
+
<property name="GtkLabel:ellipsize">
<description>
The preferred place to ellipsize the string, if the label does
-not have enough room to display the entire string, specified as a
-#PangoEllipsizeMode.
+not have enough room to display the entire string.
Note that setting this property to a value other than
%PANGO_ELLIPSIZE_NONE has the side-effect that the label requests
only enough space to display the ellipsis "...". In particular, this
means that ellipsizing labels do not work well in notebook tabs, unless
-the #GtkNotebook tab-expand child property is set to %TRUE. Other ways
-to set a label's width are gtk_widget_set_size_request() and
-gtk_label_set_width_chars().
+the [property@Gtk.NotebookPage:tab-expand] child property is set to %TRUE.
+Other ways to set a label's width are [method@Gtk.Widget.set_size_request]
+and [method@Gtk.Label.set_width_chars].
</description>
</property>
<property name="GtkLabel:extra-menu">
<description>
-A menu model whose contents will be appended to
-the context menu.
+A menu model whose contents will be appended to the context menu.
+
+</description>
+</property>
+
+<property name="GtkLabel:justify">
+<description>
+The alignment of the lines in the text of the label, relative to each other.
+
+This does *not* affect the alignment of the label within its allocation.
+See [property@Gtk.Label:xalign] for that.
</description>
</property>
@@ -8653,15 +9362,16 @@ the context menu.
<description>
The contents of the label.
-If the string contains [Pango XML markup][PangoMarkupFormat], you will
-have to set the #GtkLabel:use-markup property to %TRUE in order for the
-label to display the markup attributes. See also gtk_label_set_markup()
-for a convenience function that sets both this property and the
-#GtkLabel:use-markup property at the same time.
+If the string contains Pango markup (see [func@Pango.parse_markup]),
+you will have to set the [property@Gtk.Label:use-markup] property to
+%TRUE in order for the label to display the markup attributes. See also
+[method@Gtk.Label.set_markup] for a convenience function that sets both
+this property and the [property@Gtk.Label:use-markup] property at the
+same time.
If the string contains underlines acting as mnemonics, you will have to
-set the #GtkLabel:use-underline property to %TRUE in order for the label
-to display them.
+set the [property@Gtk.Label:use-underline] property to %TRUE in order
+for the label to display them.
</description>
</property>
@@ -8669,95 +9379,147 @@ to display them.
<property name="GtkLabel:lines">
<description>
The number of lines to which an ellipsized, wrapping label
-should be limited. This property has no effect if the
-label is not wrapping or ellipsized. Set this property to
--1 if you don't want to limit the number of lines.
+should be limited.
+
+This property has no effect if the label is not wrapping or ellipsized.
+Set this property to -1 if you don't want to limit the number of lines.
</description>
</property>
<property name="GtkLabel:max-width-chars">
<description>
-The desired maximum width of the label, in characters. If this property
-is set to -1, the width will be calculated automatically.
+The desired maximum width of the label, in characters.
-See the section on [text layout][label-text-layout]
-for details of how #GtkLabel:width-chars and #GtkLabel:max-width-chars
+If this property is set to -1, the width will be calculated automatically.
+
+See the section on [text layout][label-text-layout] for details of how
+[property@Gtk.Label:width-chars] and [property@Gtk.Label:max-width-chars]
determine the width of ellipsized and wrapped labels.
</description>
</property>
+<property name="GtkLabel:mnemonic-keyval">
+<description>
+The mnemonic accelerator key for the label.
+
+</description>
+</property>
+
+<property name="GtkLabel:mnemonic-widget">
+<description>
+The widget to be activated when the labels mnemonic key is pressed.
+
+</description>
+</property>
+
+<property name="GtkLabel:selectable">
+<description>
+Whether the label text can be selected with the mouse.
+
+</description>
+</property>
+
<property name="GtkLabel:single-line-mode">
<description>
-Whether the label is in single line mode. In single line mode,
-the height of the label does not depend on the actual text, it
-is always set to ascent + descent of the font. This can be an
-advantage in situations where resizing the label because of text
-changes would be distracting, e.g. in a statusbar.
+Whether the label is in single line mode.
+
+In single line mode, the height of the label does not depend on the
+actual text, it is always set to ascent + descent of the font. This
+can be an advantage in situations where resizing the label because
+of text changes would be distracting, e.g. in a statusbar.
+
+</description>
+</property>
+
+<property name="GtkLabel:use-markup">
+<description>
+%TRUE if the text of the label includes Pango markup.
+
+See [func@Pango.parse_markup].
+
+</description>
+</property>
+
+<property name="GtkLabel:use-underline">
+<description>
+%TRUE if the text of the label indicates a mnemonic with _.
</description>
</property>
<property name="GtkLabel:width-chars">
<description>
-The desired width of the label, in characters. If this property is set to
--1, the width will be calculated automatically.
+The desired width of the label, in characters.
-See the section on [text layout][label-text-layout]
-for details of how #GtkLabel:width-chars and #GtkLabel:max-width-chars
+If this property is set to -1, the width will be calculated automatically.
+
+See the section on [text layout][label-text-layout] for details of how
+[property@Gtk.Label:width-chars] and [property@Gtk.Label:max-width-chars]
determine the width of ellipsized and wrapped labels.
</description>
</property>
+<property name="GtkLabel:wrap">
+<description>
+%TRUE if the label text will wrap if it gets too wide.
+
+</description>
+</property>
+
<property name="GtkLabel:wrap-mode">
<description>
-If line wrapping is on (see the #GtkLabel:wrap property) this controls
-how the line wrapping is done. The default is %PANGO_WRAP_WORD, which
-means wrap on word boundaries.
+Controls how the line wrapping is done.
+
+This only affects the formatting if line wrapping is on (see the
+[property@Gtk.Label:wrap] property). The default is %PANGO_WRAP_WORD,
+which means wrap on word boundaries.
</description>
</property>
<property name="GtkLabel:xalign">
<description>
-The xalign property determines the horizontal alignment of the label text
-inside the labels size allocation. Compare this to #GtkWidget:halign,
-which determines how the labels size allocation is positioned in the
-space available for the label.
+The horizontal alignment of the label text inside its size allocation.
+
+Compare this to [property@Gtk.Widget:halign], which determines how the
+labels size allocation is positioned in the space available for the label.
</description>
</property>
<property name="GtkLabel:yalign">
<description>
-The yalign property determines the vertical alignment of the label text
-inside the labels size allocation. Compare this to #GtkWidget:valign,
-which determines how the labels size allocation is positioned in the
-space available for the label.
+The vertical alignment of the label text inside its size allocation.
+
+Compare this to [property@Gtk.Widget:valign], which determines how the
+labels size allocation is positioned in the space available for the label.
</description>
</property>
<property name="GtkLayoutChild:child-widget">
<description>
-The widget that is associated to the #GtkLayoutChild instance.
+The widget that is associated to the `GtkLayoutChild` instance.
</description>
</property>
<property name="GtkLayoutChild:layout-manager">
<description>
-The layout manager that created the #GtkLayoutChild instance.
+The layout manager that created the `GtkLayoutChild` instance.
</description>
</property>
<signal name="GtkLevelBar::offset-changed">
<description>
-Emitted when an offset specified on the bar changes value as an
-effect to gtk_level_bar_add_offset_value() being called.
+Emitted when an offset specified on the bar changes value.
+
+This typically is the result of a [method@Gtk.LevelBar.add_offset_value]
+call.
The signal supports detailed connections; you can connect to the
detailed signal "changed::x" in order to only receive callbacks when
@@ -8766,7 +9528,7 @@ the value of offset "x" changes.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLevelBar
+<parameter_description> a `GtkLevelBar`
</parameter_description>
</parameter>
<parameter name="name">
@@ -8779,6 +9541,8 @@ the value of offset "x" changes.
<property name="GtkLevelBar:inverted">
<description>
+Whether the `GtkLeveBar` is inverted.
+
Level bars normally grow from top to bottom or left to right.
Inverted level bars grow in the opposite direction.
@@ -8787,45 +9551,45 @@ Inverted level bars grow in the opposite direction.
<property name="GtkLevelBar:max-value">
<description>
-The #GtkLevelBar:max-value property determaxes the maximum value of
-the interval that can be displayed by the bar.
+Determines the maximum value of the interval that can be displayed by the bar.
</description>
</property>
<property name="GtkLevelBar:min-value">
<description>
-The #GtkLevelBar:min-value property determines the minimum value of
-the interval that can be displayed by the bar.
+Determines the minimum value of the interval that can be displayed by the bar.
</description>
</property>
<property name="GtkLevelBar:mode">
<description>
-The #GtkLevelBar:mode property determines the way #GtkLevelBar
-interprets the value properties to draw the level fill area.
+Determines the way `GtkLevelBar` interprets the value properties to draw the
+level fill area.
+
Specifically, when the value is #GTK_LEVEL_BAR_MODE_CONTINUOUS,
-#GtkLevelBar will draw a single block representing the current value in
+`GtkLevelBar` will draw a single block representing the current value in
that area; when the value is #GTK_LEVEL_BAR_MODE_DISCRETE,
the widget will draw a succession of separate blocks filling the
draw area, with the number of blocks being equal to the units separating
-the integral roundings of #GtkLevelBar:min-value and #GtkLevelBar:max-value.
+the integral roundings of [property@Gtk.LevelBar:min-value] and
+[property@Gtk.LevelBar:max-value].
</description>
</property>
<property name="GtkLevelBar:value">
<description>
-The #GtkLevelBar:value property determines the currently
-filled value of the level bar.
+Determines the currently filled value of the level bar.
</description>
</property>
<enum name="GtkLevelBarMode">
<description>
-Describes how #GtkLevelBar contents should be rendered.
+Describes how `GtkLevelBar` contents should be rendered.
+
Note that this enumeration could be extended with additional modes
in the future.
@@ -8928,15 +9692,15 @@ developer
<signal name="GtkLinkButton::activate-link">
<description>
-The ::activate-link signal is emitted each time the #GtkLinkButton
-has been clicked.
+Emitted each time the `GtkLinkButton` is clicked.
+
+The default handler will call [func@Gtk.show_uri] with the URI
+stored inside the [property@Gtk.LinkButton:uri] property.
-The default handler will call gtk_show_uri() with the URI stored inside
-the #GtkLinkButton:uri property.
+To override the default behavior, you can connect to the
+::activate-link signal and stop the propagation of the signal
+by returning %TRUE from your handler.
-To override the default behavior, you can connect to the ::activate-link
-signal and stop the propagation of the signal by returning %TRUE from
-your handler.
</description>
<parameters>
@@ -8945,7 +9709,8 @@ your handler.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the signal has been handled
+</return>
</signal>
<property name="GtkLinkButton:uri">
@@ -8957,8 +9722,9 @@ The URI bound to this button.
<property name="GtkLinkButton:visited">
<description>
-The 'visited' state of this button. A visited link is drawn in a
-different color.
+The 'visited' state of this button.
+
+A visited link is drawn in a different color.
</description>
</property>
@@ -8973,12 +9739,12 @@ for details.
<signal name="GtkListBox::row-activated">
<description>
-The ::row-activated signal is emitted when a row has been activated by the user.
+Emitted when a row has been activated by the user.
</description>
<parameters>
<parameter name="box">
-<parameter_description> the #GtkListBox
+<parameter_description> the `GtkListBox`
</parameter_description>
</parameter>
<parameter name="row">
@@ -8991,17 +9757,17 @@ The ::row-activated signal is emitted when a row has been activated by the user.
<signal name="GtkListBox::row-selected">
<description>
-The ::row-selected signal is emitted when a new row is selected, or
-(with a %NULL @row) when the selection is cleared.
+Emitted when a new row is selected, or (with a %NULL @row)
+when the selection is cleared.
-When the @box is using #GTK_SELECTION_MULTIPLE, this signal will not
+When the @box is using %GTK_SELECTION_MULTIPLE, this signal will not
give you the full picture of selection changes, and you should use
-the #GtkListBox::selected-rows-changed signal instead.
+the [signal@Gtk.ListBox::selected-rows-changed] signal instead.
</description>
<parameters>
<parameter name="box">
-<parameter_description> the #GtkListBox
+<parameter_description> the `GtkListBox`
</parameter_description>
</parameter>
<parameter name="row">
@@ -9014,16 +9780,17 @@ the #GtkListBox::selected-rows-changed signal instead.
<signal name="GtkListBox::select-all">
<description>
-The ::select-all signal is a [keybinding signal][GtkSignalAction]
-which gets emitted to select all children of the box, if the selection
+Emitted to select all children of the box, if the selection
mode permits it.
-The default bindings for this signal is Ctrl-a.
+This is a [keybinding signal](class.SignalAction.html).
+
+The default binding for this signal is <kbd>Ctrl</kbd>-<kbd>a</kbd>.
</description>
<parameters>
<parameter name="box">
-<parameter_description> the #GtkListBox on which the signal is emitted
+<parameter_description> the `GtkListBox` on which the signal is emitted
</parameter_description>
</parameter>
</parameters>
@@ -9032,13 +9799,12 @@ The default bindings for this signal is Ctrl-a.
<signal name="GtkListBox::selected-rows-changed">
<description>
-The ::selected-rows-changed signal is emitted when the
-set of selected rows changes.
+Emitted when the set of selected rows changes.
</description>
<parameters>
<parameter name="box">
-<parameter_description> the #GtkListBox on which the signal is emitted
+<parameter_description> the `GtkListBox` on which the signal is emitted
</parameter_description>
</parameter>
</parameters>
@@ -9047,28 +9813,60 @@ set of selected rows changes.
<signal name="GtkListBox::unselect-all">
<description>
-The ::unselect-all signal is a [keybinding signal][GtkSignalAction]
-which gets emitted to unselect all children of the box, if the selection
+Emitted to unselect all children of the box, if the selection
mode permits it.
-The default bindings for this signal is Ctrl-Shift-a.
+This is a [keybinding signal](class.SignalAction.html).
+
+The default binding for this signal is
+<kbd>Ctrl</kbd>-<kbd>Shift</kbd>-<kbd>a</kbd>.
</description>
<parameters>
<parameter name="box">
-<parameter_description> the #GtkListBox on which the signal is emitted
+<parameter_description> the `GtkListBox` on which the signal is emitted
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>
+<property name="GtkListBox:accept-unpaired-release">
+<description>
+Whether to accept unpaired release events.
+
+</description>
+</property>
+
+<property name="GtkListBox:activate-on-single-click">
+<description>
+Determines whether children can be activated with a single
+click, or require a double-click.
+
+</description>
+</property>
+
+<property name="GtkListBox:selection-mode">
+<description>
+The selection mode used by the list box.
+
+</description>
+</property>
+
+<property name="GtkListBox:show-separators">
+<description>
+Whether to show separators between rows.
+
+</description>
+</property>
+
<signal name="GtkListBoxRow::activate">
<description>
This is a keybinding signal, which will cause this row to be activated.
If you want to be notified when the user activates a row (by key or not),
-use the #GtkListBox::row-activated signal on the row’s parent #GtkListBox.
+use the [signal@Gtk.ListBox::row-activated] signal on the row’s parent
+`GtkListBox`.
</description>
<parameters>
@@ -9078,73 +9876,81 @@ use the #GtkListBox::row-activated signal on the row’s parent #GtkListBox.
<property name="GtkListBoxRow:activatable">
<description>
-The property determines whether the #GtkListBox::row-activated
+Determines whether the ::row-activated
signal will be emitted for this row.
</description>
</property>
+<property name="GtkListBoxRow:child">
+<description>
+The child widget.
+
+</description>
+</property>
+
<property name="GtkListBoxRow:selectable">
<description>
-The property determines whether this row can be selected.
+Determines whether this row can be selected.
</description>
</property>
<property name="GtkListItem:activatable">
<description>
-If the item can be activated by the user
+If the item can be activated by the user.
</description>
</property>
<property name="GtkListItem:child">
<description>
-Widget used for display
+Widget used for display.
</description>
</property>
<property name="GtkListItem:item">
<description>
-Displayed item
+Displayed item.
</description>
</property>
<property name="GtkListItem:position">
<description>
-Position of the item
+Position of the item.
</description>
</property>
<property name="GtkListItem:selectable">
<description>
-If the item can be selected by the user
+If the item can be selected by the user.
</description>
</property>
<property name="GtkListItem:selected">
<description>
-If the item is currently selected
+If the item is currently selected.
</description>
</property>
<signal name="GtkListView::activate">
<description>
-The ::activate signal is emitted when a row has been activated by the user,
+Emitted when a row has been activated by the user,
usually via activating the GtkListView|list.activate-item action.
This allows for a convenient way to handle activation in a listview.
-See gtk_list_item_set_activatable() for details on how to use this signal.
+See [method@Gtk.ListItem.set_activatable] for details on how to use
+this signal.
</description>
<parameters>
<parameter name="self">
-<parameter_description> The #GtkListView
+<parameter_description> The `GtkListView`
</parameter_description>
</parameter>
<parameter name="position">
@@ -9157,35 +9963,77 @@ See gtk_list_item_set_activatable() for details on how to use this signal.
<property name="GtkListView:enable-rubberband">
<description>
-Allow rubberband selection
+Allow rubberband selection.
</description>
</property>
<property name="GtkListView:factory">
<description>
-Factory for populating list items
+Factory for populating list items.
</description>
</property>
<property name="GtkListView:model">
<description>
-Model for the items displayed
+Model for the items displayed.
</description>
</property>
<property name="GtkListView:show-separators">
<description>
-Show separators between rows
+Show separators between rows.
</description>
</property>
<property name="GtkListView:single-click-activate">
<description>
-Activate rows on single click and select them on hover
+Activate rows on single click and select them on hover.
+
+</description>
+</property>
+
+<property name="GtkLockButton:permission">
+<description>
+The `GPermission object controlling this button.
+
+</description>
+</property>
+
+<property name="GtkLockButton:text-lock">
+<description>
+The text to display when prompting the user to lock.
+
+</description>
+</property>
+
+<property name="GtkLockButton:text-unlock">
+<description>
+The text to display when prompting the user to unlock.
+
+</description>
+</property>
+
+<property name="GtkLockButton:tooltip-lock">
+<description>
+The tooltip to display when prompting the user to lock.
+
+</description>
+</property>
+
+<property name="GtkLockButton:tooltip-not-authorized">
+<description>
+The tooltip to display when the user cannot obtain authorization.
+
+</description>
+</property>
+
+<property name="GtkLockButton:tooltip-unlock">
+<description>
+The tooltip to display when prompting the user to unlock.
</description>
</property>
@@ -9199,7 +10047,7 @@ If a map is set for this model
<property name="GtkMapListModel:model">
<description>
-The model being mapped
+The model being mapped.
</description>
</property>
@@ -9220,7 +10068,9 @@ The file being played back or %NULL if not playing a file.
<property name="GtkMediaFile:input-stream">
<description>
-The stream being played back or %NULL if not playing a stream, like when playing a file.
+The stream being played back or %NULL if not playing a stream.
+
+This is %NULL when playing a file.
</description>
</property>
@@ -9241,21 +10091,22 @@ Set when playback has finished.
<property name="GtkMediaStream:error">
<description>
-%NULL for a properly working stream or the #GError that the stream is in.
+%NULL for a properly working stream or the `GError`
+that the stream is in.
</description>
</property>
<property name="GtkMediaStream:has-audio">
<description>
-Whether the stream contains audio
+Whether the stream contains audio.
</description>
</property>
<property name="GtkMediaStream:has-video">
<description>
-Whether the stream contains video
+Whether the stream contains video.
</description>
</property>
@@ -9319,34 +10170,63 @@ Volume of the audio stream.
<property name="GtkMenuButton:direction">
<description>
-The #GtkArrowType representing the direction in which the
+The `GtkArrowType` representing the direction in which the
menu or popover will be popped out.
</description>
</property>
+<property name="GtkMenuButton:has-frame">
+<description>
+Whether the button has a frame.
+
+</description>
+</property>
+
+<property name="GtkMenuButton:icon-name">
+<description>
+The name of the icon used to automatically populate the button.
+
+</description>
+</property>
+
+<property name="GtkMenuButton:label">
+<description>
+The label for the button.
+
+</description>
+</property>
+
<property name="GtkMenuButton:menu-model">
<description>
-The #GMenuModel from which the popup will be created.
+The `GMenuModel` from which the popup will be created.
-See gtk_menu_button_set_menu_model() for the interaction with the
-#GtkMenuButton:popup property.
+See [method@Gtk.MenuButton.set_menu_model] for the interaction
+with the [property@Gtk.MenuButton:popover] property.
</description>
</property>
<property name="GtkMenuButton:popover">
<description>
-The #GtkPopover that will be popped up when the button is clicked.
+The `GtkPopover` that will be popped up when the button is clicked.
+
+</description>
+</property>
+
+<property name="GtkMenuButton:use-underline">
+<description>
+If set an underscore in the text indicates a mnemonic.
</description>
</property>
<property name="GtkMessageDialog:message-area">
<description>
-The #GtkBox that corresponds to the message area of this dialog. See
-gtk_message_dialog_get_message_area() for a detailed description of this
-area.
+The `GtkBox` that corresponds to the message area of this dialog.
+
+See [method@Gtk.MessageDialog.get_message_area] for a detailed
+description of this area.
</description>
</property>
@@ -9360,38 +10240,41 @@ The type of the message.
<property name="GtkMessageDialog:secondary-text">
<description>
-The secondary text of the message dialog.
+The secondary text of the message dialog.
</description>
</property>
<property name="GtkMessageDialog:secondary-use-markup">
<description>
-%TRUE if the secondary text of the dialog includes Pango markup.
-See pango_parse_markup().
+%TRUE if the secondary text of the dialog includes Pango markup.
+
+See [func@Pango.parse_markup].
</description>
</property>
<property name="GtkMessageDialog:text">
<description>
-The primary text of the message dialog. If the dialog has
-a secondary text, this will appear as the title.
+The primary text of the message dialog.
+
+If the dialog has a secondary text, this will appear as the title.
</description>
</property>
<property name="GtkMessageDialog:use-markup">
<description>
-%TRUE if the primary text of the dialog includes Pango markup.
-See pango_parse_markup().
+%TRUE if the primary text of the dialog includes Pango markup.
+
+See [func@Pango.parse_markup].
</description>
</property>
<enum name="GtkMessageType">
<description>
-The type of message being displayed in the dialog.
+The type of message being displayed in a `GtkMessageDialog`.
</description>
<parameters>
@@ -9491,8 +10374,31 @@ text will be displayed verbatim.
</description>
</property>
+<property name="GtkMountOperation:display">
+<description>
+The display where dialogs will be shown.
+
+</description>
+</property>
+
+<property name="GtkMountOperation:is-showing">
+<description>
+Whether a dialog is currently shown.
+
+</description>
+</property>
+
+<property name="GtkMountOperation:parent">
+<description>
+The parent window.
+
+</description>
+</property>
+
<enum name="GtkMovementStep">
<description>
+Passed as argument to various keybinding signals for moving the
+cursor position.
</description>
<parameters>
@@ -9541,7 +10447,7 @@ text will be displayed verbatim.
<property name="GtkMultiSelection:model">
<description>
-The list managed by this selection
+The list managed by this selection.
</description>
</property>
@@ -9559,8 +10465,8 @@ Emitted when the user responds to the dialog.
When this is called the dialog has been hidden.
-If you call gtk_native_dialog_hide() before the user responds to
-the dialog this signal will not be emitted.
+If you call [method Gtk NativeDialog hide] before the user
+responds to the dialog this signal will not be emitted.
</description>
<parameters>
@@ -9606,7 +10512,7 @@ Whether the window is currently visible.
<property name="GtkNoSelection:model">
<description>
-The model being managed
+The model being managed.
</description>
</property>
@@ -9620,13 +10526,13 @@ A handler for this signal can create a window containing
a notebook where the tab will be attached. It is also
responsible for moving/resizing the window and adding the
necessary properties to the notebook (e.g. the
-#GtkNotebook:group-name ).
+`GtkNotebook`:group-name ).
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> the #GtkNotebook emitting the signal
+<parameter_description> the `GtkNotebook` emitting the signal
</parameter_description>
</parameter>
<parameter name="page">
@@ -9634,7 +10540,7 @@ necessary properties to the notebook (e.g. the
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkNotebook that @page should be
+<return> a `GtkNotebook` that @page should be
added to, or %NULL.
</return>
</signal>
@@ -9647,7 +10553,7 @@ right after a page is added to the notebook.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> the #GtkNotebook
+<parameter_description> the `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
@@ -9670,7 +10576,7 @@ right after a page is removed from the notebook.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> the #GtkNotebook
+<parameter_description> the `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
@@ -9693,7 +10599,7 @@ right after a page has been reordered.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> the #GtkNotebook
+<parameter_description> the `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
@@ -9730,6 +10636,13 @@ Emitted when the user or a function changes the current page.
<return></return>
</signal>
+<property name="GtkNotebook:enable-popup">
+<description>
+If %TRUE, pressing the right mouse button on the notebook shows a page switching menu.
+
+</description>
+</property>
+
<property name="GtkNotebook:group-name">
<description>
Group name for tab drag and drop.
@@ -9737,9 +10650,121 @@ Group name for tab drag and drop.
</description>
</property>
+<property name="GtkNotebook:page">
+<description>
+The index of the current page.
+
+</description>
+</property>
+
+<property name="GtkNotebook:pages">
+<description>
+A selection model with the pages.
+
+</description>
+</property>
+
+<property name="GtkNotebook:scrollable">
+<description>
+If %TRUE, scroll arrows are added if there are too many pages to fit.
+
+</description>
+</property>
+
+<property name="GtkNotebook:show-border">
+<description>
+Whether the border should be shown.
+
+</description>
+</property>
+
+<property name="GtkNotebook:show-tabs">
+<description>
+Whether tabs should be shown.
+
+</description>
+</property>
+
+<property name="GtkNotebook:tab-pos">
+<description>
+Which side of the notebook holds the tabs.
+
+</description>
+</property>
+
+<property name="GtkNotebookPage:child">
+<description>
+The child for this page.
+
+</description>
+</property>
+
+<property name="GtkNotebookPage:detachable">
+<description>
+Whether the tab is detachable.
+
+</description>
+</property>
+
+<property name="GtkNotebookPage:menu">
+<description>
+The label widget displayed in the childs menu entry.
+
+</description>
+</property>
+
+<property name="GtkNotebookPage:menu-label">
+<description>
+The text of the menu widget.
+
+</description>
+</property>
+
+<property name="GtkNotebookPage:position">
+<description>
+The index of the child in the parent.
+
+</description>
+</property>
+
+<property name="GtkNotebookPage:reorderable">
+<description>
+Whether the tab is reorderable by user action.
+
+</description>
+</property>
+
+<property name="GtkNotebookPage:tab">
+<description>
+The tab widget for tihs page.
+
+</description>
+</property>
+
+<property name="GtkNotebookPage:tab-expand">
+<description>
+Whether to expand the childs tab.
+
+</description>
+</property>
+
+<property name="GtkNotebookPage:tab-fill">
+<description>
+Whether the childs tab should fill the allocated area.
+
+</description>
+</property>
+
+<property name="GtkNotebookPage:tab-label">
+<description>
+The text of the tab widget.
+
+</description>
+</property>
+
<enum name="GtkNotebookTab">
<description>
-The parameter used in the action signals of #GtkNotebook.
+The parameter used in the action signals of `GtkNotebook`.
</description>
<parameters>
@@ -9798,14 +10823,14 @@ multiple pages per sheet.
<property name="GtkNumericSorter:expression">
<description>
-The expression to evaluate on items to get a number to compare with
+The expression to evaluate on items to get a number to compare with.
</description>
</property>
<property name="GtkNumericSorter:sort-order">
<description>
-Whether the sorter will sort smaller numbers first
+Whether the sorter will sort smaller numbers first.
</description>
</property>
@@ -9814,10 +10839,10 @@ Whether the sorter will sort smaller numbers first
<description>
Describes the way two values can be compared.
-These values can be used with a #GCompareFunc. However, a
-#GCompareFunc is allowed to return any integer values.
-For converting such a value to a #GtkOrdering, use
-gtk_ordering_from_cmpfunc().
+These values can be used with a `GCompareFunc`. However,
+a `GCompareFunc` is allowed to return any integer values.
+For converting such a value to a `GtkOrdering` value, use
+[func@Gtk.Ordering.from_cmpfunc].
</description>
<parameters>
@@ -9845,9 +10870,9 @@ The orientation of the orientable.
<enum name="GtkOrientation">
<description>
-Represents the orientation of widgets and other objects which can be switched
-between horizontal and vertical orientation on the fly, like #GtkBox or
-#GtkGesturePan.
+Represents the orientation of widgets and other objects.
+
+Typical examples are `GtkBox or `GtkGesturePan`.
</description>
<parameters>
@@ -9864,9 +10889,11 @@ between horizontal and vertical orientation on the fly, like #GtkBox or
<enum name="GtkOverflow">
<description>
-Defines how content overflowing a given area should be handled, such as
-with gtk_widget_set_overflow(). This property is modeled after the CSS overflow
-property, but implements it only partially.
+Defines how content overflowing a given area should be handled.
+
+This is used in [method@Gtk.Widget.set_overflow]. The
+[property@Gtk.Widget:overflow] property is modeled after the
+CSS overflow property, but implements it only partially.
</description>
<parameters>
@@ -9885,9 +10912,10 @@ outside the area is not drawn and cannot be interacted with.
<signal name="GtkOverlay::get-child-position">
<description>
-The ::get-child-position signal is emitted to determine
-the position and size of any overlay child widgets. A
-handler for this signal should fill @allocation with
+Emitted to determine the position and size of any overlay
+child widgets.
+
+A handler for this signal should fill @allocation with
the desired position and size for @widget, relative to
the 'main' child of @overlay.
@@ -9896,7 +10924,7 @@ halign and valign properties to determine the position
and gives the widget its natural size (except that an
alignment of %GTK_ALIGN_FILL will cause the overlay to
be full-width/height). If the main child is a
-#GtkScrolledWindow, the overlays are placed relative
+`GtkScrolledWindow`, the overlays are placed relative
to its contents.
@@ -9929,7 +10957,7 @@ Whether the child should be clipped to fit the parent's size.
<property name="GtkOverlayLayoutChild:measure">
<description>
-Whether the child size should contribute to the #GtkOverlayLayout's
+Whether the child size should contribute to the `GtkOverlayLayout`'s
measurement.
</description>
@@ -9938,7 +10966,8 @@ measurement.
<enum name="GtkPackType">
<description>
Represents the packing location of a children in its parent.
-See #GtkWindowControls for example.
+
+See `GtkWindowControls` for example.
</description>
<parameters>
@@ -10022,7 +11051,7 @@ See also gtk_print_job_set_page_set().
<enum name="GtkPanDirection">
<description>
-Describes the panning direction of a #GtkGesturePan
+Describes the panning direction of a `GtkGesturePan`
</description>
<parameters>
@@ -10047,11 +11076,11 @@ Describes the panning direction of a #GtkGesturePan
<signal name="GtkPaned::accept-position">
<description>
-The ::accept-position signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to accept the current position of the handle when
+Emitted to accept the current position of the handle when
moving it using key bindings.
+This is a [keybinding signal](class.SignalAction.html).
+
The default binding for this signal is Return or Space.
</description>
@@ -10066,12 +11095,14 @@ The default binding for this signal is Return or Space.
<signal name="GtkPaned::cancel-position">
<description>
-The ::cancel-position signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to cancel moving the position of the handle using key
-bindings. The position of the handle will be reset to the value prior to
+Emitted to cancel moving the position of the handle using key
+bindings.
+
+The position of the handle will be reset to the value prior to
moving it.
+This is a [keybinding signal](class.SignalAction.html).
+
The default binding for this signal is Escape.
</description>
@@ -10086,11 +11117,11 @@ The default binding for this signal is Escape.
<signal name="GtkPaned::cycle-child-focus">
<description>
-The ::cycle-child-focus signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to cycle the focus between the children of the paned.
+Emitted to cycle the focus between the children of the paned.
+
+This is a [keybinding signal](class.SignalAction.html).
-The default binding is f6.
+The default binding is F6.
</description>
<parameters>
@@ -10108,12 +11139,12 @@ The default binding is f6.
<signal name="GtkPaned::cycle-handle-focus">
<description>
-The ::cycle-handle-focus signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to cycle whether the paned should grab focus to allow
+Emitted to cycle whether the paned should grab focus to allow
the user to change position of the handle by using key bindings.
-The default binding for this signal is f8.
+This is a [keybinding signal](class.SignalAction.html).
+
+The default binding for this signal is F8.
</description>
<parameters>
@@ -10131,10 +11162,9 @@ The default binding for this signal is f8.
<signal name="GtkPaned::move-handle">
<description>
-The ::move-handle signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to move the handle when the user is using key bindings
-to move it.
+Emitted to move the handle with key bindings.
+
+This is a [keybinding signal](class.SignalAction.html).
</description>
<parameters>
@@ -10152,11 +11182,11 @@ to move it.
<signal name="GtkPaned::toggle-handle-focus">
<description>
-The ::toggle-handle-focus is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to accept the current position of the handle and then
+Emitted to accept the current position of the handle and then
move focus to the next widget in the focus chain.
+This is a [keybinding signal](class.SignalAction.html).
+
The default binding is Tab.
</description>
@@ -10169,9 +11199,17 @@ The default binding is Tab.
<return></return>
</signal>
+<property name="GtkPaned:end-child">
+<description>
+The second child.
+
+</description>
+</property>
+
<property name="GtkPaned:max-position">
<description>
The largest possible value for the position property.
+
This property is derived from the size and shrinkability
of the widget's children.
@@ -10181,58 +11219,95 @@ of the widget's children.
<property name="GtkPaned:min-position">
<description>
The smallest possible value for the position property.
+
This property is derived from the size and shrinkability
of the widget's children.
</description>
</property>
+<property name="GtkPaned:position">
+<description>
+Position of the separator in pixels, from the left/top.
+
+</description>
+</property>
+
+<property name="GtkPaned:position-set">
+<description>
+%TRUE if the `position` property has been set.
+
+</description>
+</property>
+
<property name="GtkPaned:resize-end-child">
<description>
-The "resize-end-child" property determines whether the second child expands and
-shrinks along with the paned widget.
+Determines whether the second child expands and shrinks
+along with the paned widget.
</description>
</property>
<property name="GtkPaned:resize-start-child">
<description>
-The "resize-start-child" property determines whether the first child expands and
-shrinks along with the paned widget.
+Determines whether the first child expands and shrinks
+along with the paned widget.
</description>
</property>
<property name="GtkPaned:shrink-end-child">
<description>
-The "shrink-end-child" property determines whether the second child can be made
-smaller than its requisition.
+Determines whether the second child can be made smaller
+than its requisition.
</description>
</property>
<property name="GtkPaned:shrink-start-child">
<description>
-The "shrink-start-child" property determines whether the first child can be made
-smaller than its requisition.
+Determines whether the first child can be made smaller
+than its requisition.
+
+</description>
+</property>
+
+<property name="GtkPaned:start-child">
+<description>
+The first child.
</description>
</property>
<property name="GtkPaned:wide-handle">
<description>
-Setting this property to %TRUE indicates that the paned needs
-to provide stronger visual separation (e.g. because it separates
-between two notebooks, whose tab rows would otherwise merge visually).
+Whether the `GtkPaned` should provide a stronger visual separation.
+
+For example, this could be set when a paned contains two
+[class@Gtk.Notebook]s, whose tab rows would otherwise merge visually.
</description>
</property>
-<property name="GtkPasswordEntry:activate">
+<signal name="GtkPasswordEntry::activate">
<description>
-The ::activate signal is forwarded from the
-#GtkText::activated signal, which is a keybinding
-signal for all forms of the Enter key.
+Emitted when the entry is activated.
+
+The keybindings for this signal are all forms of the Enter key.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> The widget on which the signal is emitted
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<property name="GtkPasswordEntry:activates-default">
+<description>
+Whether to activate the default widget when Enter is pressed.
</description>
</property>
@@ -10245,9 +11320,24 @@ the context menu.
</description>
</property>
+<property name="GtkPasswordEntry:placeholder-text">
+<description>
+The text that will be displayed in the `GtkPasswordEntry`
+when it is empty and unfocused.
+
+</description>
+</property>
+
+<property name="GtkPasswordEntry:show-peek-icon">
+<description>
+Whether to show an icon for revealing the content.
+
+</description>
+</property>
+
<enum name="GtkPickFlags">
<description>
-Flags that influence the behavior of gtk_widget_pick()
+Flags that influence the behavior of gtk_widget_pick().
</description>
<parameters>
@@ -10260,7 +11350,7 @@ Flags that influence the behavior of gtk_widget_pick()
</parameter_description>
</parameter>
<parameter name="GTK_PICK_NON_TARGETABLE">
-<parameter_description> Include widgets that are marked as non-targetable. See #GtkWidget:can-target
+<parameter_description> Include widgets that are marked as non-targetable. See #GtkWidget:can-target
</parameter_description>
</parameter>
</parameters>
@@ -10275,14 +11365,14 @@ The alternative textual description for the picture.
<property name="GtkPicture:can-shrink">
<description>
-If the #GtkPicture can be made smaller than the self it contains.
+If the `GtkPicture` can be made smaller than the natural size of its contents.
</description>
</property>
<property name="GtkPicture:file">
<description>
-The #GFile that is displayed or %NULL if none.
+The `GFile` that is displayed or %NULL if none.
</description>
</property>
@@ -10290,14 +11380,14 @@ The #GFile that is displayed or %NULL if none.
<property name="GtkPicture:keep-aspect-ratio">
<description>
Whether the GtkPicture will render its contents trying to preserve the aspect
-ratio of the contents.
+ratio.
</description>
</property>
<property name="GtkPicture:paintable">
<description>
-The #GdkPaintable to be displayed by this #GtkPicture.
+The `GdkPaintable` to be displayed by this `GtkPicture`.
</description>
</property>
@@ -10316,7 +11406,7 @@ independent of the content.
</parameter>
<parameter name="GTK_POLICY_AUTOMATIC">
<parameter_description> The scrollbar will appear and disappear as necessary.
-For example, when all of a #GtkTreeView can not be seen.
+For example, when all of a `GtkTreeView` can not be seen.
</parameter_description>
</parameter>
<parameter name="GTK_POLICY_NEVER">
@@ -10335,15 +11425,14 @@ scrolled windows share a scrollbar.
<signal name="GtkPopover::activate-default">
<description>
-The ::activate-default signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user activates the default widget
-of @self.
+Emitted whend the user activates the default widget.
+
+This is a [keybinding signal](class.SignalAction.html).
</description>
<parameters>
<parameter name="self">
-<parameter_description> the #GtkPopover which received the signal
+<parameter_description> the `GtkPopover` which received the signal
</parameter_description>
</parameter>
</parameters>
@@ -10352,21 +11441,93 @@ of @self.
<signal name="GtkPopover::closed">
<description>
-The ::closed signal is emitted when the popover is closed.
+Emitted when the popover is closed.
</description>
<parameters>
<parameter name="self">
-<parameter_description> the #GtkPopover which received the signal
+<parameter_description> the `GtkPopover` which received the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>
+<property name="GtkPopover:autohide">
+<description>
+Whether to dismiss the popover on outside clicks.
+
+</description>
+</property>
+
+<property name="GtkPopover:cascade-popdown">
+<description>
+Whether the popover pops down after a child popover.
+
+This is used to implement the expected behavior of submenus.
+
+</description>
+</property>
+
+<property name="GtkPopover:child">
+<description>
+The child widget.
+
+</description>
+</property>
+
+<property name="GtkPopover:default-widget">
+<description>
+The default widget inside the popover.
+
+</description>
+</property>
+
+<property name="GtkPopover:has-arrow">
+<description>
+Whether to draw an arrow.
+
+</description>
+</property>
+
+<property name="GtkPopover:mnemonics-visible">
+<description>
+Whether mnemonics are currently visible in this popover.
+
+</description>
+</property>
+
+<property name="GtkPopover:pointing-to">
+<description>
+Rectangle in the parent widget that the popover points to.
+
+</description>
+</property>
+
+<property name="GtkPopover:position">
+<description>
+How to place the popover, relative to its parent.
+
+</description>
+</property>
+
+<property name="GtkPopoverMenu:menu-model">
+<description>
+The model from which the menu is made.
+
+</description>
+</property>
+
+<property name="GtkPopoverMenu:visible-submenu">
+<description>
+The name of the visible submenu.
+
+</description>
+</property>
+
<property name="GtkPopoverMenuBar:menu-model">
<description>
-The #GMenuModel from which the menu bar is created.
+The `GMenuModel` from which the menu bar is created.
The model should only contain submenus as toplevel elements.
@@ -10391,8 +11552,10 @@ sliding pages that replace the main menu.
<enum name="GtkPositionType">
<description>
-Describes which edge of a widget a certain feature is positioned at, e.g.
-the tabs of a #GtkNotebook, or the label of a #GtkScale.
+Describes which edge of a widget a certain feature is positioned at.
+
+For examples, see the tabs of a `GtkNotebook`, or the label
+of a `GtkScale`.
</description>
<parameters>
@@ -10417,9 +11580,10 @@ the tabs of a #GtkNotebook, or the label of a #GtkScale.
<enum name="GtkPrintCapabilities">
<description>
-An enum for specifying which features the print dialog should offer.
+Specifies which features the print dialog should offer.
+
If neither %GTK_PRINT_CAPABILITY_GENERATE_PDF nor
-%GTK_PRINT_CAPABILITY_GENERATE_PS is specified, GTK+ assumes that all
+%GTK_PRINT_CAPABILITY_GENERATE_PS is specified, GTK assumes that all
formats are supported.
</description>
@@ -10521,8 +11685,10 @@ or paper size from a key file.
<signal name="GtkPrintJob::status-changed">
<description>
-Gets emitted when the status of a job changes. The signal handler
-can use gtk_print_job_get_status() to obtain the new status.
+Emitted when the status of a job changes.
+
+The signal handler can use [method@Gtk.PrintJob.get_status]
+to obtain the new status.
</description>
<parameters>
@@ -10534,23 +11700,60 @@ can use gtk_print_job_get_status() to obtain the new status.
<return></return>
</signal>
+<property name="GtkPrintJob:page-setup">
+<description>
+Page setup.
+
+</description>
+</property>
+
+<property name="GtkPrintJob:printer">
+<description>
+The printer to send the job to.
+
+</description>
+</property>
+
+<property name="GtkPrintJob:settings">
+<description>
+Printer settings.
+
+</description>
+</property>
+
+<property name="GtkPrintJob:title">
+<description>
+The title of the print job.
+
+</description>
+</property>
+
+<property name="GtkPrintJob:track-print-status">
+<description>
+%TRUE if the print job will continue to emit status-changed
+signals after the print data has been setn to the printer.
+
+</description>
+</property>
+
<signal name="GtkPrintOperation::begin-print">
<description>
Emitted after the user has finished changing print settings
-in the dialog, before the actual rendering starts.
+in the dialog, before the actual rendering starts.
A typical use for ::begin-print is to use the parameters from the
-#GtkPrintContext and paginate the document accordingly, and then
-set the number of pages with gtk_print_operation_set_n_pages().
+[class@Gtk.PrintContext] and paginate the document accordingly,
+and then set the number of pages with
+[method@Gtk.PrintOperation.set_n_pages].
</description>
<parameters>
<parameter name="operation">
-<parameter_description> the #GtkPrintOperation on which the signal was emitted
+<parameter_description> the `GtkPrintOperation` on which the signal was emitted
</parameter_description>
</parameter>
<parameter name="context">
-<parameter_description> the #GtkPrintContext for the current operation
+<parameter_description> the `GtkPrintContext` for the current operation
</parameter_description>
</parameter>
</parameters>
@@ -10559,22 +11762,23 @@ set the number of pages with gtk_print_operation_set_n_pages().
<signal name="GtkPrintOperation::create-custom-widget">
<description>
-Emitted when displaying the print dialog. If you return a
-widget in a handler for this signal it will be added to a custom
-tab in the print dialog. You typically return a container widget
-with multiple widgets in it.
+Emitted when displaying the print dialog.
-The print dialog owns the returned widget, and its lifetime is not
-controlled by the application. However, the widget is guaranteed
-to stay around until the #GtkPrintOperation::custom-widget-apply
-signal is emitted on the operation. Then you can read out any
+If you return a widget in a handler for this signal it will be
+added to a custom tab in the print dialog. You typically return a
+container widget with multiple widgets in it.
+
+The print dialog owns the returned widget, and its lifetime is not
+controlled by the application. However, the widget is guaranteed
+to stay around until the [signal@Gtk.PrintOperation::custom-widget-apply]
+signal is emitted on the operation. Then you can read out any
information you need from the widgets.
</description>
<parameters>
<parameter name="operation">
-<parameter_description> the #GtkPrintOperation on which the signal was emitted
+<parameter_description> the `GtkPrintOperation` on which the signal was emitted
</parameter_description>
</parameter>
</parameters>
@@ -10585,20 +11789,21 @@ the print dialog, or %NULL
<signal name="GtkPrintOperation::custom-widget-apply">
<description>
-Emitted right before #GtkPrintOperation::begin-print if you added
-a custom widget in the #GtkPrintOperation::create-custom-widget handler.
-When you get this signal you should read the information from the
-custom widgets, as the widgets are not guaraneed to be around at a
+Emitted right before ::begin-print if you added
+a custom widget in the ::create-custom-widget handler.
+
+When you get this signal you should read the information from the
+custom widgets, as the widgets are not guaranteed to be around at a
later time.
</description>
<parameters>
<parameter name="operation">
-<parameter_description> the #GtkPrintOperation on which the signal was emitted
+<parameter_description> the `GtkPrintOperation` on which the signal was emitted
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> the custom widget added in create-custom-widget
+<parameter_description> the custom widget added in ::create-custom-widget
</parameter_description>
</parameter>
</parameters>
@@ -10608,20 +11813,20 @@ later time.
<signal name="GtkPrintOperation::done">
<description>
Emitted when the print operation run has finished doing
-everything required for printing.
+everything required for printing.
-@result gives you information about what happened during the run.
+@result gives you information about what happened during the run.
If @result is %GTK_PRINT_OPERATION_RESULT_ERROR then you can call
-gtk_print_operation_get_error() for more information.
+[method@Gtk.PrintOperation.get_error] for more information.
-If you enabled print status tracking then
-gtk_print_operation_is_finished() may still return %FALSE
-after #GtkPrintOperation::done was emitted.
+If you enabled print status tracking then
+[method@Gtk.PrintOperation.is_finished] may still return %FALSE
+after the ::done signal was emitted.
</description>
<parameters>
<parameter name="operation">
-<parameter_description> the #GtkPrintOperation on which the signal was emitted
+<parameter_description> the `GtkPrintOperation` on which the signal was emitted
</parameter_description>
</parameter>
<parameter name="result">
@@ -10634,10 +11839,13 @@ after #GtkPrintOperation::done was emitted.
<signal name="GtkPrintOperation::draw-page">
<description>
-Emitted for every page that is printed. The signal handler
-must render the @page_nr's page onto the cairo context obtained
-from @context using gtk_print_context_get_cairo_context().
-|[<!-- language="C" -->
+Emitted for every page that is printed.
+
+The signal handler must render the @page_nr's page onto the cairo
+context obtained from @context using
+[method@Gtk.PrintContext.get_cairo_context].
+
+```c
static void
draw_page (GtkPrintOperation *operation,
GtkPrintContext *context,
@@ -10676,21 +11884,21 @@ pango_cairo_show_layout (cr, layout);
g_object_unref (layout);
}
-]|
+```
-Use gtk_print_operation_set_use_full_page() and
-gtk_print_operation_set_unit() before starting the print operation
-to set up the transformation of the cairo context according to your
-needs.
+Use [method@Gtk.PrintOperation.set_use_full_page] and
+[method@Gtk.PrintOperation.set_unit] before starting the print
+operation to set up the transformation of the cairo context
+according to your needs.
</description>
<parameters>
<parameter name="operation">
-<parameter_description> the #GtkPrintOperation on which the signal was emitted
+<parameter_description> the `GtkPrintOperation` on which the signal was emitted
</parameter_description>
</parameter>
<parameter name="context">
-<parameter_description> the #GtkPrintContext for the current operation
+<parameter_description> the `GtkPrintContext` for the current operation
</parameter_description>
</parameter>
<parameter name="page_nr">
@@ -10703,18 +11911,19 @@ needs.
<signal name="GtkPrintOperation::end-print">
<description>
-Emitted after all pages have been rendered.
+Emitted after all pages have been rendered.
+
A handler for this signal can clean up any resources that have
-been allocated in the #GtkPrintOperation::begin-print handler.
+been allocated in the [signal@Gtk.PrintOperation::begin-print] handler.
</description>
<parameters>
<parameter name="operation">
-<parameter_description> the #GtkPrintOperation on which the signal was emitted
+<parameter_description> the `GtkPrintOperation` on which the signal was emitted
</parameter_description>
</parameter>
<parameter name="context">
-<parameter_description> the #GtkPrintContext for the current operation
+<parameter_description> the `GtkPrintContext` for the current operation
</parameter_description>
</parameter>
</parameters>
@@ -10723,14 +11932,15 @@ been allocated in the #GtkPrintOperation::begin-print handler.
<signal name="GtkPrintOperation::paginate">
<description>
-Emitted after the #GtkPrintOperation::begin-print signal, but before
-the actual rendering starts. It keeps getting emitted until a connected
-signal handler returns %TRUE.
+Emitted after the ::begin-print signal, but before the actual rendering
+starts.
+
+It keeps getting emitted until a connected signal handler returns %TRUE.
The ::paginate signal is intended to be used for paginating a document
in small chunks, to avoid blocking the user interface for a long
time. The signal handler should update the number of pages using
-gtk_print_operation_set_n_pages(), and return %TRUE if the document
+[method@Gtk.PrintOperation.set_n_pages], and return %TRUE if the document
has been completely paginated.
If you don't need to do pagination in chunks, you can simply do
@@ -10741,11 +11951,11 @@ from there.
</description>
<parameters>
<parameter name="operation">
-<parameter_description> the #GtkPrintOperation on which the signal was emitted
+<parameter_description> the `GtkPrintOperation` on which the signal was emitted
</parameter_description>
</parameter>
<parameter name="context">
-<parameter_description> the #GtkPrintContext for the current operation
+<parameter_description> the `GtkPrintContext` for the current operation
</parameter_description>
</parameter>
</parameters>
@@ -10757,38 +11967,39 @@ from there.
<description>
Gets emitted when a preview is requested from the native dialog.
-The default handler for this signal uses an external viewer
+The default handler for this signal uses an external viewer
application to preview.
To implement a custom print preview, an application must return
%TRUE from its handler for this signal. In order to use the
provided @context for the preview implementation, it must be
-given a suitable cairo context with gtk_print_context_set_cairo_context().
+given a suitable cairo context with
+[method@Gtk.PrintContext.set_cairo_context].
-The custom preview implementation can use
-gtk_print_operation_preview_is_selected() and
-gtk_print_operation_preview_render_page() to find pages which
+The custom preview implementation can use
+[method@Gtk.PrintOperationPreview.is_selected] and
+[method@Gtk.PrintOperationPreview.render_page] to find pages which
are selected for print and render them. The preview must be
-finished by calling gtk_print_operation_preview_end_preview()
+finished by calling [method@Gtk.PrintOperationPreview.end_preview]
(typically in response to the user clicking a close button).
</description>
<parameters>
<parameter name="operation">
-<parameter_description> the #GtkPrintOperation on which the signal was emitted
+<parameter_description> the `GtkPrintOperation` on which the signal was emitted
</parameter_description>
</parameter>
<parameter name="preview">
-<parameter_description> the #GtkPrintOperationPreview for the current operation
+<parameter_description> the `GtkPrintOperationPreview` for the current operation
</parameter_description>
</parameter>
<parameter name="context">
-<parameter_description> the #GtkPrintContext that will be used
+<parameter_description> the `GtkPrintContext` that will be used
</parameter_description>
</parameter>
<parameter name="parent">
-<parameter_description> the #GtkWindow to use as window parent, or %NULL
+<parameter_description> the `GtkWindow` to use as window parent, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -10798,18 +12009,20 @@ finished by calling gtk_print_operation_preview_end_preview()
<signal name="GtkPrintOperation::request-page-setup">
<description>
-Emitted once for every page that is printed, to give
-the application a chance to modify the page setup. Any changes
-done to @setup will be in force only for printing this page.
+Emitted once for every page that is printed.
+
+This gives the application a chance to modify the page setup.
+Any changes done to @setup will be in force only for printing
+this page.
</description>
<parameters>
<parameter name="operation">
-<parameter_description> the #GtkPrintOperation on which the signal was emitted
+<parameter_description> the `GtkPrintOperation` on which the signal was emitted
</parameter_description>
</parameter>
<parameter name="context">
-<parameter_description> the #GtkPrintContext for the current operation
+<parameter_description> the `GtkPrintContext` for the current operation
</parameter_description>
</parameter>
<parameter name="page_nr">
@@ -10817,7 +12030,7 @@ done to @setup will be in force only for printing this page.
</parameter_description>
</parameter>
<parameter name="setup">
-<parameter_description> the #GtkPageSetup
+<parameter_description> the `GtkPageSetup`
</parameter_description>
</parameter>
</parameters>
@@ -10827,14 +12040,15 @@ done to @setup will be in force only for printing this page.
<signal name="GtkPrintOperation::status-changed">
<description>
Emitted at between the various phases of the print operation.
-See #GtkPrintStatus for the phases that are being discriminated.
-Use gtk_print_operation_get_status() to find out the current
+
+See [enum@Gtk.PrintStatus] for the phases that are being discriminated.
+Use [method@Gtk.PrintOperation.get_status] to find out the current
status.
</description>
<parameters>
<parameter name="operation">
-<parameter_description> the #GtkPrintOperation on which the signal was emitted
+<parameter_description> the `GtkPrintOperation` on which the signal was emitted
</parameter_description>
</parameter>
</parameters>
@@ -10843,18 +12057,19 @@ status.
<signal name="GtkPrintOperation::update-custom-widget">
<description>
-Emitted after change of selected printer. The actual page setup and
-print settings are passed to the custom widget, which can actualize
-itself according to this change.
+Emitted after change of selected printer.
+
+The actual page setup and print settings are passed to the custom
+widget, which can actualize itself according to this change.
</description>
<parameters>
<parameter name="operation">
-<parameter_description> the #GtkPrintOperation on which the signal was emitted
+<parameter_description> the `GtkPrintOperation` on which the signal was emitted
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> the custom widget added in create-custom-widget
+<parameter_description> the custom widget added in ::create-custom-widget
</parameter_description>
</parameter>
<parameter name="setup">
@@ -10875,11 +12090,11 @@ Determines whether the print operation may run asynchronously or not.
Some systems don't support asynchronous printing, but those that do
will return %GTK_PRINT_OPERATION_RESULT_IN_PROGRESS as the status, and
-emit the #GtkPrintOperation::done signal when the operation is actually
-done.
+emit the [signal@Gtk.PrintOperation::done] signal when the operation
+is actually done.
-The Windows port does not support asynchronous operation at all (this
-is unlikely to change). On other platforms, all actions except for
+The Windows port does not support asynchronous operation at all (this
+is unlikely to change). On other platforms, all actions except for
%GTK_PRINT_OPERATION_ACTION_EXPORT support asynchronous operation.
</description>
@@ -10889,7 +12104,7 @@ is unlikely to change). On other platforms, all actions except for
<description>
The current page in the document.
-If this is set before gtk_print_operation_run(),
+If this is set before [method Gtk PrintOperation run],
the user will be able to select to print only the current page.
Note that this only makes sense for pre-paginated documents.
@@ -10900,6 +12115,7 @@ Note that this only makes sense for pre-paginated documents.
<property name="GtkPrintOperation:custom-tab-label">
<description>
Used as the label of the tab containing custom widgets.
+
Note that this property may be ignored on some platforms.
If this is %NULL, GTK uses a default label.
@@ -10909,32 +12125,34 @@ If this is %NULL, GTK uses a default label.
<property name="GtkPrintOperation:default-page-setup">
<description>
-The #GtkPageSetup used by default.
+The `GtkPageSetup` used by default.
-This page setup will be used by gtk_print_operation_run(),
+This page setup will be used by [method Gtk PrintOperation run],
but it can be overridden on a per-page basis by connecting
-to the #GtkPrintOperation::request-page-setup signal.
+to the [signal@Gtk.PrintOperation::request-page-setup] signal.
</description>
</property>
<property name="GtkPrintOperation:embed-page-setup">
<description>
-If %TRUE, page size combo box and orientation combo box are embedded into page setup page.
+If %TRUE, page size combo box and orientation combo box
+are embedded into page setup page.
</description>
</property>
<property name="GtkPrintOperation:export-filename">
<description>
-The name of a file to generate instead of showing the print dialog.
+The name of a file to generate instead of showing the print dialog.
+
Currently, PDF is the only supported format.
-The intended use of this property is for implementing
+The intended use of this property is for implementing
“Export to PDF” actions.
“Print to PDF” support is independent of this and is done
-by letting the user pick the “Print to PDF” item from the
+by letting the user pick the “Print to PDF” item from the
list of printers in the print dialog.
</description>
@@ -10943,6 +12161,7 @@ list of printers in the print dialog.
<property name="GtkPrintOperation:has-selection">
<description>
Determines whether there is a selection in your application.
+
This can allow your application to print the selection.
This is typically used to make a "Selection" button sensitive.
@@ -10951,10 +12170,10 @@ This is typically used to make a "Selection" button sensitive.
<property name="GtkPrintOperation:job-name">
<description>
-A string used to identify the job (e.g. in monitoring
-applications like eggcups).
+A string used to identify the job (e.g. in monitoring
+applications like eggcups).
-If you don't set a job name, GTK picks a default one
+If you don't set a job name, GTK picks a default one
by numbering successive print jobs.
</description>
@@ -10962,16 +12181,16 @@ by numbering successive print jobs.
<property name="GtkPrintOperation:n-pages">
<description>
-The number of pages in the document.
+The number of pages in the document.
-This must be set to a positive number
-before the rendering starts. It may be set in a
-#GtkPrintOperation::begin-print signal handler.
+This must be set to a positive number before the rendering
+starts. It may be set in a [signal@Gtk.PrintOperation::begin-print]
+signal handler.
-Note that the page numbers passed to the
-#GtkPrintOperation::request-page-setup and
-#GtkPrintOperation::draw-page signals are 0-based, i.e. if
-the user chooses to print all pages, the last ::draw-page signal
+Note that the page numbers passed to the
+[signal@Gtk.PrintOperation::request-page-setup] and
+[signal@Gtk.PrintOperation::draw-page] signals are 0-based, i.e.
+if the user chooses to print all pages, the last ::draw-page signal
will be for page @n_pages - 1.
</description>
@@ -10984,9 +12203,10 @@ The number of pages that will be printed.
Note that this value is set during print preparation phase
(%GTK_PRINT_STATUS_PREPARING), so this value should never be
get before the data generation phase (%GTK_PRINT_STATUS_GENERATING_DATA).
-You can connect to the #GtkPrintOperation::status-changed signal
-and call gtk_print_operation_get_n_pages_to_print() when
+You can connect to the [signal@Gtk.PrintOperation::status-changed] signal
+and call [method@Gtk.PrintOperation.get_n_pages_to_print] when
print status is %GTK_PRINT_STATUS_GENERATING_DATA.
+
This is typically used to track the progress of print operation.
</description>
@@ -10994,18 +12214,18 @@ This is typically used to track the progress of print operation.
<property name="GtkPrintOperation:print-settings">
<description>
-The #GtkPrintSettings used for initializing the dialog.
+The `GtkPrintSettings` used for initializing the dialog.
-Setting this property is typically used to re-establish
-print settings from a previous print operation, see
-gtk_print_operation_run().
+Setting this property is typically used to re-establish
+print settings from a previous print operation, see
+[method Gtk PrintOperation run].
</description>
</property>
<property name="GtkPrintOperation:show-progress">
<description>
-Determines whether to show a progress dialog during the
+Determines whether to show a progress dialog during the
print operation.
</description>
@@ -11020,12 +12240,13 @@ The status of the print operation.
<property name="GtkPrintOperation:status-string">
<description>
-A string representation of the status of the print operation.
-The string is translated and suitable for displaying the print
-status e.g. in a #GtkStatusbar.
+A string representation of the status of the print operation.
-See the #GtkPrintOperation:status property for a status value that
-is suitable for programmatic use.
+The string is translated and suitable for displaying the print
+status e.g. in a `GtkStatusbar`.
+
+See the [property@Gtk.PrintOperation:status] property for a status
+value that is suitable for programmatic use.
</description>
</property>
@@ -11033,6 +12254,7 @@ is suitable for programmatic use.
<property name="GtkPrintOperation:support-selection">
<description>
If %TRUE, the print operation will support print of selection.
+
This allows the print dialog to show a "Selection" button.
</description>
@@ -11040,11 +12262,12 @@ This allows the print dialog to show a "Selection" button.
<property name="GtkPrintOperation:track-print-status">
<description>
-If %TRUE, the print operation will try to continue report on
-the status of the print job in the printer queues and printer.
-This can allow your application to show things like “out of paper”
-issues, and when the print job actually reaches the printer.
-However, this is often implemented using polling, and should
+If %TRUE, the print operation will try to continue report on
+the status of the print job in the printer queues and printer.
+
+This can allow your application to show things like “out of paper”
+issues, and when the print job actually reaches the printer.
+However, this is often implemented using polling, and should
not be enabled unless needed.
</description>
@@ -11053,7 +12276,7 @@ not be enabled unless needed.
<property name="GtkPrintOperation:unit">
<description>
The transformation for the cairo context obtained from
-#GtkPrintContext is set up in such a way that distances
+`GtkPrintContext` is set up in such a way that distances
are measured in units of @unit.
</description>
@@ -11061,20 +12284,23 @@ are measured in units of @unit.
<property name="GtkPrintOperation:use-full-page">
<description>
-If %TRUE, the transformation for the cairo context obtained
-from #GtkPrintContext puts the origin at the top left corner
-of the page (which may not be the top left corner of the sheet,
-depending on page orientation and the number of pages per sheet).
-Otherwise, the origin is at the top left corner of the imageable
-area (i.e. inside the margins).
+If %TRUE, the transformation for the cairo context obtained
+from `GtkPrintContext` puts the origin at the top left corner
+of the page.
+
+This may not be the top left corner of the sheet, depending on
+page orientation and the number of pages per sheet. Otherwise,
+the origin is at the top left corner of the imageable area (i.e.
+inside the margins).
</description>
</property>
<enum name="GtkPrintOperationAction">
<description>
-The @action parameter to gtk_print_operation_run()
-determines what action the print operation should perform.
+Determines what action the print operation should perform.
+
+A parameter of this typs is passed to [method Gtk PrintOperation run].
</description>
<parameters>
@@ -11101,12 +12327,11 @@ the export-filename property to be set.
<signal name="GtkPrintOperationPreview::got-page-size">
<description>
-The ::got-page-size signal is emitted once for each page
-that gets rendered to the preview.
+Emitted once for each page that gets rendered to the preview.
A handler for this signal should update the @context
according to @page_setup and set up a suitable cairo
-context, using gtk_print_context_set_cairo_context().
+context, using [method@Gtk.PrintContext.set_cairo_context].
</description>
<parameters>
@@ -11115,11 +12340,11 @@ context, using gtk_print_context_set_cairo_context().
</parameter_description>
</parameter>
<parameter name="context">
-<parameter_description> the current #GtkPrintContext
+<parameter_description> the current `GtkPrintContext`
</parameter_description>
</parameter>
<parameter name="page_setup">
-<parameter_description> the #GtkPageSetup for the current page
+<parameter_description> the `GtkPageSetup` for the current page
</parameter_description>
</parameter>
</parameters>
@@ -11149,7 +12374,9 @@ A handler for this signal can be used for setup tasks.
<enum name="GtkPrintOperationResult">
<description>
-A value of this type is returned by gtk_print_operation_run().
+The result of a print operation.
+
+A value of this type is returned by [method Gtk PrintOperation run].
</description>
<parameters>
@@ -11276,11 +12503,69 @@ printing, e.g. a paper jam.
</parameters>
</enum>
+<property name="GtkPrintUnixDialog:current-page">
+<description>
+The current page in the document.
+
+</description>
+</property>
+
+<property name="GtkPrintUnixDialog:embed-page-setup">
+<description>
+%TRUE if the page setup controls are embedded.
+
+</description>
+</property>
+
+<property name="GtkPrintUnixDialog:has-selection">
+<description>
+Whether the application has a selection.
+
+</description>
+</property>
+
+<property name="GtkPrintUnixDialog:manual-capabilities">
+<description>
+Capabilities the application can handle.
+
+</description>
+</property>
+
+<property name="GtkPrintUnixDialog:page-setup">
+<description>
+The `GtkPageSetup` object to use.
+
+</description>
+</property>
+
+<property name="GtkPrintUnixDialog:print-settings">
+<description>
+The `GtkPrintSettings` object used for this dialog.
+
+</description>
+</property>
+
+<property name="GtkPrintUnixDialog:selected-printer">
+<description>
+The `GtkPrinter` which is selected.
+
+</description>
+</property>
+
+<property name="GtkPrintUnixDialog:support-selection">
+<description>
+Whether the dialog supports selection.
+
+</description>
+</property>
+
<signal name="GtkPrinter::details-acquired">
<description>
-Gets emitted in response to a request for detailed information
-about a printer from the print backend. The @success parameter
-indicates if the information was actually obtained.
+Emitted in response to a request for detailed information
+about a printer from the print backend.
+
+The @success parameter indicates if the information was
+actually obtained.
</description>
<parameters>
@@ -11298,30 +12583,116 @@ indicates if the information was actually obtained.
<property name="GtkPrinter:accepting-jobs">
<description>
-This property is %TRUE if the printer is accepting jobs.
+%TRUE if the printer is accepting jobs.
+
+</description>
+</property>
+
+<property name="GtkPrinter:accepts-pdf">
+<description>
+%TRUE if this printer can accept PDF.
+
+</description>
+</property>
+
+<property name="GtkPrinter:accepts-ps">
+<description>
+%TRUE if this printer can accept PostScript.
+
+</description>
+</property>
+
+<property name="GtkPrinter:backend">
+<description>
+The backend for the printer.
+
+</description>
+</property>
+
+<property name="GtkPrinter:icon-name">
+<description>
+Icon name to use for the printer.
+
+</description>
+</property>
+
+<property name="GtkPrinter:is-virtual">
+<description>
+%FALSE if this represents a real hardware device.
+
+</description>
+</property>
+
+<property name="GtkPrinter:job-count">
+<description>
+Number of jobs queued in the printer.
+
+</description>
+</property>
+
+<property name="GtkPrinter:location">
+<description>
+Information about the location of the printer.
+
+</description>
+</property>
+
+<property name="GtkPrinter:name">
+<description>
+The name of the printer.
</description>
</property>
<property name="GtkPrinter:paused">
<description>
-This property is %TRUE if this printer is paused.
-A paused printer still accepts jobs, but it does
+%TRUE if this printer is paused.
+
+A paused printer still accepts jobs, but it does
not print them.
</description>
</property>
+<property name="GtkPrinter:state-message">
+<description>
+String giving the current status of the printer.
+
+</description>
+</property>
+
<property name="GtkProgressBar:ellipsize">
<description>
-The preferred place to ellipsize the string, if the progress bar does
-not have enough room to display the entire string, specified as a
-#PangoEllipsizeMode.
+The preferred place to ellipsize the string.
+
+The text will be ellipsized if the progress bar does not have enough room
+to display the entire string, specified as a `PangoEllipsizeMode`.
Note that setting this property to a value other than
%PANGO_ELLIPSIZE_NONE has the side-effect that the progress bar requests
only enough space to display the ellipsis ("..."). Another means to set a
-progress bar's width is gtk_widget_set_size_request().
+progress bar's width is [method@Gtk.Widget.set_size_request].
+
+</description>
+</property>
+
+<property name="GtkProgressBar:fraction">
+<description>
+The fraction of total work that has been completed.
+
+</description>
+</property>
+
+<property name="GtkProgressBar:inverted">
+<description>
+Invert the direction in which the progress bar grows.
+
+</description>
+</property>
+
+<property name="GtkProgressBar:pulse-step">
+<description>
+The fraction of total progress to move the bounding block when pulsed.
</description>
</property>
@@ -11329,21 +12700,29 @@ progress bar's width is gtk_widget_set_size_request().
<property name="GtkProgressBar:show-text">
<description>
Sets whether the progress bar will show a text in addition
-to the bar itself. The shown text is either the value of
-the #GtkProgressBar:text property or, if that is %NULL,
-the #GtkProgressBar:fraction value, as a percentage.
+to the bar itself.
+
+The shown text is either the value of the [property@Gtk.ProgressBar:text]
+property or, if that is %NULL, the [property@Gtk.ProgressBar:fraction]
+value, as a percentage.
+
+To make a progress bar that is styled and sized suitably for showing text
+(even if the actual text is blank), set [property@Gtk.ProgressBar:show-text]
+to %TRUE and [property@Gtk.ProgressBar:text] to the empty string (not %NULL).
-To make a progress bar that is styled and sized suitably for
-showing text (even if the actual text is blank), set
-#GtkProgressBar:show-text to %TRUE and #GtkProgressBar:text
-to the empty string (not %NULL).
+</description>
+</property>
+
+<property name="GtkProgressBar:text">
+<description>
+Text to be displayed in the progress bar.
</description>
</property>
<enum name="GtkPropagationLimit">
<description>
-Describes limits of a #GtkEventController for handling events
+Describes limits of a `GtkEventController` for handling events
targeting other widgets.
</description>
@@ -11364,7 +12743,7 @@ that some event types have two targets (origin and destination).
<enum name="GtkPropagationPhase">
<description>
-Describes the stage at which events are fed into a #GtkEventController.
+Describes the stage at which events are fed into a `GtkEventController`.
</description>
<parameters>
@@ -11423,7 +12802,7 @@ chance to adjust the bounds.
</description>
<parameters>
<parameter name="range">
-<parameter_description> the #GtkRange that received the signal
+<parameter_description> the `GtkRange` that received the signal
</parameter_description>
</parameter>
<parameter name="value">
@@ -11436,24 +12815,24 @@ chance to adjust the bounds.
<signal name="GtkRange::change-value">
<description>
-The #GtkRange::change-value signal is emitted when a scroll action is
-performed on a range. It allows an application to determine the
-type of scroll event that occurred and the resultant new value.
-The application can handle the event itself and return %TRUE to
-prevent further processing. Or, by returning %FALSE, it can pass
-the event to other handlers until the default GTK handler is
-reached.
+Emitted when a scroll action is performed on a range.
-The value parameter is unrounded. An application that overrides
-the GtkRange::change-value signal is responsible for clamping the
-value to the desired number of decimal digits; the default GTK
-handler clamps the value based on #GtkRange:round-digits.
+It allows an application to determine the type of scroll event
+that occurred and the resultant new value. The application can
+handle the event itself and return %TRUE to prevent further
+processing. Or, by returning %FALSE, it can pass the event to
+other handlers until the default GTK handler is reached.
+
+The value parameter is unrounded. An application that overrides
+the ::change-value signal is responsible for clamping the value
+to the desired number of decimal digits; the default GTK
+handler clamps the value based on [property@Gtk.Range:round-digits].
</description>
<parameters>
<parameter name="range">
-<parameter_description> the #GtkRange that received the signal
+<parameter_description> the `GtkRange` that received the signal
</parameter_description>
</parameter>
<parameter name="scroll">
@@ -11472,12 +12851,14 @@ the signal, %FALSE to propagate the signal further
<signal name="GtkRange::move-slider">
<description>
-Virtual function that moves the slider. Used for keybindings.
+Virtual function that moves the slider.
+
+Used for keybindings.
</description>
<parameters>
<parameter name="range">
-<parameter_description> the #GtkRange that received the signal
+<parameter_description> the `GtkRange` that received the signal
</parameter_description>
</parameter>
<parameter name="step">
@@ -11495,26 +12876,38 @@ Emitted when the range value changes.
</description>
<parameters>
<parameter name="range">
-<parameter_description> the #GtkRange that received the signal
+<parameter_description> the `GtkRange` that received the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
</signal>
+<property name="GtkRange:adjustment">
+<description>
+The adjustment that is controlled by the range.
+
+</description>
+</property>
+
<property name="GtkRange:fill-level">
<description>
The fill level (e.g. prebuffering of a network stream).
-See gtk_range_set_fill_level().
+
+</description>
+</property>
+
+<property name="GtkRange:inverted">
+<description>
+If %TRUE, the direction in which the slider moves is inverted.
</description>
</property>
<property name="GtkRange:restrict-to-fill-level">
<description>
-The restrict-to-fill-level property controls whether slider
-movement is restricted to an upper boundary set by the
-fill level. See gtk_range_set_restrict_to_fill_level().
+Controls whether slider movement is restricted to an
+upper boundary set by the fill level.
</description>
</property>
@@ -11522,16 +12915,17 @@ fill level. See gtk_range_set_restrict_to_fill_level().
<property name="GtkRange:round-digits">
<description>
The number of digits to round the value to when
-it changes, or -1. See #GtkRange::change-value.
+it changes.
+
+See [signal@Gtk.Range::change-value].
</description>
</property>
<property name="GtkRange:show-fill-level">
<description>
-The show-fill-level property controls whether fill level indicator
-graphics are displayed on the trough. See
-gtk_range_set_show_fill_level().
+Controls whether fill level indicator graphics are displayed
+on the trough.
</description>
</property>
@@ -11539,8 +12933,10 @@ gtk_range_set_show_fill_level().
<signal name="GtkRecentManager::changed">
<description>
Emitted when the current recently used resources manager changes
-its contents, either by calling gtk_recent_manager_add_item() or
-by another application.
+its contents.
+
+This can happen either by calling [method@Gtk.RecentManager.add_item]
+or by another application.
</description>
<parameters>
@@ -11612,6 +13008,7 @@ resources file.
<enum name="GtkResponseType">
<description>
Predefined values for use as response ids in gtk_dialog_add_button().
+
All predefined values are negative; GTK leaves values of 0 or greater for
application-defined response ids.
@@ -11665,10 +13062,45 @@ or if the dialog gets programmatically hidden or destroyed
</parameters>
</enum>
+<property name="GtkRevealer:child">
+<description>
+The child widget.
+
+</description>
+</property>
+
+<property name="GtkRevealer:child-revealed">
+<description>
+Whether the child is revealed and the animation target reached.
+
+</description>
+</property>
+
+<property name="GtkRevealer:reveal-child">
+<description>
+Whether the revealer should reveal the child.
+
+</description>
+</property>
+
+<property name="GtkRevealer:transition-duration">
+<description>
+The animation duration, in milliseconds.
+
+</description>
+</property>
+
+<property name="GtkRevealer:transition-type">
+<description>
+The type of animation used to transition.
+
+</description>
+</property>
+
<enum name="GtkRevealerTransitionType">
<description>
These enumeration values describe the possible transitions
-when the child of a #GtkRevealer widget is shown or hidden.
+when the child of a `GtkRevealer` widget is shown or hidden.
</description>
<parameters>
@@ -11715,13 +13147,41 @@ when the child of a #GtkRevealer widget is shown or hidden.
</parameters>
</enum>
+<property name="GtkScale:digits">
+<description>
+The number of decimal places that are displayed in the value.
+
+</description>
+</property>
+
+<property name="GtkScale:draw-value">
+<description>
+Whether the current value is displayed as a string next to the slider.
+
+</description>
+</property>
+
+<property name="GtkScale:has-origin">
+<description>
+Whether the scale has an origin.
+
+</description>
+</property>
+
+<property name="GtkScale:value-pos">
+<description>
+The position in which the current value is displayed.
+
+</description>
+</property>
+
<signal name="GtkScaleButton::popdown">
<description>
-The ::popdown signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to popdown the scale widget.
+Emitted to dismiss the popup.
-The default binding for this signal is Escape.
+This is a [keybinding signal](class.SignalAction.html).
+
+The default binding for this signal is <kbd>Escape</kbd>.
</description>
<parameters>
@@ -11735,11 +13195,12 @@ The default binding for this signal is Escape.
<signal name="GtkScaleButton::popup">
<description>
-The ::popup signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to popup the scale widget.
+Emitted to popup the scale widget.
+
+This is a [keybinding signal](class.SignalAction.html).
-The default bindings for this signal are Space, Enter and Return.
+The default bindings for this signal are <kbd>Space</kbd>,
+<kbd>Enter</kbd> and <kbd>Return</kbd>.
</description>
<parameters>
@@ -11753,8 +13214,7 @@ The default bindings for this signal are Space, Enter and Return.
<signal name="GtkScaleButton::value-changed">
<description>
-The ::value-changed signal is emitted when the value field has
-changed.
+Emitted when the value field has changed.
</description>
<parameters>
@@ -11770,9 +13230,17 @@ changed.
<return></return>
</signal>
+<property name="GtkScaleButton:adjustment">
+<description>
+The `GtkAdjustment` that is used as the model.
+
+</description>
+</property>
+
<property name="GtkScaleButton:icons">
<description>
The names of the icons to be used by the scale button.
+
The first item in the array will be used in the button
when the current value is the lowest value, the second
item for the highest value. All the subsequent icons will
@@ -11791,19 +13259,16 @@ better for the users.
</description>
</property>
-<property name="GtkScaleButton:orientation">
+<property name="GtkScaleButton:value">
<description>
-The orientation of the #GtkScaleButton's popup window.
-
-Note that #GtkScaleButton implements the #GtkOrientable interface
-which has its own @orientation property. However, we redefine the
-property here in order to override its default horizontal orientation.
+The value of the scale.
</description>
</property>
<enum name="GtkScrollStep">
<description>
+Passed as argument to various keybinding signals.
</description>
<parameters>
@@ -11909,32 +13374,32 @@ Scrolling types.
<property name="GtkScrollable:hadjustment">
<description>
-Horizontal #GtkAdjustment of the scrollable widget. This adjustment is
-shared between the scrollable widget and its parent.
+Horizontal `GtkAdjustment` of the scrollable widget.
+
+This adjustment is shared between the scrollable widget and its parent.
</description>
</property>
<property name="GtkScrollable:hscroll-policy">
<description>
-Determines whether horizontal scrolling should start once the scrollable
-widget is allocated less than its minimum width or less than its natural width.
+Determines when horizontal scrolling should start.
</description>
</property>
<property name="GtkScrollable:vadjustment">
<description>
-Vertical #GtkAdjustment of the scrollable widget. This adjustment is shared
-between the scrollable widget and its parent.
+Vertical `GtkAdjustment` of the scrollable widget.
+
+This adjustment is shared between the scrollable widget and its parent.
</description>
</property>
<property name="GtkScrollable:vscroll-policy">
<description>
-Determines whether vertical scrolling should start once the scrollable
-widget is allocated less than its minimum height or less than its natural height.
+Determines when vertical scrolling should start.
</description>
</property>
@@ -11957,22 +13422,43 @@ the scrolled window adjustments in a given orientation.
</parameters>
</enum>
+<property name="GtkScrollbar:adjustment">
+<description>
+The `GtkAdjustment` controlled by this scrollbar.
+
+</description>
+</property>
+
+<property name="GtkScrolleWindow:hadjustment">
+<description>
+The `GtkAdjustment` for the horizontal position.
+
+</description>
+</property>
+
+<property name="GtkScrolleWindow:vadjustment">
+<description>
+The `GtkAdjustment` for the vertical position.
+
+</description>
+</property>
+
<signal name="GtkScrolledWindow::edge-overshot">
<description>
-The ::edge-overshot signal is emitted whenever user initiated scrolling
-makes the scrolled window firmly surpass (i.e. with some edge resistance)
-the lower or upper limits defined by the adjustment in that orientation.
+Emitted whenever user initiated scrolling makes the scrolled
+window firmly surpass the limits defined by the adjustment
+in that orientation.
A similar behavior without edge resistance is provided by the
-#GtkScrolledWindow::edge-reached signal.
+[signal@Gtk.ScrolledWindow::edge-reached] signal.
-Note: The @pos argument is LTR/RTL aware, so callers should be aware too
-if intending to provide behavior on horizontal edges.
+Note: The @pos argument is LTR/RTL aware, so callers should be
+aware too if intending to provide behavior on horizontal edges.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="pos">
@@ -11985,20 +13471,20 @@ if intending to provide behavior on horizontal edges.
<signal name="GtkScrolledWindow::edge-reached">
<description>
-The ::edge-reached signal is emitted whenever user-initiated scrolling
-makes the scrolled window exactly reach the lower or upper limits
-defined by the adjustment in that orientation.
+Emitted whenever user-initiated scrolling makes the scrolled
+window exactly reach the lower or upper limits defined by the
+adjustment in that orientation.
A similar behavior with edge resistance is provided by the
-#GtkScrolledWindow::edge-overshot signal.
+[signal@Gtk.ScrolledWindow::edge-overshot] signal.
-Note: The @pos argument is LTR/RTL aware, so callers should be aware too
-if intending to provide behavior on horizontal edges.
+Note: The @pos argument is LTR/RTL aware, so callers should be
+aware too if intending to provide behavior on horizontal edges.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="pos">
@@ -12011,18 +13497,19 @@ if intending to provide behavior on horizontal edges.
<signal name="GtkScrolledWindow::move-focus-out">
<description>
-The ::move-focus-out signal is a
-[keybinding signal][GtkSignalAction] which gets
-emitted when focus is moved away from the scrolled window by a
-keybinding. The #GtkWidget::move-focus signal is emitted with
-@direction_type on this scrolled window’s toplevel parent in the
-container hierarchy. The default bindings for this signal are
-`Ctrl + Tab` to move forward and `Ctrl + Shift + Tab` to move backward.
+Emitted when focus is moved away from the scrolled window by a
+keybinding.
+
+This is a [keybinding signal](class.SignalAction.html).
+
+The default bindings for this signal are
+`Ctrl + Tab` to move forward and `Ctrl + Shift + Tab` to
+move backward.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="direction_type">
@@ -12036,20 +13523,21 @@ container hierarchy. The default bindings for this signal are
<signal name="GtkScrolledWindow::scroll-child">
<description>
-The ::scroll-child signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when a keybinding that scrolls is pressed.
+Emitted when a keybinding that scrolls is pressed.
+
+This is a [keybinding signal](class.SignalAction.html).
+
The horizontal or vertical adjustment is updated which triggers a
signal that the scrolled window’s child may listen to and scroll itself.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="scroll">
-<parameter_description> a #GtkScrollType describing how much to scroll
+<parameter_description> a `GtkScrollType` describing how much to scroll
</parameter_description>
</parameter>
<parameter name="horizontal">
@@ -12061,51 +13549,77 @@ horizontally or not
<return></return>
</signal>
+<property name="GtkScrolledWindow:child">
+<description>
+The child widget.
+
+</description>
+</property>
+
+<property name="GtkScrolledWindow:has-frame">
+<description>
+Whether to draw a frame around the contents.
+
+</description>
+</property>
+
+<property name="GtkScrolledWindow:hscrollbar-policy">
+<description>
+When the horizontal scrollbar is displayed.
+
+Use [method@Gtk.ScrolledWindow.set_policy] to set
+this property.
+
+</description>
+</property>
+
<property name="GtkScrolledWindow:kinetic-scrolling">
<description>
-Whether kinetic scrolling is enabled or not. Kinetic scrolling
-only applies to devices with source %GDK_SOURCE_TOUCHSCREEN.
+Whether kinetic scrolling is enabled or not.
+
+Kinetic scrolling only applies to devices with source %GDK_SOURCE_TOUCHSCREEN.
</description>
</property>
<property name="GtkScrolledWindow:max-content-height">
<description>
-The maximum content height of @scrolled_window, or -1 if not set.
+The maximum content height of @scrolled_window.
</description>
</property>
<property name="GtkScrolledWindow:max-content-width">
<description>
-The maximum content width of @scrolled_window, or -1 if not set.
+The maximum content width of @scrolled_window.
</description>
</property>
<property name="GtkScrolledWindow:min-content-height">
<description>
-The minimum content height of @scrolled_window, or -1 if not set.
+The minimum content height of @scrolled_window.
</description>
</property>
<property name="GtkScrolledWindow:min-content-width">
<description>
-The minimum content width of @scrolled_window, or -1 if not set.
+The minimum content width of @scrolled_window.
</description>
</property>
<property name="GtkScrolledWindow:overlay-scrolling">
<description>
-Whether overlay scrolling is enabled or not. If it is, the
-scrollbars are only added as traditional widgets when a mouse
-is present. Otherwise, they are overlaid on top of the content,
-as narrow indicators.
+Whether overlay scrolling is enabled or not.
+
+If it is, the scrollbars are only added as traditional widgets
+when a mouse is present. Otherwise, they are overlaid on top of
+the content, as narrow indicators.
Note that overlay scrolling can also be globally disabled, with
-the #GtkSettings:gtk-overlay-scrolling setting.
+the [property@Gtk.Settings:gtk-overlay-scrolling] setting.
</description>
</property>
@@ -12132,12 +13646,41 @@ enough space for the natural size of the child.
</description>
</property>
+<property name="GtkScrolledWindow:vscrollbar-policy">
+<description>
+When the vertical scrollbar is displayed.
+
+Use [method@Gtk.ScrolledWindow.set_policy] to set
+this property.
+
+</description>
+</property>
+
+<property name="GtkScrolledWindow:window-placement">
+<description>
+Where the contents are located with respect to the scrollbars.
+
+</description>
+</property>
+
+<property name="GtkSearchBar:child">
+<description>
+The child widget.
+
+</description>
+</property>
+
+<property name="GtkSearchBar:key-capture-widget">
+<description>
+The key capture widget.
+
+</description>
+</property>
+
<property name="GtkSearchBar:search-mode-enabled">
<description>
Whether the search mode is on and the search bar shown.
-See gtk_search_bar_set_search_mode() for details.
-
</description>
</property>
@@ -12150,9 +13693,9 @@ Whether to show the close button in the search bar.
<signal name="GtkSearchEntry::activate">
<description>
-The ::activate signal is forwarded from the
-#GtkText::activated signal, which is a keybinding
-signal for all forms of the Enter key.
+Emitted when the entry is activated.
+
+The keybindings for this signal are all forms of the Enter key.
</description>
<parameters>
@@ -12166,12 +13709,13 @@ signal for all forms of the Enter key.
<signal name="GtkSearchEntry::next-match">
<description>
-The ::next-match signal is a [keybinding signal][GtkSignalAction]
-which gets emitted when the user initiates a move to the next match
+Emitted when the user initiates a move to the next match
for the current search string.
-Applications should connect to it, to implement moving between
-matches.
+This is a [keybinding signal](class.SignalAction.html).
+
+Applications should connect to it, to implement moving
+between matches.
The default bindings for this signal is Ctrl-g.
@@ -12187,12 +13731,13 @@ The default bindings for this signal is Ctrl-g.
<signal name="GtkSearchEntry::previous-match">
<description>
-The ::previous-match signal is a [keybinding signal][GtkSignalAction]
-which gets emitted when the user initiates a move to the previous match
+Emitted when the user initiates a move to the previous match
for the current search string.
-Applications should connect to it, to implement moving between
-matches.
+This is a [keybinding signal](class.SignalAction.html).
+
+Applications should connect to it, to implement moving
+between matches.
The default bindings for this signal is Ctrl-Shift-g.
@@ -12208,8 +13753,8 @@ The default bindings for this signal is Ctrl-Shift-g.
<signal name="GtkSearchEntry::search-changed">
<description>
-The #GtkSearchEntry::search-changed signal is emitted with a short
-delay of 150 milliseconds after the last change to the entry text.
+Emitted with a short delay of 150 milliseconds after the
+last change to the entry text.
</description>
<parameters>
@@ -12223,8 +13768,7 @@ delay of 150 milliseconds after the last change to the entry text.
<signal name="GtkSearchEntry::search-started">
<description>
-The ::search-started signal gets emitted when the user initiated
-a search on the entry.
+Emitted when the user initiated a search on the entry.
</description>
<parameters>
@@ -12238,11 +13782,12 @@ a search on the entry.
<signal name="GtkSearchEntry::stop-search">
<description>
-The ::stop-search signal is a [keybinding signal][GtkSignalAction]
-which gets emitted when the user stops a search via keyboard input.
+Emitted when the user stops a search via keyboard input.
+
+This is a [keybinding signal](class.SignalAction.html).
-Applications should connect to it, to implement hiding the search
-entry in this case.
+Applications should connect to it, to implement hiding
+the search entry in this case.
The default bindings for this signal is Escape.
@@ -12256,9 +13801,24 @@ The default bindings for this signal is Escape.
<return></return>
</signal>
+<property name="GtkSearchEntry:activates-default">
+<description>
+Whether to activate the default widget when Enter is pressed.
+
+</description>
+</property>
+
+<property name="GtkSearchEntry:placeholder-text">
+<description>
+The text that will be displayed in the `GtkSearchEntry`
+when it is empty and unfocused.
+
+</description>
+</property>
+
<property name="GtkSelectionFilterModel:model">
<description>
-The model being filtered
+The model being filtered.
</description>
</property>
@@ -12300,16 +13860,15 @@ Some widgets may also allow Click-drag to select a range of elements.
<description>
Emitted when the selection state of some of the items in @model changes.
-Note that this signal does not specify the new selection state of the items,
-they need to be queried manually.
-It is also not necessary for a model to change the selection state of any of
-the items in the selection model, though it would be rather useless to emit
-such a signal.
+Note that this signal does not specify the new selection state of the
+items, they need to be queried manually. It is also not necessary for
+a model to change the selection state of any of the items in the selection
+model, though it would be rather useless to emit such a signal.
</description>
<parameters>
<parameter name="model">
-<parameter_description> a #GtkSelectionModel
+<parameter_description> a `GtkSelectionModel`
</parameter_description>
</parameter>
<parameter name="position">
@@ -12347,10 +13906,26 @@ action can be triggered
</parameters>
</enum>
+<property name="GtkSettings:gkt-entry-select-on-focus">
+<description>
+Whether to select the contents of an entry when it is focused.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-alternative-button-order">
+<description>
+Whether buttons in dialogs should use the alternative button order.
+
+</description>
+</property>
+
<property name="GtkSettings:gtk-alternative-sort-arrows">
<description>
Controls the direction of the sort indicators in sorted list and tree
-views. By default an arrow pointing down means the column is sorted
+views.
+
+By default an arrow pointing down means the column is sorted
in ascending order. When set to %TRUE, this order will be inverted.
</description>
@@ -12358,17 +13933,27 @@ in ascending order. When set to %TRUE, this order will be inverted.
<property name="GtkSettings:gtk-application-prefer-dark-theme">
<description>
-Whether the application prefers to use a dark theme. If a GTK theme
-includes a dark variant, it will be used instead of the configured
-theme.
+Whether the application prefers to use a dark theme.
+
+If a GTK theme includes a dark variant, it will be used
+instead of the configured theme.
+
+Some applications benefit from minimizing the amount of light
+pollution that interferes with the content. Good candidates for
+dark themes are photo and video editors that make the actual
+content get all the attention and minimize the distraction of
+the chrome.
+
+Dark themes should not be used for documents, where large spaces
+are white/light and the dark chrome creates too much contrast
+(web browser, text editor...).
-Some applications benefit from minimizing the amount of light pollution that
-interferes with the content. Good candidates for dark themes are photo and
-video editors that make the actual content get all the attention and minimize
-the distraction of the chrome.
+</description>
+</property>
-Dark themes should not be used for documents, where large spaces are white/light
-and the dark chrome creates too much contrast (web browser, text editor...).
+<property name="GtkSettings:gtk-cursor-aspect-ratio">
+<description>
+The aspect ratio of the text caret.
</description>
</property>
@@ -12377,26 +13962,52 @@ and the dark chrome creates too much contrast (web browser, text editor...).
<description>
Whether the cursor should blink.
-Also see the #GtkSettings:gtk-cursor-blink-timeout setting,
+Also see the [property@Gtk.Settings:gtk-cursor-blink-timeout] setting,
which allows more flexible control over cursor blinking.
</description>
</property>
+<property name="GtkSettings:gtk-cursor-blink-time">
+<description>
+Length of the cursor blink cycle, in milliseconds.
+
+</description>
+</property>
+
<property name="GtkSettings:gtk-cursor-blink-timeout">
<description>
Time after which the cursor stops blinking, in seconds.
+
The timer is reset after each user interaction.
Setting this to zero has the same effect as setting
-#GtkSettings:gtk-cursor-blink to %FALSE.
+[property@Gtk.Settings:gtk-cursor-blink] to %FALSE.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-cursor-theme-name">
+<description>
+Name of the cursor theme to use.
+
+Use %NULL to use the default theme.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-cursor-theme-size">
+<description>
+The size to use for cursors.
+
+0 means to use the default size.
</description>
</property>
<property name="GtkSettings:gtk-decoration-layout">
<description>
-This setting determines which buttons should be put in the
+Determines which buttons should be put in the
titlebar of client-side decorated windows, and whether they
should be placed at the left of right.
@@ -12415,7 +14026,7 @@ show the app menu, and a close button only appears on a window
that can be closed.
Also note that the setting can be overridden with the
-#GtkHeaderBar:decoration-layout property.
+[property@Gtk.HeaderBar:decoration-layout] property.
</description>
</property>
@@ -12426,12 +14037,35 @@ Whether builtin GTK dialogs such as the file chooser, the
color chooser or the font chooser will use a header bar at
the top to show action widgets, or an action area at the bottom.
-This setting does not affect custom dialogs using GtkDialog
+This setting does not affect custom dialogs using `GtkDialog`
directly, or message dialogs.
</description>
</property>
+<property name="GtkSettings:gtk-dnd-drag-threshold">
+<description>
+The number of pixels the cursor can move before dragging.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-double-click-distance">
+<description>
+The maximum distance allowed between two clicks for them to be considered
+a double click, in pixels.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-double-click-time">
+<description>
+The maximum time to allow between two clicks for them to be considered
+a double click, in milliseconds.
+
+</description>
+</property>
+
<property name="GtkSettings:gtk-enable-accels">
<description>
Whether menu items should have visible accelerators which can be
@@ -12440,6 +14074,13 @@ activated.
</description>
</property>
+<property name="GtkSettings:gtk-enable-animations">
+<description>
+Whether to enable toolkit-wide animations.
+
+</description>
+</property>
+
<property name="GtkSettings:gtk-enable-event-sounds">
<description>
Whether to play any event sounds at all.
@@ -12477,7 +14118,9 @@ Whether a middle click on a mouse should paste the
<property name="GtkSettings:gtk-entry-password-hint-timeout">
<description>
How long to show the last input character in hidden
-entries. This value is in milliseconds. 0 disables showing the
+entries.
+
+This value is in milliseconds. 0 disables showing the
last char. 600 is a good value for enabling it.
</description>
@@ -12486,30 +14129,51 @@ last char. 600 is a good value for enabling it.
<property name="GtkSettings:gtk-error-bell">
<description>
When %TRUE, keyboard navigation and other input-related errors
-will cause a beep. Since the error bell is implemented using
-gdk_surface_beep(), the windowing system may offer ways to
-configure the error bell in many ways, such as flashing the
-window or similar visual effects.
+will cause a beep.
+
+Since the error bell is implemented using gdk_surface_beep(), the
+windowing system may offer ways to configure the error bell in many
+ways, such as flashing the window or similar visual effects.
</description>
</property>
<property name="GtkSettings:gtk-font-name">
<description>
-The default font to use. GTK uses the family name and size from this string.
+The default font to use.
+
+GTK uses the family name and size from this string.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-fontconfig-timestamp">
+<description>
+Timestamp of the curent fontconfig configuration.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-icon-theme-name">
+<description>
+Name of the icon theme to use.
+
+See [class@Gtk.IconTheme] for details about how
+GTK handles icon themes.
</description>
</property>
<property name="GtkSettings:gtk-im-module">
<description>
-Which IM (input method) module should be used by default. This is the
-input method that will be used if the user has not explicitly chosen
-another input method from the IM context menu.
+Which IM (input method) module should be used by default.
+
+This is the input method that will be used if the user has not
+explicitly chosen another input method from the IM context menu.
This also can be a colon-separated list of input methods, which GTK
will try in turn until it finds one available on the system.
-See #GtkIMContext.
+See [class@Gtk.IMContext].
</description>
</property>
@@ -12517,15 +14181,26 @@ See #GtkIMContext.
<property name="GtkSettings:gtk-keynav-use-caret">
<description>
Whether GTK should make sure that text can be navigated with
-a caret, even if it is not editable. This is useful when using
-a screen reader.
+a caret, even if it is not editable.
+
+This is useful when using a screen reader.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-label-select-on-focus">
+<description>
+Whether to select the contents of a selectable
+label when it is focused.
</description>
</property>
<property name="GtkSettings:gtk-long-press-time">
<description>
-The time for a button or touch press to be considered a "long press".
+The time for a button or touch press to be considered a “long press”.
+
+See [class@Gtk.GestureLongPress].
</description>
</property>
@@ -12533,6 +14208,7 @@ The time for a button or touch press to be considered a "long press".
<property name="GtkSettings:gtk-overlay-scrolling">
<description>
Whether scrolled windows may use overlaid scrolling indicators.
+
If this is set to %FALSE, scrolled windows will have permanent
scrollbars.
@@ -12543,12 +14219,14 @@ scrollbars.
<description>
If the value of this setting is %TRUE, clicking the primary button in a
#GtkRange trough will move the slider, and hence set the range’s value, to
-the point that you clicked. If it is %FALSE, a primary click will cause the
-slider/value to move by the range’s page-size towards the point clicked.
+the point that you clicked.
+
+If it is %FALSE, a primary click will cause the slider/value to move
+by the range’s page-size towards the point clicked.
Whichever action you choose for the primary button, the other action will
-be available by holding Shift and primary-clicking, or (since GTK 3.22.25)
-clicking the middle mouse button.
+be available by holding Shift and primary-clicking, or clicking the middle
+mouse button.
</description>
</property>
@@ -12556,7 +14234,9 @@ clicking the middle mouse button.
<property name="GtkSettings:gtk-print-backends">
<description>
A comma-separated list of print backends to use in the print
-dialog. Available print backends depend on the GTK installation,
+dialog.
+
+Available print backends depend on the GTK installation,
and may include "file", "cups", "lpr" or "papi".
</description>
@@ -12564,15 +14244,16 @@ and may include "file", "cups", "lpr" or "pap
<property name="GtkSettings:gtk-print-preview-command">
<description>
-A command to run for displaying the print preview. The command
-should contain a `%f` placeholder, which will get replaced by
-the path to the pdf file. The command may also contain a `%s`
-placeholder, which will get replaced by the path to a file
-containing the print settings in the format produced by
-gtk_print_settings_to_file().
+A command to run for displaying the print preview.
-The preview application is responsible for removing the pdf file
-and the print settings file when it is done.
+The command should contain a `%f` placeholder, which will get
+replaced by the path to the pdf file. The command may also
+contain a `%s` placeholder, which will get replaced by the
+path to a file containing the print settings in the format
+produced by [method@Gtk.PrintSettings.to_file].
+
+The preview application is responsible for removing the pdf
+file and the print settings file when it is done.
</description>
</property>
@@ -12580,7 +14261,9 @@ and the print settings file when it is done.
<property name="GtkSettings:gtk-recent-files-enabled">
<description>
Whether GTK should keep track of items inside the recently used
-resources list. If set to %FALSE, the list will always be empty.
+resources list.
+
+If set to %FALSE, the list will always be empty.
</description>
</property>
@@ -12588,9 +14271,35 @@ resources list. If set to %FALSE, the list will always be empty.
<property name="GtkSettings:gtk-recent-files-max-age">
<description>
The maximum age, in days, of the items inside the recently used
-resources list. Items older than this setting will be excised
-from the list. If set to 0, the list will always be empty; if
-set to -1, no item will be removed.
+resources list.
+
+Items older than this setting will be excised from the list.
+If set to 0, the list will always be empty; if set to -1, no
+item will be removed.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-shell-shows-app-menu">
+<description>
+Set to %TRUE if the desktop environment is displaying
+the app menu, %FALSE if the app should display it itself.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-shell-shows-desktop">
+<description>
+Set to %TRUE if the desktop environment is displaying
+the desktop folder, %FALSE if not.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-shell-shows-menubar">
+<description>
+Set to %TRUE if the desktop environment is displaying
+the menubar, %FALSE if the app should display it itself.
</description>
</property>
@@ -12602,15 +14311,33 @@ The XDG sound theme to use for event sounds.
See the [Sound Theme Specifications](http://www.freedesktop.org/wiki/Specifications/sound-theme-spec)
for more information on event sounds and sound themes.
-GTK itself does not support event sounds, you have to use a loadable
-module like the one that comes with libcanberra.
+GTK itself does not support event sounds, you have to use
+a loadable module like the one that comes with libcanberra.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-split-cursor">
+<description>
+Whether two cursors should be displayed for mixed left-to-right and
+right-to-left text.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-theme-name">
+<description>
+Name of the theme to load.
+
+See [class@Gtk.CssProvider] for details about how
+GTK finds the CSS stylesheet for a theme.
</description>
</property>
<property name="GtkSettings:gtk-titlebar-double-click">
<description>
-This setting determines the action to take when a double-click
+Determines the action to take when a double-click
occurs on the titlebar of client-side decorated windows.
Recognized actions are minimize, toggle-maximize, menu, lower
@@ -12621,7 +14348,7 @@ or none.
<property name="GtkSettings:gtk-titlebar-middle-click">
<description>
-This setting determines the action to take when a middle-click
+Determines the action to take when a middle-click
occurs on the titlebar of client-side decorated windows.
Recognized actions are minimize, toggle-maximize, menu, lower
@@ -12632,7 +14359,7 @@ or none.
<property name="GtkSettings:gtk-titlebar-right-click">
<description>
-This setting determines the action to take when a right-click
+Determines the action to take when a right-click
occurs on the titlebar of client-side decorated windows.
Recognized actions are minimize, toggle-maximize, menu, lower
@@ -12641,6 +14368,52 @@ or none.
</description>
</property>
+<property name="GtkSettings:gtk-xft-antialias">
+<description>
+Whether to antialias fonts.
+
+The values are 0 for no, 1 for yes, or -1 for the system default.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-xft-dpi">
+<description>
+The font resolution, in 1024 * dots/inch.
+
+-1 to use the default value.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-xft-hinting">
+<description>
+Whether to enable font hinting.
+
+The values are 0 for no, 1 for yes, or -1 for the system default.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-xft-hintstyle">
+<description>
+What degree of font hinting to use.
+
+The possible vaues are hintnone, hintslight,
+hintmedium, hintfull.
+
+</description>
+</property>
+
+<property name="GtkSettings:gtk-xft-rgba">
+<description>
+The type of subpixel antialiasing to use.
+
+The possible values are none, rgb, bgr, vrgb, vbgr.
+
+</description>
+</property>
+
<property name="GtkShortcut:action">
<description>
The action that gets activated by this shortcut.
@@ -12665,6 +14438,7 @@ The trigger that triggers this shortcut.
<enum name="GtkShortcutActionFlags">
<description>
List of flags that can be passed to action activation.
+
More flags may be added in the future.
</description>
@@ -12687,7 +14461,7 @@ The modifiers that need to be pressed to allow mnemonics activation.
<property name="GtkShortcutController:model">
<description>
-A list model to take shortcuts from
+A list model to take shortcuts from.
</description>
</property>
@@ -12701,7 +14475,9 @@ What scope the shortcuts will be handled in.
<property name="GtkShortcutLabel:accelerator">
<description>
-The accelerator that @self displays. See #GtkShortcutsShortcut:accelerator
+The accelerator that @self displays.
+
+See [property@Gtk.ShortcutsShortcut:accelerator]
for the accepted syntax.
</description>
@@ -12716,8 +14492,8 @@ The text that is displayed when no accelerator is set.
<enum name="GtkShortcutScope">
<description>
-Describes where #GtkShortcuts added to a
-#GtkShortcutController get handled.
+Describes where `GtkShortcut`s added to a
+`GtkShortcutController` get handled.
</description>
<parameters>
@@ -12742,60 +14518,61 @@ the root widget.
<enum name="GtkShortcutType">
<description>
GtkShortcutType specifies the kind of shortcut that is being described.
+
More values may be added to this enumeration over time.
</description>
<parameters>
<parameter name="GTK_SHORTCUT_ACCELERATOR">
<parameter_description>
-The shortcut is a keyboard accelerator. The #GtkShortcutsShortcut:accelerator
+The shortcut is a keyboard accelerator. The GtkShortcutsShortcut:accelerator
property will be used.
</parameter_description>
</parameter>
<parameter name="GTK_SHORTCUT_GESTURE_PINCH">
<parameter_description>
-The shortcut is a pinch gesture. GTK+ provides an icon and subtitle.
+The shortcut is a pinch gesture. GTK provides an icon and subtitle.
</parameter_description>
</parameter>
<parameter name="GTK_SHORTCUT_GESTURE_STRETCH">
<parameter_description>
-The shortcut is a stretch gesture. GTK+ provides an icon and subtitle.
+The shortcut is a stretch gesture. GTK provides an icon and subtitle.
</parameter_description>
</parameter>
<parameter name="GTK_SHORTCUT_GESTURE_ROTATE_CLOCKWISE">
<parameter_description>
-The shortcut is a clockwise rotation gesture. GTK+ provides an icon and subtitle.
+The shortcut is a clockwise rotation gesture. GTK provides an icon and subtitle.
</parameter_description>
</parameter>
<parameter name="GTK_SHORTCUT_GESTURE_ROTATE_COUNTERCLOCKWISE">
<parameter_description>
-The shortcut is a counterclockwise rotation gesture. GTK+ provides an icon and subtitle.
+The shortcut is a counterclockwise rotation gesture. GTK provides an icon and subtitle.
</parameter_description>
</parameter>
<parameter name="GTK_SHORTCUT_GESTURE_TWO_FINGER_SWIPE_LEFT">
<parameter_description>
-The shortcut is a two-finger swipe gesture. GTK+ provides an icon and subtitle.
+The shortcut is a two-finger swipe gesture. GTK provides an icon and subtitle.
</parameter_description>
</parameter>
<parameter name="GTK_SHORTCUT_GESTURE_TWO_FINGER_SWIPE_RIGHT">
<parameter_description>
-The shortcut is a two-finger swipe gesture. GTK+ provides an icon and subtitle.
+The shortcut is a two-finger swipe gesture. GTK provides an icon and subtitle.
</parameter_description>
</parameter>
<parameter name="GTK_SHORTCUT_GESTURE">
<parameter_description>
-The shortcut is a gesture. The #GtkShortcutsShortcut:icon property will be
+The shortcut is a gesture. The GtkShortcutsShortcut:icon property will be
used.
</parameter_description>
</parameter>
<parameter name="GTK_SHORTCUT_GESTURE_SWIPE_LEFT">
<parameter_description>
-The shortcut is a swipe gesture. GTK+ provides an icon and subtitle.
+The shortcut is a swipe gesture. GTK provides an icon and subtitle.
</parameter_description>
</parameter>
<parameter name="GTK_SHORTCUT_GESTURE_SWIPE_RIGHT">
<parameter_description>
-The shortcut is a swipe gesture. GTK+ provides an icon and subtitle.
+The shortcut is a swipe gesture. GTK provides an icon and subtitle.
</parameter_description>
</parameter>
</parameters>
@@ -12838,8 +14615,9 @@ This is used internally by GTK, and must not be modified by applications.
<property name="GtkShortcutsGroup:view">
<description>
An optional view that the shortcuts in this group are relevant for.
-The group will be hidden if the #GtkShortcutsWindow:view-name property
-does not match the view of this group.
+
+The group will be hidden if the [property@Gtk.ShortcutsWindow:view-name]
+property does not match the view of this group.
Set this to %NULL to make the group always visible.
@@ -12848,10 +14626,11 @@ Set this to %NULL to make the group always visible.
<property name="GtkShortcutsSection:max-height">
<description>
-The maximum number of lines to allow per column. This property can
-be used to influence how the groups in this section are distributed
-across pages and columns. The default value of 15 should work in
-most cases.
+The maximum number of lines to allow per column.
+
+This property can be used to influence how the groups in this
+section are distributed across pages and columns. The default
+value of 15 should work in most cases.
</description>
</property>
@@ -12859,18 +14638,21 @@ most cases.
<property name="GtkShortcutsSection:section-name">
<description>
A unique name to identify this section among the sections
-added to the GtkShortcutsWindow. Setting the #GtkShortcutsWindow:section-name
-property to this string will make this section shown in the
-GtkShortcutsWindow.
+added to the `GtkShortcutsWindow`.
+
+Setting the [property@Gtk.ShortcutsWindow:section-name] property
+to this string will make this section shown in the `GtkShortcutsWindow`.
</description>
</property>
<property name="GtkShortcutsSection:title">
<description>
-The string to show in the section selector of the GtkShortcutsWindow
-for this section. If there is only one section, you don't need to
-set a title, since the section selector will not be shown in this case.
+The string to show in the section selector of the `GtkShortcutsWindow`
+for this section.
+
+If there is only one section, you don't need to set a title,
+since the section selector will not be shown in this case.
</description>
</property>
@@ -12878,10 +14660,12 @@ set a title, since the section selector will not be shown in this case.
<property name="GtkShortcutsSection:view-name">
<description>
A view name to filter the groups in this section by.
-See #GtkShortcutsGroup:view.
-Applications are expected to use the #GtkShortcutsWindow:view-name
-property for this purpose.
+See [property@Gtk.ShortcutsGroup:view].
+
+Applications are expected to use the
+[property@Gtk.ShortcutsWindow:view-name] property
+for this purpose.
</description>
</property>
@@ -12897,24 +14681,30 @@ This is used internally by GTK, and must not be modified by applications.
<property name="GtkShortcutsShortcut:accelerator">
<description>
-The accelerator(s) represented by this object. This property is used
-if #GtkShortcutsShortcut:shortcut-type is set to #GTK_SHORTCUT_ACCELERATOR.
+The accelerator(s) represented by this object.
+
+This property is used if [property@Gtk.ShortcutsShortcut:shortcut-type]
+is set to %GTK_SHORTCUT_ACCELERATOR.
-The syntax of this property is (an extension of) the syntax understood by
-gtk_accelerator_parse(). Multiple accelerators can be specified by separating
-them with a space, but keep in mind that the available width is limited.
-It is also possible to specify ranges of shortcuts, using ... between the keys.
-Sequences of keys can be specified using a + or & between the keys.
+The syntax of this property is (an extension of) the syntax understood
+by [func@Gtk.accelerator_parse]. Multiple accelerators can be specified
+by separating them with a space, but keep in mind that the available width
+is limited.
+
+It is also possible to specify ranges of shortcuts, using "..." between
+the keys. Sequences of keys can be specified using a "+" or "&" between
+the keys.
Examples:
+
- A single shortcut: <ctl><alt>delete
- Two alternative shortcuts: <shift>a Home
- A range of shortcuts: <alt>1...<alt>9
- Several keys pressed together: Control_L&Control_R
- A sequence of shortcuts or keys: <ctl>c+<ctl>x
-Use + instead of & when the keys may (or have to be) pressed sequentially (e.g
-use t+t for 'press the t key twice').
+Use "+" instead of "&" when the keys may (or have to be) pressed
+sequentially (e.g use "t+t" for 'press the t key twice').
Note that <, > and & need to be escaped as <, > and & when used
in .ui files.
@@ -12924,28 +14714,33 @@ in .ui files.
<property name="GtkShortcutsShortcut:action-name">
<description>
-A detailed action name. If this is set for a shortcut
-of type %GTK_SHORTCUT_ACCELERATOR, then GTK will use
-the accelerators that are associated with the action
-via gtk_application_set_accels_for_action(), and setting
-#GtkShortcutsShortcut:accelerator is not necessary.
+A detailed action name.
+
+If this is set for a shortcut of type %GTK_SHORTCUT_ACCELERATOR,
+then GTK will use the accelerators that are associated with the
+action via [method@Gtk.Application.set_accels_for_action], and
+setting [property@Gtk.ShortcutsShortcut:accelerator] is not necessary.
</description>
</property>
<property name="GtkShortcutsShortcut:direction">
<description>
-The text direction for which this shortcut is active. If the shortcut
-is used regardless of the text direction, set this property to
-#GTK_TEXT_DIR_NONE.
+The text direction for which this shortcut is active.
+
+If the shortcut is used regardless of the text direction,
+set this property to %GTK_TEXT_DIR_NONE.
</description>
</property>
<property name="GtkShortcutsShortcut:icon">
<description>
-An icon to represent the shortcut or gesture. This property is used if
-#GtkShortcutsShortcut:shortcut-type is set to #GTK_SHORTCUT_GESTURE.
+An icon to represent the shortcut or gesture.
+
+This property is used if [property@Gtk.ShortcutsShortcut:shortcut-type]
+is set to %GTK_SHORTCUT_GESTURE.
+
For the other predefined gesture types, GTK provides an icon on its own.
</description>
@@ -12986,7 +14781,9 @@ types, GTK provides a subtitle on its own.
<property name="GtkShortcutsShortcut:title">
<description>
The textual description for the shortcut or gesture represented by
-this object. This should be a short string that can fit in a single line.
+this object.
+
+This should be a short string that can fit in a single line.
</description>
</property>
@@ -13002,10 +14799,9 @@ This is used internally by GTK, and must not be modified by applications.
<signal name="GtkShortcutsWindow::close">
<description>
-The ::close signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user uses a keybinding to close
-the window.
+Emitted when the user uses a keybinding to close the window.
+
+This is a [keybinding signal](class.SignalAction.html).
The default binding for this signal is the Escape key.
@@ -13017,9 +14813,9 @@ The default binding for this signal is the Escape key.
<signal name="GtkShortcutsWindow::search">
<description>
-The ::search signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user uses a keybinding to start a search.
+Emitted when the user uses a keybinding to start a search.
+
+This is a [keybinding signal](class.SignalAction.html).
The default binding for this signal is Control-F.
@@ -13033,7 +14829,7 @@ The default binding for this signal is Control-F.
<description>
The name of the section to show.
-This should be the section-name of one of the #GtkShortcutsSection
+This should be the section-name of one of the `GtkShortcutsSection`
objects that are in this shortcuts window.
</description>
@@ -13043,8 +14839,9 @@ objects that are in this shortcuts window.
<description>
The view name by which to filter the contents.
-This should correspond to the #GtkShortcutsGroup:view property of some of
-the #GtkShortcutsGroup objects that are inside this shortcuts window.
+This should correspond to the [property@Gtk.ShortcutsGroup:view]
+property of some of the [class@Gtk.ShortcutsGroup] objects that
+are inside this shortcuts window.
Set this to %NULL to show all groups.
@@ -13060,19 +14857,20 @@ The name of the signal to emit.
<signal name="GtkSignalListItemFactory::bind">
<description>
-The ::bind signal is emitted when a new #GtkListItem:item has been set
+Emitted when a new [property@Gtk.ListItem:item] has been set
on the @listitem and should be bound for use.
-After this signal was emitted, the listitem might be shown in a #GtkListView
-or other list widget.
+After this signal was emitted, the listitem might be shown in
+a [class@Gtk.ListView] or other list widget.
-The #GtkSignalListItemFactory::unbind signal is the opposite of this signal
-and can be used to undo everything done in this signal.
+The [signal@Gtk.SignalListItemFactory::unbind] signal is the
+opposite of this signal and can be used to undo everything done
+in this signal.
</description>
<parameters>
<parameter name="self">
-<parameter_description> The #GtkSignalListItemFactory
+<parameter_description> The `GtkSignalListItemFactory`
</parameter_description>
</parameter>
<parameter name="listitem">
@@ -13085,16 +14883,17 @@ and can be used to undo everything done in this signal.
<signal name="GtkSignalListItemFactory::setup">
<description>
-The ::setup signal is emitted when a new listitem has been created and
-needs to be setup for use. It is the first signal emitted for every listitem.
+Emitted when a new listitem has been created and needs to be setup for use.
+
+It is the first signal emitted for every listitem.
-The #GtkSignalListItemFactory::teardown signal is the opposite of this signal
-and can be used to undo everything done in this signal.
+The [signal@Gtk.SignalListItemFactory::teardown] signal is the opposite
+of this signal and can be used to undo everything done in this signal.
</description>
<parameters>
<parameter name="self">
-<parameter_description> The #GtkSignalListItemFactory
+<parameter_description> The `GtkSignalListItemFactory`
</parameter_description>
</parameter>
<parameter name="listitem">
@@ -13107,16 +14906,17 @@ and can be used to undo everything done in this signal.
<signal name="GtkSignalListItemFactory::teardown">
<description>
-The ::teardown signal is emitted when a listitem is about to be destroyed.
+Emitted when a listitem is about to be destroyed.
+
It is the last signal ever emitted for this @listitem.
-This signal is the opposite of the #GtkSignalListItemFactory::setup signal
-and should be used to undo everything done in that signal.
+This signal is the opposite of the [signal@Gtk.SignalListItemFactory::setup]
+signal and should be used to undo everything done in that signal.
</description>
<parameters>
<parameter name="self">
-<parameter_description> The #GtkSignalListItemFactory
+<parameter_description> The `GtkSignalListItemFactory`
</parameter_description>
</parameter>
<parameter name="listitem">
@@ -13129,16 +14929,16 @@ and should be used to undo everything done in that signal.
<signal name="GtkSignalListItemFactory::unbind">
<description>
-The ::unbind signal is emitted when a listitem has been removed from use
-in a list widget and its new #GtkListItem:item is about to be unset.
+Emitted when a listitem has been removed from use in a list widget
+and its new [property@Gtk.ListItem:item] is about to be unset.
-This signal is the opposite of the #GtkSignalListItemFactory::bind signal
-and should be used to undo everything done in that signal.
+This signal is the opposite of the [signal@Gtk.SignalListItemFactory::bind]
+signal and should be used to undo everything done in that signal.
</description>
<parameters>
<parameter name="self">
-<parameter_description> The #GtkSignalListItemFactory
+<parameter_description> The `GtkSignalListItemFactory`
</parameter_description>
</parameter>
<parameter name="listitem">
@@ -13151,35 +14951,42 @@ and should be used to undo everything done in that signal.
<property name="GtkSingleSelection:autoselect">
<description>
-If the selection will always select an item
+If the selection will always select an item.
</description>
</property>
<property name="GtkSingleSelection:can-unselect">
<description>
-If unselecting the selected item is allowed
+If unselecting the selected item is allowed.
</description>
</property>
<property name="GtkSingleSelection:model">
<description>
-The model being managed
+The model being managed.
</description>
</property>
<property name="GtkSingleSelection:selected">
<description>
-Position of the selected item
+Position of the selected item.
</description>
</property>
<property name="GtkSingleSelection:selected-item">
<description>
-The selected item
+The selected item.
+
+</description>
+</property>
+
+<property name="GtkSizeGroup:mode">
+<description>
+The direction in which the size group affects requested sizes.
</description>
</property>
@@ -13234,49 +15041,49 @@ width-for-height geometry management.
<property name="GtkSliceListModel:model">
<description>
-Child model to take slice from
+Child model to take slice from.
</description>
</property>
<property name="GtkSliceListModel:offset">
<description>
-Offset of slice
+Offset of slice.
</description>
</property>
<property name="GtkSliceListModel:size">
<description>
-Maximum size of slice
+Maximum size of slice.
</description>
</property>
<property name="GtkSortListModel:incremental">
<description>
-If the model should sort items incrementally
+If the model should sort items incrementally.
</description>
</property>
<property name="GtkSortListModel:model">
<description>
-The model being sorted
+The model being sorted.
</description>
</property>
<property name="GtkSortListModel:pending">
<description>
-Estimate of unsorted items remaining
+Estimate of unsorted items remaining.
</description>
</property>
<property name="GtkSortListModel:sorter">
<description>
-The sorter for this model
+The sorter for this model.
</description>
</property>
@@ -13300,14 +15107,16 @@ Determines the direction of a sort.
<signal name="GtkSorter::changed">
<description>
-This signal is emitted whenever the sorter changed. Users of the sorter
-should then update the sort order again via gtk_sorter_compare().
+Emitted whenever the sorter changed.
+
+Users of the sorter should then update the sort order
+again via gtk_sorter_compare().
-#GtkSortListModel handles this signal automatically.
+[class@Gtk.SortListModel] handles this signal automatically.
Depending on the @change parameter, it may be possible to update
-the sort order without a full resorting. Refer to the #GtkSorterChange
-documentation for details.
+the sort order without a full resorting. Refer to the
+[enum@Gtk.SorterChange] documentation for details.
</description>
<parameters>
@@ -13356,7 +15165,7 @@ that did return %GTK_ORDERING_EQUAL may not do so anymore.
<enum name="GtkSorterOrder">
<description>
-Describes the type of order that a #GtkSorter may describe.
+Describes the type of order that a `GtkSorter` may produce.
</description>
<parameters>
@@ -13380,14 +15189,15 @@ different items will never cause this value to be returned.
<signal name="GtkSpinButton::change-value">
<description>
-The ::change-value signal is a [keybinding signal][GtkSignalAction]
-which gets emitted when the user initiates a value change.
+Emitted when the user initiates a value change.
+
+This is a [keybinding signal](class.SignalAction.html).
-Applications should not connect to it, but may emit it with
+Applications should not connect to it, but may emit it with
g_signal_emit_by_name() if they need to control the cursor
programmatically.
-The default bindings for this signal are Up/Down and PageUp and/PageDown.
+The default bindings for this signal are Up/Down and PageUp/PageDown.
</description>
<parameters>
@@ -13405,10 +15215,11 @@ The default bindings for this signal are Up/Down and PageUp and/PageDown.
<signal name="GtkSpinButton::input">
<description>
-The ::input signal can be used to influence the conversion of
-the users input into a double value. The signal handler is
-expected to use gtk_editable_get_text() to retrieve the text of
-the spinbutton and set @new_value to the new value.
+Emitted to convert the users input into a double value.
+
+The signal handler is expected to use [method@Gtk.Editable.get_text]
+to retrieve the text of the spinbutton and set @new_value to the
+new value.
The default conversion uses g_strtod().
@@ -13431,9 +15242,9 @@ was not handled, and %GTK_INPUT_ERROR if the conversion failed.
<signal name="GtkSpinButton::output">
<description>
-The ::output signal can be used to change to formatting
-of the value that is displayed in the spin buttons entry.
-|[<!-- language="C" -->
+Emitted to tweak the formatting of the value for display.
+
+```c
// show leading zeros
static gboolean
on_output (GtkSpinButton *spin,
@@ -13451,7 +15262,7 @@ g_free (text);
return TRUE;
}
-]|
+```
</description>
@@ -13467,8 +15278,9 @@ return TRUE;
<signal name="GtkSpinButton::value-changed">
<description>
-The ::value-changed signal is emitted when the value represented by
-@spinbutton changes. Also see the #GtkSpinButton::output signal.
+Emitted when the value is changed.
+
+Also see the [signal@Gtk.SpinButton::output] signal.
</description>
<parameters>
@@ -13482,8 +15294,8 @@ The ::value-changed signal is emitted when the value represented by
<signal name="GtkSpinButton::wrapped">
<description>
-The ::wrapped signal is emitted right after the spinbutton wraps
-from its maximum to minimum value or vice-versa.
+Emitted right after the spinbutton wraps from its maximum
+to its minimum value or vice-versa.
</description>
<parameters>
@@ -13495,11 +15307,70 @@ from its maximum to minimum value or vice-versa.
<return></return>
</signal>
+<property name="GtkSpinButton:adjustment">
+<description>
+The adjustment that holds the value of the spin button.
+
+</description>
+</property>
+
+<property name="GtkSpinButton:climb-rate">
+<description>
+The acceleration rate when you hold down a button or key.
+
+</description>
+</property>
+
+<property name="GtkSpinButton:digits">
+<description>
+The number of decimal places to display.
+
+</description>
+</property>
+
+<property name="GtkSpinButton:numeric">
+<description>
+Whether non-numeric characters should be ignored.
+
+</description>
+</property>
+
+<property name="GtkSpinButton:snap-to-ticks">
+<description>
+Whether erroneous values are automatically changed to the spin buttons
+nearest step increment.
+
+</description>
+</property>
+
+<property name="GtkSpinButton:update-policy">
+<description>
+Whether the spin button should update always, or only when the value
+is acceptable.
+
+</description>
+</property>
+
+<property name="GtkSpinButton:value">
+<description>
+The current value.
+
+</description>
+</property>
+
+<property name="GtkSpinButton:wrap">
+<description>
+Whether a spin button should wrap upon reaching its limits.
+
+</description>
+</property>
+
<enum name="GtkSpinButtonUpdatePolicy">
<description>
-The spin button update policy determines whether the spin button displays
-values even if they are outside the bounds of its adjustment.
-See gtk_spin_button_set_update_policy().
+Determines whether the spin button displays values outside the adjustment
+bounds.
+
+See [method@Gtk.SpinButton.set_update_policy].
</description>
<parameters>
@@ -13555,6 +15426,13 @@ change to make in gtk_spin_button_spin().
</parameters>
</enum>
+<property name="GtkSpinner:spinning">
+<description>
+Whether the spinner is spinning
+
+</description>
+</property>
+
<property name="GtkStack:hhomogeneous">
<description>
%TRUE if the stack allocates the same width for all children.
@@ -13562,6 +15440,41 @@ change to make in gtk_spin_button_spin().
</description>
</property>
+<property name="GtkStack:interpolate-size">
+<description>
+Whether or not the size should smoothly change during the transition.
+
+</description>
+</property>
+
+<property name="GtkStack:pages">
+<description>
+A selection model with the stack pages.
+
+</description>
+</property>
+
+<property name="GtkStack:transition-duration">
+<description>
+The animation duration, in milliseconds.
+
+</description>
+</property>
+
+<property name="GtkStack:transition-running">
+<description>
+Whether or not the transition is currently running.
+
+</description>
+</property>
+
+<property name="GtkStack:transition-type">
+<description>
+The type of animation used to transition.
+
+</description>
+</property>
+
<property name="GtkStack:vhomogeneous">
<description>
%TRUE if the stack allocates the same height for all children.
@@ -13569,20 +15482,90 @@ change to make in gtk_spin_button_spin().
</description>
</property>
+<property name="GtkStack:visible-child">
+<description>
+The widget currently visible in the stack.
+
+</description>
+</property>
+
+<property name="GtkStack:visible-child-name">
+<description>
+The name of the widget currently visible in the stack.
+
+</description>
+</property>
+
+<property name="GtkStackPage:child">
+<description>
+The child that this page is for.
+
+</description>
+</property>
+
+<property name="GtkStackPage:icon-name">
+<description>
+The icon name of the child page.
+
+</description>
+</property>
+
+<property name="GtkStackPage:name">
+<description>
+The name of the child page.
+
+</description>
+</property>
+
<property name="GtkStackPage:needs-attention">
<description>
-Sets a flag specifying whether the page requires the user attention.
-This is used by the #GtkStackSwitcher to change the appearance of the
-corresponding button when a page needs attention and it is not the
-current one.
+Whether the page requires the user attention.
+
+This is used by the [class@Gtk.StackSwitcher] to change the
+appearance of the corresponding button when a page needs
+attention and it is not the current one.
+
+</description>
+</property>
+
+<property name="GtkStackPage:title">
+<description>
+The title of the child page.
+
+</description>
+</property>
+
+<property name="GtkStackPage:use-underline">
+<description>
+If set, an underline in the title indicates a mnemonic.
+
+</description>
+</property>
+
+<property name="GtkStackPage:visible">
+<description>
+Whether this page is visible.
+
+</description>
+</property>
+
+<property name="GtkStackSidebar:stack">
+<description>
+The stack.
+
+</description>
+</property>
+
+<property name="GtkStackSwitcher:stack">
+<description>
+The stack.
</description>
</property>
<enum name="GtkStackTransitionType">
<description>
-These enumeration values describe the possible transitions
-between pages in a #GtkStack widget.
+Possible transitions between pages in a `GtkStack` widget.
New values may be added to this enumeration over time.
@@ -13685,9 +15668,11 @@ New values may be added to this enumeration over time.
<enum name="GtkStateFlags">
<description>
-Describes a widget state. Widget states are used to match the widget
-against CSS pseudo-classes. Note that GTK extends the regular CSS
-classes and sometimes uses different names.
+Describes a widget state.
+
+Widget states are used to match the widget against CSS pseudo-classes.
+Note that GTK extends the regular CSS classes and sometimes uses
+different names.
</description>
<parameters>
@@ -13760,7 +15745,7 @@ classes and sometimes uses different names.
<signal name="GtkStatusbar::text-popped">
<description>
-Is emitted whenever a new message is popped off a statusbar's stack.
+Emitted whenever a new message is popped off a statusbar's stack.
</description>
<parameters>
@@ -13782,7 +15767,7 @@ Is emitted whenever a new message is popped off a statusbar's stack.
<signal name="GtkStatusbar::text-pushed">
<description>
-Is emitted whenever a new message gets pushed onto a statusbar's stack.
+Emitted whenever a new message gets pushed onto a statusbar's stack.
</description>
<parameters>
@@ -13804,28 +15789,28 @@ Is emitted whenever a new message gets pushed onto a statusbar's stack.
<property name="GtkStringFilter:expression">
<description>
-The expression to evaluate on item to get a string to compare with
+The expression to evaluate on item to get a string to compare with.
</description>
</property>
<property name="GtkStringFilter:ignore-case">
<description>
-If matching is case sensitive
+If matching is case sensitive.
</description>
</property>
<property name="GtkStringFilter:match-mode">
<description>
-If exact matches are necessary or if substrings are allowed
+If exact matches are necessary or if substrings are allowed.
</description>
</property>
<property name="GtkStringFilter:search">
<description>
-The search term
+The search term.
</description>
</property>
@@ -13854,16 +15839,23 @@ with the search string.
</parameters>
</enum>
+<property name="GtkStringObject:string">
+<description>
+The string.
+
+</description>
+</property>
+
<property name="GtkStringSorter:expression">
<description>
-The expression to evaluate on item to get a string to compare with
+The expression to evaluate on item to get a string to compare with.
</description>
</property>
<property name="GtkStringSorter:ignore-case">
<description>
-If matching is case sensitive
+If matching is case sensitive.
</description>
</property>
@@ -13871,6 +15863,7 @@ If matching is case sensitive
<enum name="GtkStyleContextPrintFlags">
<description>
Flags that modify the behavior of gtk_style_context_to_string().
+
New values may be added to this enumeration.
</description>
@@ -13899,15 +15892,15 @@ what changes affect the styles
<signal name="GtkSwitch::activate">
<description>
-The ::activate signal on GtkSwitch is an action signal and
-emitting it causes the switch to animate.
-Applications should never connect to this signal, but use the
-notify::active signal.
+Emitted to animate the switch.
+
+Applications should never connect to this signal,
+but use the [property@Gtk.Switch:active] property.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> the object which received the signal.
+<parameter_description> the object which received the signal
</parameter_description>
</parameter>
</parameters>
@@ -13916,19 +15909,21 @@ notify::active signal.
<signal name="GtkSwitch::state-set">
<description>
-The ::state-set signal on GtkSwitch is emitted to change the underlying
-state. It is emitted when the user changes the switch position. The
-default handler keeps the state in sync with the #GtkSwitch:active
-property.
+Emitted to change the underlying state.
+
+The ::state-set signal is emitted when the user changes the switch
+position. The default handler keeps the state in sync with the
+[property@Gtk.Switch:active] property.
-To implement delayed state change, applications can connect to this signal,
-initiate the change of the underlying state, and call gtk_switch_set_state()
-when the underlying state change is complete. The signal handler should
-return %TRUE to prevent the default handler from running.
+To implement delayed state change, applications can connect to this
+signal, initiate the change of the underlying state, and call
+[method@Gtk.Switch.set_state] when the underlying state change is
+complete. The signal handler should return %TRUE to prevent the
+default handler from running.
Visually, the underlying state is represented by the trough color of
-the switch, while the #GtkSwitch:active property is represented by the
-position of the switch.
+the switch, while the [property@Gtk.Switch`:active] property is
+represented by the position of the switch.
</description>
@@ -13948,15 +15943,16 @@ position of the switch.
<property name="GtkSwitch:active">
<description>
-Whether the #GtkSwitch widget is in its on or off state.
+Whether the `GtkSwitch` widget is in its on or off state.
</description>
</property>
<property name="GtkSwitch:state">
<description>
-The backend state that is controlled by the switch.
-See #GtkSwitch::state-set for details.
+The backend state that is controlled by the switch.
+
+See [signal@GtkSwitch::state-set] for details.
</description>
</property>
@@ -13964,10 +15960,12 @@ See #GtkSwitch::state-set for details.
<enum name="GtkSystemSetting">
<description>
Values that can be passed to the GtkWidgetClass.system_setting_changed
-vfunc to indicate that a system setting has changed and widgets may
-need to drop caches, or react otherwise.
+vfunc.
+
+The values indicate which system setting has changed.
+Widgets may need to drop caches, or react otherwise.
-Most of the values correspond to #GtkSettings properties.
+Most of the values correspond to `GtkSettings` properties.
More values may be added over time.
@@ -14003,10 +16001,10 @@ icons to be looked up again
<signal name="GtkText::activate">
<description>
-The ::activate signal is emitted when the user hits
-the Enter key.
+Emitted when the user hits the Enter key.
-The default bindings for this signal are all forms of the Enter key.
+The default bindings for this signal are all forms
+of the <kbd>Enter</kbd> key.
</description>
<parameters>
@@ -14020,12 +16018,12 @@ The default bindings for this signal are all forms of the Enter key.
<signal name="GtkText::backspace">
<description>
-The ::backspace signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user asks for it.
+Emitted when the user asks for it.
+
+This is a [keybinding signal](class.SignalAction.html).
The default bindings for this signal are
-Backspace and Shift-Backspace.
+<kbd>Backspace</kbd> and <kbd>Shift</kbd>-<kbd>Backspace</kbd>.
</description>
<parameters>
@@ -14039,12 +16037,13 @@ Backspace and Shift-Backspace.
<signal name="GtkText::copy-clipboard">
<description>
-The ::copy-clipboard signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to copy the selection to the clipboard.
+Emitted to copy the selection to the clipboard.
+
+This is a [keybinding signal](class.SignalAction.html).
The default bindings for this signal are
-Ctrl-c and Ctrl-Insert.
+<kbd>Ctrl</kbd>-<kbd>c</kbd> and
+<kbd>Ctrl</kbd>-<kbd>Insert</kbd>.
</description>
<parameters>
@@ -14058,12 +16057,13 @@ Ctrl-c and Ctrl-Insert.
<signal name="GtkText::cut-clipboard">
<description>
-The ::cut-clipboard signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to cut the selection to the clipboard.
+Emitted to cut the selection to the clipboard.
+
+This is a [keybinding signal](class.SignalAction.html).
The default bindings for this signal are
-Ctrl-x and Shift-Delete.
+<kbd>Ctrl</kbd>-<kbd>x</kbd> and
+<kbd>Shift</kbd>-<kbd>Delete</kbd>.
</description>
<parameters>
@@ -14077,17 +16077,17 @@ Ctrl-x and Shift-Delete.
<signal name="GtkText::delete-from-cursor">
<description>
-The ::delete-from-cursor signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user initiates a text deletion.
+Emitted when the user initiates a text deletion.
+
+This is a [keybinding signal](class.SignalAction.html).
If the @type is %GTK_DELETE_CHARS, GTK deletes the selection
if there is one, otherwise it deletes the requested number
of characters.
-The default bindings for this signal are
-Delete for deleting a character and Ctrl-Delete for
-deleting a word.
+The default bindings for this signal are <kbd>Delete</kbd>
+for deleting a character and <kbd>Ctrl</kbd>-<kbd>Delete</kbd>
+for deleting a word.
</description>
<parameters>
@@ -14109,11 +16109,11 @@ deleting a word.
<signal name="GtkText::insert-at-cursor">
<description>
-The ::insert-at-cursor signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user initiates the insertion of a
+Emitted when the user initiates the insertion of a
fixed string at the cursor.
+This is a [keybinding signal](class.SignalAction.html).
+
This signal has no default bindings.
</description>
@@ -14132,11 +16132,13 @@ This signal has no default bindings.
<signal name="GtkText::insert-emoji">
<description>
-The ::insert-emoji signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to present the Emoji chooser for the @self.
+Emitted to present the Emoji chooser for the @self.
+
+This is a [keybinding signal](class.SignalAction.html).
-The default bindings for this signal are Ctrl-. and Ctrl-;
+The default bindings for this signal are
+<kbd>Ctrl</kbd>-<kbd>.</kbd> and
+<kbd>Ctrl</kbd>-<kbd>;</kbd>
</description>
<parameters>
@@ -14150,23 +16152,26 @@ The default bindings for this signal are Ctrl-. and Ctrl-;
<signal name="GtkText::move-cursor">
<description>
-The ::move-cursor signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user initiates a cursor movement.
+Emitted when the user initiates a cursor movement.
+
If the cursor is not visible in @self, this signal causes
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.
The default bindings for this signal come in two variants,
-the variant with the Shift modifier extends the selection,
-the variant without the Shift modifier does not.
+the variant with the <kbd>Shift</kbd> modifier extends the
+selection, the variant without it does not.
There are too many key combinations to list them all here.
-- Arrow keys move by individual characters/lines
-- Ctrl-arrow key combinations move by words/paragraphs
-- Home/End keys move to the ends of the buffer
+
+- <kbd>←</kbd>, <kbd>→</kbd>, <kbd>↑</kbd>, <kbd>↓</kbd>
+move by individual characters/lines
+- <kbd>Ctrl</kbd>-<kbd>→</kbd>, etc. move by words/paragraphs
+- <kbd>Home</kbd>, <kbd>End</kbd> move to the ends of the buffer
</description>
<parameters>
@@ -14192,13 +16197,12 @@ There are too many key combinations to list them all here.
<signal name="GtkText::paste-clipboard">
<description>
-The ::paste-clipboard signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to paste the contents of the clipboard
-into the text view.
+Emitted to paste the contents of the clipboard.
+
+This is a [keybinding signal](class.SignalAction.html).
The default bindings for this signal are
-Ctrl-v and Shift-Insert.
+<kbd>Ctrl</kbd>-<kbd>v</kbd> and
<kbd>Shift</kbd>-<kbd>Insert</kbd>.
</description>
<parameters>
@@ -14212,6 +16216,8 @@ Ctrl-v and Shift-Insert.
<signal name="GtkText::preedit-changed">
<description>
+Emitted when the preedit text changes.
+
If an input method is used, the typed text will not immediately
be committed to the buffer. So if you are interested in the text,
connect to this signal.
@@ -14232,11 +16238,11 @@ connect to this signal.
<signal name="GtkText::toggle-overwrite">
<description>
-The ::toggle-overwrite signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to toggle the overwrite mode of the self.
+Emitted to toggle the overwrite mode of the `GtkText`.
+
+This is a [keybinding signal](class.SignalAction.html).
-The default bindings for this signal is Insert.
+The default bindings for this signal is <kbd>Insert</kbd>.
</description>
<parameters>
@@ -14248,14 +16254,35 @@ The default bindings for this signal is Insert.
<return></return>
</signal>
+<property name="GtkText:activates-default">
+<description>
+Whether to activate the default widget when Enter is pressed.
+
+</description>
+</property>
+
<property name="GtkText:attributes">
<description>
-A list of Pango attributes to apply to the text of the self.
+A list of Pango attributes to apply to the text of the `GtkText`.
This is mainly useful to change the size or weight of the text.
-The #PangoAttribute's @start_index and @end_index must refer to the
-#GtkEntryBuffer text, i.e. without the preedit string.
+The `PangoAttribute`'s @start_index and @end_index must refer to the
+`GtkEntryBuffer` text, i.e. without the preedit string.
+
+</description>
+</property>
+
+<property name="GtkText:buffer">
+<description>
+The `GtkEntryBuffer` object which stores the text.
+
+</description>
+</property>
+
+<property name="GtkText:enable-emoji-completion">
+<description>
+Whether to suggest Emoji replacements.
</description>
</property>
@@ -14271,19 +16298,20 @@ the context menu.
<property name="GtkText:im-module">
<description>
Which IM (input method) module should be used for this self.
-See #GtkIMContext.
-Setting this to a non-%NULL value overrides the
-system-wide IM module setting. See the GtkSettings
-#GtkSettings:gtk-im-module property.
+See [class@Gtk.IMContext].
+
+Setting this to a non-%NULL value overrides the system-wide
+IM module setting. See the [property@Gtk.Settings:gtk-im-module]
+property.
</description>
</property>
<property name="GtkText:input-hints">
<description>
-Additional hints (beyond #GtkText:input-purpose) that
-allow input methods to fine-tune their behaviour.
+Additional hints that allow input methods to fine-tune
+their behaviour.
</description>
</property>
@@ -14297,36 +16325,66 @@ methods to adjust their behaviour.
Note that setting the purpose to %GTK_INPUT_PURPOSE_PASSWORD or
%GTK_INPUT_PURPOSE_PIN is independent from setting
-#GtkText:visibility.
+[property Gtk Text:visibility].
+
+</description>
+</property>
+
+<property name="GtkText:invisible-char">
+<description>
+The character to used when masking contents (in “password mode”).
</description>
</property>
<property name="GtkText:invisible-char-set">
<description>
-Whether the invisible char has been set for the #GtkText.
+Whether the invisible char has been set for the `GtkText`.
+
+</description>
+</property>
+
+<property name="GtkText:max-length">
+<description>
+Maximum number of characters that are allowed.
+
+Zero indicates no limit.
</description>
</property>
<property name="GtkText:overwrite-mode">
<description>
-If text is overwritten when typing in the #GtkText.
+If text is overwritten when typing in the `GtkText`.
</description>
</property>
<property name="GtkText:placeholder-text">
<description>
-The text that will be displayed in the #GtkText when it is empty
+The text that will be displayed in the `GtkText` when it is empty
and unfocused.
</description>
</property>
+<property name="GtkText:propagate-text-width">
+<description>
+Whether the widget should grow and shrink with the content.
+
+</description>
+</property>
+
+<property name="GtkText:scroll-offset">
+<description>
+Number of pixels scrolled of the screen to the left.
+
+</description>
+</property>
+
<property name="GtkText:tabs">
<description>
-A list of tabstops to apply to the text of the self.
+A list of tabstops to apply to the text of the `GtkText`.
</description>
</property>
@@ -14338,19 +16396,27 @@ When %TRUE, pasted multi-line text is truncated to the first line.
</description>
</property>
+<property name="GtkText:visibility">
+<description>
+If %FALSE, the text is masked with the “invisible char”.
+
+</description>
+</property>
+
<signal name="GtkTextBuffer::apply-tag">
<description>
-The #GtkTextBuffer::apply-tag signal is emitted to apply a tag to a
-range of text in a #GtkTextBuffer.
+Emitted to apply a tag to a range of text in a `GtkTextBuffer`.
+
Applying actually occurs in the default handler.
-Note that if your handler runs before the default handler it must not
-invalidate the @start and @end iters (or has to revalidate them).
+Note that if your handler runs before the default handler
+it must not invalidate the @start and @end iters (or has to
+revalidate them).
-See also:
-gtk_text_buffer_apply_tag(),
-gtk_text_buffer_insert_with_tags(),
-gtk_text_buffer_insert_range().
+See also:
+[method@Gtk.TextBuffer.apply_tag],
+[method@Gtk.TextBuffer.insert_with_tags],
+[method@Gtk.TextBuffer.insert_range].
</description>
<parameters>
@@ -14376,16 +16442,16 @@ gtk_text_buffer_insert_range().
<signal name="GtkTextBuffer::begin-user-action">
<description>
-The #GtkTextBuffer::begin-user-action signal is emitted at the beginning of a single
-user-visible operation on a #GtkTextBuffer.
+Emitted at the beginning of a single user-visible
+operation on a `GtkTextBuffer`.
-See also:
-gtk_text_buffer_begin_user_action(),
-gtk_text_buffer_insert_interactive(),
-gtk_text_buffer_insert_range_interactive(),
-gtk_text_buffer_delete_interactive(),
-gtk_text_buffer_backspace(),
-gtk_text_buffer_delete_selection().
+See also:
+[method@Gtk.TextBuffer.begin_user_action],
+[method@Gtk.TextBuffer.insert_interactive],
+[method@Gtk.TextBuffer.insert_range_interactive],
+[method@Gtk.TextBuffer.delete_interactive],
+[method@Gtk.TextBuffer.backspace],
+[method@Gtk.TextBuffer.delete_selection].
</description>
<parameters>
@@ -14399,8 +16465,7 @@ gtk_text_buffer_delete_selection().
<signal name="GtkTextBuffer::changed">
<description>
-The #GtkTextBuffer::changed signal is emitted when the content of a #GtkTextBuffer
-has changed.
+Emitted when the content of a `GtkTextBuffer` has changed.
</description>
<parameters>
@@ -14414,17 +16479,17 @@ has changed.
<signal name="GtkTextBuffer::delete-range">
<description>
-The #GtkTextBuffer::delete-range signal is emitted to delete a range
-from a #GtkTextBuffer.
+Emitted to delete a range from a `GtkTextBuffer`.
-Note that if your handler runs before the default handler it must not
-invalidate the @start and @end iters (or has to revalidate them).
-The default signal handler revalidates the @start and @end iters to
-both point to the location where text was deleted. Handlers
-which run after the default handler (see g_signal_connect_after())
-do not have access to the deleted text.
+Note that if your handler runs before the default handler
+it must not invalidate the @start and @end iters (or has
+to revalidate them). The default signal handler revalidates
+the @start and @end iters to both point to the location
+where text was deleted. Handlers which run after the default
+handler (see g_signal_connect_after()) do not have access to
+the deleted text.
-See also: gtk_text_buffer_delete().
+See also: [method@Gtk.TextBuffer.delete].
</description>
<parameters>
@@ -14446,17 +16511,17 @@ See also: gtk_text_buffer_delete().
<signal name="GtkTextBuffer::end-user-action">
<description>
-The #GtkTextBuffer::end-user-action signal is emitted at the end of a single
-user-visible operation on the #GtkTextBuffer.
+Emitted at the end of a single user-visible
+operation on the `GtkTextBuffer`.
-See also:
-gtk_text_buffer_end_user_action(),
-gtk_text_buffer_insert_interactive(),
-gtk_text_buffer_insert_range_interactive(),
-gtk_text_buffer_delete_interactive(),
-gtk_text_buffer_backspace(),
-gtk_text_buffer_delete_selection(),
-gtk_text_buffer_backspace().
+See also:
+[method@Gtk.TextBuffer.end_user_action],
+[method@Gtk.TextBuffer.insert_interactive],
+[method@Gtk.TextBuffer.insert_range_interactive],
+[method@Gtk.TextBuffer.delete_interactive],
+[method@Gtk.TextBuffer.backspace],
+[method@Gtk.TextBuffer.delete_selection],
+[method@Gtk.TextBuffer.backspace].
</description>
<parameters>
@@ -14470,16 +16535,16 @@ gtk_text_buffer_backspace().
<signal name="GtkTextBuffer::insert-child-anchor">
<description>
-The #GtkTextBuffer::insert-child-anchor signal is emitted to insert a
-#GtkTextChildAnchor in a #GtkTextBuffer.
+Emitted to insert a `GtkTextChildAnchor` in a `GtkTextBuffer`.
+
Insertion actually occurs in the default handler.
-Note that if your handler runs before the default handler it must
-not invalidate the @location iter (or has to revalidate it).
-The default signal handler revalidates it to be placed after the
-inserted @anchor.
+Note that if your handler runs before the default handler
+it must not invalidate the @location iter (or has to
+revalidate it). The default signal handler revalidates
+it to be placed after the inserted @anchor.
-See also: gtk_text_buffer_insert_child_anchor().
+See also: [method@Gtk.TextBuffer.insert_child_anchor].
</description>
<parameters>
@@ -14492,7 +16557,7 @@ See also: gtk_text_buffer_insert_child_anchor().
</parameter_description>
</parameter>
<parameter name="anchor">
-<parameter_description> the #GtkTextChildAnchor to be inserted
+<parameter_description> the `GtkTextChildAnchor` to be inserted
</parameter_description>
</parameter>
</parameters>
@@ -14501,15 +16566,16 @@ See also: gtk_text_buffer_insert_child_anchor().
<signal name="GtkTextBuffer::insert-paintable">
<description>
-The #GtkTextBuffer::insert-paintable signal is emitted to insert a #GdkPaintable
-in a #GtkTextBuffer. Insertion actually occurs in the default handler.
+Emitted to insert a `GdkPaintable` in a `GtkTextBuffer`.
+
+Insertion actually occurs in the default handler.
-Note that if your handler runs before the default handler it must not
-invalidate the @location iter (or has to revalidate it).
-The default signal handler revalidates it to be placed after the
-inserted @paintable.
+Note that if your handler runs before the default handler
+it must not invalidate the @location iter (or has to
+revalidate it). The default signal handler revalidates
+it to be placed after the inserted @paintable.
-See also: gtk_text_buffer_insert_paintable().
+See also: [method@Gtk.TextBuffer.insert_paintable].
</description>
<parameters>
@@ -14522,7 +16588,7 @@ See also: gtk_text_buffer_insert_paintable().
</parameter_description>
</parameter>
<parameter name="paintable">
-<parameter_description> the #GdkPaintable to be inserted
+<parameter_description> the `GdkPaintable` to be inserted
</parameter_description>
</parameter>
</parameters>
@@ -14531,17 +16597,17 @@ See also: gtk_text_buffer_insert_paintable().
<signal name="GtkTextBuffer::insert-text">
<description>
-The ::insert-text signal is emitted to insert text in a #GtkTextBuffer.
-Insertion actually occurs in the default handler.
+Emitted to insert text in a `GtkTextBuffer`.
-Note that if your handler runs before the default handler it must not
-invalidate the @location iter (or has to revalidate it).
-The default signal handler revalidates it to point to the end of the
-inserted text.
+Insertion actually occurs in the default handler.
+
+Note that if your handler runs before the default handler
+it must not invalidate the @location iter (or has to
+revalidate it). The default signal handler revalidates
+it to point to the end of the inserted text.
-See also:
-gtk_text_buffer_insert(),
-gtk_text_buffer_insert_range().
+See also: [method@Gtk,TextBuffer.insert],
+[method@Gtk.TextBuffer.insert_range].
</description>
<parameters>
@@ -14567,11 +16633,9 @@ gtk_text_buffer_insert_range().
<signal name="GtkTextBuffer::mark-deleted">
<description>
-The #GtkTextBuffer::mark-deleted signal is emitted as notification
-after a #GtkTextMark is deleted.
+Emitted as notification after a `GtkTextMark` is deleted.
-See also:
-gtk_text_buffer_delete_mark().
+See also: [method@Gtk.TextBuffer.delete_mark].
</description>
<parameters>
@@ -14589,12 +16653,11 @@ gtk_text_buffer_delete_mark().
<signal name="GtkTextBuffer::mark-set">
<description>
-The #GtkTextBuffer::mark-set signal is emitted as notification
-after a #GtkTextMark is set.
+Emitted as notification after a `GtkTextMark` is set.
-See also:
-gtk_text_buffer_create_mark(),
-gtk_text_buffer_move_mark().
+See also:
+[method@Gtk.TextBuffer.create_mark],
+[method@Gtk.TextBuffer.move_mark].
</description>
<parameters>
@@ -14616,11 +16679,9 @@ gtk_text_buffer_move_mark().
<signal name="GtkTextBuffer::modified-changed">
<description>
-The #GtkTextBuffer::modified-changed signal is emitted when the modified bit of a
-#GtkTextBuffer flips.
+Emitted when the modified bit of a `GtkTextBuffer` flips.
-See also:
-gtk_text_buffer_set_modified().
+See also: [method@Gtk.TextBuffer.set_modified].
</description>
<parameters>
@@ -14634,9 +16695,11 @@ gtk_text_buffer_set_modified().
<signal name="GtkTextBuffer::paste-done">
<description>
-The paste-done signal is emitted after paste operation has been completed.
-This is useful to properly scroll the view to the end of the pasted text.
-See gtk_text_buffer_paste_clipboard() for more details.
+Emitted after paste operation has been completed.
+
+This is useful to properly scroll the view to the end
+of the pasted text. See [method@Gtk.TextBuffer.paste_clipboard]
+for more details.
</description>
<parameters>
@@ -14645,7 +16708,7 @@ See gtk_text_buffer_paste_clipboard() for more details.
</parameter_description>
</parameter>
<parameter name="clipboard">
-<parameter_description> the #GdkClipboard pasted from
+<parameter_description> the `GdkClipboard` pasted from
</parameter_description>
</parameter>
</parameters>
@@ -14654,13 +16717,13 @@ See gtk_text_buffer_paste_clipboard() for more details.
<signal name="GtkTextBuffer::redo">
<description>
-The "redo" signal is emitted when a request has been made to redo the
+Emitted when a request has been made to redo the
previously undone operation.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -14669,15 +16732,16 @@ previously undone operation.
<signal name="GtkTextBuffer::remove-tag">
<description>
-The #GtkTextBuffer::remove-tag signal is emitted to remove all occurrences
-of @tag from a range of text in a #GtkTextBuffer.
+Emitted to remove all occurrences of @tag from a range
+of text in a `GtkTextBuffer`.
+
Removal actually occurs in the default handler.
-Note that if your handler runs before the default handler it must not
-invalidate the @start and @end iters (or has to revalidate them).
+Note that if your handler runs before the default handler
+it must not invalidate the @start and @end iters (or has
+to revalidate them).
-See also:
-gtk_text_buffer_remove_tag().
+See also: [method@Gtk.TextBuffer.remove_tag].
</description>
<parameters>
@@ -14703,13 +16767,14 @@ gtk_text_buffer_remove_tag().
<signal name="GtkTextBuffer::undo">
<description>
-The "undo" signal is emitted when a request has been made to undo the
-previous operation or set of operations that have been grouped together.
+Emitted when a request has been made to undo the
+previous operation or set of operations that have
+been grouped together.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -14718,33 +16783,31 @@ previous operation or set of operations that have been grouped together.
<property name="GtkTextBuffer:can-redo">
<description>
-The #GtkTextBuffer:can-redo property denotes that the buffer can reapply the
-last undone action.
+Denotes that the buffer can reapply the last undone action.
</description>
</property>
<property name="GtkTextBuffer:can-undo">
<description>
-The #GtkTextBuffer:can-undo property denotes that the buffer can undo the last
-applied action.
+Denotes that the buffer can undo the last applied action.
</description>
</property>
<property name="GtkTextBuffer:cursor-position">
<description>
-The position of the insert mark (as offset from the beginning
-of the buffer). It is useful for getting notified when the
-cursor moves.
+The position of the insert mark.
+
+This is an offset from the beginning of the buffer.
+It is useful for getting notified when the cursor moves.
</description>
</property>
<property name="GtkTextBuffer:enable-undo">
<description>
-The #GtkTextBuffer:enable-undo property denotes if support for undoing and
-redoing changes to the buffer is allowed.
+Denotes if support for undoing and redoing changes to the buffer is allowed.
</description>
</property>
@@ -14758,8 +16821,10 @@ Whether the buffer has some text currently selected.
<property name="GtkTextBuffer:text">
<description>
-The text content of the buffer. Without child widgets and images,
-see gtk_text_buffer_get_text() for more information.
+The text content of the buffer.
+
+Without child widgets and images,
+see [method@Gtk.TextBuffer.get_text] for more information.
</description>
</property>
@@ -14807,9 +16872,11 @@ a triple-click for example.
<property name="GtkTextMark:left-gravity">
<description>
-Whether the mark has left gravity. When text is inserted at the mark’s
-current location, if the mark has left gravity it will be moved
-to the left of the newly-inserted text, otherwise to the right.
+Whether the mark has left gravity.
+
+When text is inserted at the mark’s current location, if the mark
+has left gravity it will be moved to the left of the newly-inserted
+text, otherwise to the right.
</description>
</property>
@@ -14825,7 +16892,7 @@ The name of the mark or %NULL if the mark is anonymous.
<description>
Flags affecting how a search is done.
-If neither #GTK_TEXT_SEARCH_VISIBLE_ONLY nor #GTK_TEXT_SEARCH_TEXT_ONLY are
+If neither %GTK_TEXT_SEARCH_VISIBLE_ONLY nor %GTK_TEXT_SEARCH_TEXT_ONLY are
enabled, the match must be exact; the special 0xFFFC character will match
embedded paintables or child widgets.
@@ -14853,16 +16920,52 @@ what case it is in.
<description>
Whether the margins accumulate or override each other.
-When set to %TRUE the margins of this tag are added to the margins
-of any other non-accumulative margins present. When set to %FALSE
+When set to %TRUE the margins of this tag are added to the margins
+of any other non-accumulative margins present. When set to %FALSE
the margins override one another (the default).
</description>
</property>
+<property name="GtkTextTag:allow-breaks">
+<description>
+Whether breaks are allowed.
+
+</description>
+</property>
+
+<property name="GtkTextTag:background">
+<description>
+Background color as a string.
+
+</description>
+</property>
+
+<property name="GtkTextTag:background-full-height">
+<description>
+Whether the background color fills the entire line height
+or only the height of the tagged characters.
+
+</description>
+</property>
+
<property name="GtkTextTag:background-rgba">
<description>
-Background color as a #GdkRGBA.
+Background color as a `GdkRGBA`.
+
+</description>
+</property>
+
+<property name="GtkTextTag:direction">
+<description>
+Text direction, e.g. right-to-left or left-to-right.
+
+</description>
+</property>
+
+<property name="GtkTextTag:editable">
+<description>
+Whether the text can be modified by the user.
</description>
</property>
@@ -14877,12 +16980,26 @@ where the current font is missing glyphs.
</description>
</property>
+<property name="GtkTextTag:family">
+<description>
+Name of the font family, e.g. Sans, Helvetica, Times, Monospace.
+
+</description>
+</property>
+
<property name="GtkTextTag:font">
<description>
-Font description as string, e.g. \"Sans Italic 12\".
+Font description as string, e.g. \"Sans Italic 12\".
Note that the initial value of this property depends on
-the internals of #PangoFontDescription.
+the internals of `PangoFontDescription`.
+
+</description>
+</property>
+
+<property name="GtkTextTag:font-desc">
+<description>
+Font description as a `PangoFontDescription`.
</description>
</property>
@@ -14894,9 +17011,30 @@ OpenType font features, as a string.
</description>
</property>
+<property name="GtkTextTag:foreground">
+<description>
+Foreground color as a string.
+
+</description>
+</property>
+
<property name="GtkTextTag:foreground-rgba">
<description>
-Foreground color as a #GdkRGBA.
+Foreground color as a `GdkRGBA`.
+
+</description>
+</property>
+
+<property name="GtkTextTag:indent">
+<description>
+Amount to indent the paragraph, in pixels.
+
+</description>
+</property>
+
+<property name="GtkTextTag:insert-hyphens">
+<description>
+Whether to insert hyphens at breaks.
</description>
</property>
@@ -14905,21 +17043,36 @@ Foreground color as a #GdkRGBA.
<description>
Whether this text is hidden.
-Note that there may still be problems with the support for invisible
+Note that there may still be problems with the support for invisible
text, in particular when navigating programmatically inside a buffer
-containing invisible segments.
+containing invisible segments.
+
+</description>
+</property>
+
+<property name="GtkTextTag:justification">
+<description>
+Left, right, or center justification.
</description>
</property>
<property name="GtkTextTag:language">
<description>
-The language this text is in, as an ISO code. Pango can use this as a
-hint when rendering the text. If not set, an appropriate default will be
-used.
+The language this text is in, as an ISO code.
+
+Pango can use this as a hint when rendering the text.
+If not set, an appropriate default will be used.
-Note that the initial value of this property depends on the current
-locale, see also gtk_get_default_language().
+Note that the initial value of this property depends
+on the current locale, see also [func@Gtk.get_default_language].
+
+</description>
+</property>
+
+<property name="GtkTextTag:left-margin">
+<description>
+Width of the left margin in pixels.
</description>
</property>
@@ -14931,6 +17084,31 @@ Extra spacing between graphemes, in Pango units.
</description>
</property>
+<property name="GtkTextTag:name">
+<description>
+The name used to refer to the tag.
+
+%NULL for anonymous tags.
+
+</description>
+</property>
+
+<property name="GtkTextTag:overline">
+<description>
+Style of overline for this text.
+
+</description>
+</property>
+
+<property name="GtkTextTag:overline-rgba">
+<description>
+This property modifies the color of overlines.
+
+If not set, overlines will use the foreground color.
+
+</description>
+</property>
+
<property name="GtkTextTag:paragraph-background">
<description>
The paragraph background color as a string.
@@ -14940,48 +17118,175 @@ The paragraph background color as a string.
<property name="GtkTextTag:paragraph-background-rgba">
<description>
-The paragraph background color as a #GdkRGBA.
+The paragraph background color as a `GdkRGBA`.
+
+</description>
+</property>
+
+<property name="GtkTextTag:pixels-above-lines">
+<description>
+Pixels of blank space above paragraphs.
+
+</description>
+</property>
+
+<property name="GtkTextTag:pixels-below-lines">
+<description>
+Pixels of blank space below paragraphs.
+
+</description>
+</property>
+
+<property name="GtkTextTag:pixels-inside-wrap">
+<description>
+Pixels of blank space between wrapped lines in a paragraph.
+
+</description>
+</property>
+
+<property name="GtkTextTag:right-margin">
+<description>
+Width of the right margin, in pixels.
+
+</description>
+</property>
+
+<property name="GtkTextTag:rise">
+<description>
+Offset of text above the baseline, in Pango units.
+
+Negative values go below the baseline.
+
+</description>
+</property>
+
+<property name="GtkTextTag:scale">
+<description>
+Font size as a scale factor relative to the default font size.
+
+This properly adapts to theme changes, etc. so is recommended.
+Pango predefines some scales such as %PANGO_SCALE_X_LARGE.
+
+</description>
+</property>
+
+<property name="GtkTextTag:show-spaces">
+<description>
+How to render invisible characters.
+
+</description>
+</property>
+
+<property name="GtkTextTag:size">
+<description>
+Font size in Pango units.
+
+</description>
+</property>
+
+<property name="GtkTextTag:size-points">
+<description>
+Font size in points.
+
+</description>
+</property>
+
+<property name="GtkTextTag:stretch">
+<description>
+Font stretch as a `PangoStretch`, e.g. %PANGO_STRETCH_CONDENSED.
+
+</description>
+</property>
+
+<property name="GtkTextTag:strikethrough">
+<description>
+Whether to strike through the text.
</description>
</property>
<property name="GtkTextTag:strikethrough-rgba">
<description>
-This property modifies the color of strikeouts. If not set, strikeouts
-will use the foreground color.
+This property modifies the color of strikeouts.
+
+If not set, strikeouts will use the foreground color.
</description>
</property>
<property name="GtkTextTag:strikethrough-rgba-set">
<description>
-If the #GtkTextTag:strikethrough-rgba property has been set.
+If the `strikethrough-rgba` property has been set.
+
+</description>
+</property>
+
+<property name="GtkTextTag:style">
+<description>
+Font style as a `PangoStyle`, e.g. %PANGO_STYLE_ITALIC.
+
+</description>
+</property>
+
+<property name="GtkTextTag:tabs">
+<description>
+Custom tabs for this text.
+
+</description>
+</property>
+
+<property name="GtkTextTag:underline">
+<description>
+Style of underline for this text.
</description>
</property>
<property name="GtkTextTag:underline-rgba">
<description>
-This property modifies the color of underlines. If not set, underlines
-will use the foreground color.
+This property modifies the color of underlines.
-If #GtkTextTag:underline is set to %PANGO_UNDERLINE_ERROR, an alternate
-color may be applied instead of the foreground. Setting this property
-will always override those defaults.
+If not set, underlines will use the foreground color.
+
+If [property@Gtk.TextTag:underline] is set to %PANGO_UNDERLINE_ERROR,
+an alternate color may be applied instead of the foreground. Setting
+this property will always override those defaults.
</description>
</property>
<property name="GtkTextTag:underline-rgba-set">
<description>
-If the #GtkTextTag:underline-rgba property has been set.
+If the `underline-rgba` property has been set.
+
+</description>
+</property>
+
+<property name="GtkTextTag:variant">
+<description>
+Font variant as a `PangoVariant`, e.g. %PANGO_VARIANT_SMALL_CAPS.
+
+</description>
+</property>
+
+<property name="GtkTextTag:weight">
+<description>
+Font weight as an integer.
+
+</description>
+</property>
+
+<property name="GtkTextTag:wrap-mode">
+<description>
+Whether to wrap lines never, at word boundaries, or
+at character boundaries.
</description>
</property>
<signal name="GtkTextTagTable::tag-added">
<description>
-Emitted every time a new tag is added in the #GtkTextTagTable.
+Emitted every time a new tag is added in the `GtkTextTagTable`.
</description>
<parameters>
@@ -14999,7 +17304,7 @@ Emitted every time a new tag is added in the #GtkTextTagTable.
<signal name="GtkTextTagTable::tag-changed">
<description>
-Emitted every time a tag in the #GtkTextTagTable changes.
+Emitted every time a tag in the `GtkTextTagTable` changes.
</description>
<parameters>
@@ -15012,7 +17317,7 @@ Emitted every time a tag in the #GtkTextTagTable changes.
</parameter_description>
</parameter>
<parameter name="size_changed">
-<parameter_description> whether the change affects the #GtkTextView layout.
+<parameter_description> whether the change affects the `GtkTextView` layout.
</parameter_description>
</parameter>
</parameters>
@@ -15021,7 +17326,7 @@ Emitted every time a tag in the #GtkTextTagTable changes.
<signal name="GtkTextTagTable::tag-removed">
<description>
-Emitted every time a tag is removed from the #GtkTextTagTable.
+Emitted every time a tag is removed from the `GtkTextTagTable`.
The @tag is still valid by the time the signal is emitted, but
it is not associated with a tag table any more.
@@ -15042,12 +17347,12 @@ it is not associated with a tag table any more.
<signal name="GtkTextView::backspace">
<description>
-The ::backspace signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user asks for it.
+Gets emitted when the user asks for it.
+
+The ::backspace signal is a [keybinding signal](class.SignalAction.html).
The default bindings for this signal are
-Backspace and Shift-Backspace.
+<kbd>Backspace</kbd> and <kbd>Shift</kbd>-<kbd>Backspace</kbd>.
</description>
<parameters>
@@ -15061,12 +17366,13 @@ Backspace and Shift-Backspace.
<signal name="GtkTextView::copy-clipboard">
<description>
-The ::copy-clipboard signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to copy the selection to the clipboard.
+Gets emitted to copy the selection to the clipboard.
+
+The ::copy-clipboard signal is a [keybinding signal](class.SignalAction.html).
The default bindings for this signal are
-Ctrl-c and Ctrl-Insert.
+<kbd>Ctrl</kbd>-<kbd>c</kbd> and
+<kbd>Ctrl</kbd>-<kbd>Insert</kbd>.
</description>
<parameters>
@@ -15080,12 +17386,13 @@ Ctrl-c and Ctrl-Insert.
<signal name="GtkTextView::cut-clipboard">
<description>
-The ::cut-clipboard signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to cut the selection to the clipboard.
+Gets emitted to cut the selection to the clipboard.
+
+The ::cut-clipboard signal is a [keybinding signal](class.SignalAction.html).
The default bindings for this signal are
-Ctrl-x and Shift-Delete.
+<kbd>Ctrl</kbd>-<kbd>x</kbd> and
+<kbd>Shift</kbd>-<kbd>Delete</kbd>.
</description>
<parameters>
@@ -15099,18 +17406,18 @@ Ctrl-x and Shift-Delete.
<signal name="GtkTextView::delete-from-cursor">
<description>
-The ::delete-from-cursor signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user initiates a text deletion.
+Gets emitted when the user initiates a text deletion.
+
+The ::delete-from-cursor signal is a [keybinding signal](class.SignalAction.html).
-If the @type is %GTK_DELETE_CHARS, GTK+ deletes the selection
+If the @type is %GTK_DELETE_CHARS, GTK deletes the selection
if there is one, otherwise it deletes the requested number
of characters.
-The default bindings for this signal are
-Delete for deleting a character, Ctrl-Delete for
-deleting a word and Ctrl-Backspace for deleting a word
-backwards.
+The default bindings for this signal are <kbd>Delete</kbd> for
+deleting a character, <kbd>Ctrl</kbd>-<kbd>Delete</kbd> for
+deleting a word and <kbd>Ctrl</kbd>-<kbd>Backspace</kbd> for
+deleting a word backwards.
</description>
<parameters>
@@ -15132,8 +17439,7 @@ backwards.
<signal name="GtkTextView::extend-selection">
<description>
-The ::extend-selection signal is emitted when the selection needs to be
-extended at @location.
+Emitted when the selection needs to be extended at @location.
</description>
@@ -15166,11 +17472,11 @@ event. %GDK_EVENT_PROPAGATE to propagate the event further.
<signal name="GtkTextView::insert-at-cursor">
<description>
-The ::insert-at-cursor signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user initiates the insertion of a
+Gets emitted when the user initiates the insertion of a
fixed string at the cursor.
+The ::insert-at-cursor signal is a [keybinding signal](class.SignalAction.html).
+
This signal has no default bindings.
</description>
@@ -15189,11 +17495,13 @@ This signal has no default bindings.
<signal name="GtkTextView::insert-emoji">
<description>
-The ::insert-emoji signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to present the Emoji chooser for the @text_view.
+Gets emitted to present the Emoji chooser for the @text_view.
+
+The ::insert-emoji signal is a [keybinding signal](class.SignalAction.html).
-The default bindings for this signal are Ctrl-. and Ctrl-;
+The default bindings for this signal are
+<kbd>Ctrl</kbd>-<kbd>.</kbd> and
+<kbd>Ctrl</kbd>-<kbd>;</kbd>
</description>
<parameters>
@@ -15207,25 +17515,29 @@ The default bindings for this signal are Ctrl-. and Ctrl-;
<signal name="GtkTextView::move-cursor">
<description>
-The ::move-cursor signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user initiates a cursor movement.
+Gets emitted when the user initiates a cursor movement.
+
+The ::move-cursor signal is a [keybinding signal](class.SignalAction.html).
If the cursor is not visible in @text_view, this signal causes
the viewport to be moved instead.
-Applications should not connect to it, but may emit it with
+Applications should not connect to it, but may emit it with
g_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 Shift modifier extends the selection,
-the variant without the Shift modifier does not.
+the variant with the <kbd>Shift</kbd> modifier extends the
+selection, the variant without it does not.
There are too many key combinations to list them all here.
-- Arrow keys move by individual characters/lines
-- Ctrl-arrow key combinations move by words/paragraphs
-- Home/End keys move to the ends of the buffer
-- PageUp/PageDown keys move vertically by pages
-- Ctrl-PageUp/PageDown keys move horizontally by pages
+
+- <kbd>←</kbd>, <kbd>→</kbd>, <kbd>↑</kbd>, <kbd>↓</kbd>
+move by individual characters/lines
+- <kbd>Ctrl</kbd>-<kbd>→</kbd>, etc. move by words/paragraphs
+- <kbd>Home</kbd>, <kbd>End</kbd> move to the ends of the buffer
+- <kbd>PgUp</kbd>, <kbd>PgDn</kbd> move vertically by pages
+- <kbd>Ctrl</kbd>-<kbd>PgUp</kbd>,
<kbd>Ctrl</kbd>-<kbd>PgDn</kbd>
+move horizontally by pages
</description>
<parameters>
@@ -15251,11 +17563,12 @@ There are too many key combinations to list them all here.
<signal name="GtkTextView::move-viewport">
<description>
-The ::move-viewport signal is a
-[keybinding signal][GtkSignalAction]
-which can be bound to key combinations to allow the user
-to move the viewport, i.e. change what part of the text view
-is visible in a containing scrolled window.
+Gets emitted to move the viewport.
+
+The ::move-viewport signal is a [keybinding signal](class.SignalAction.html),
+which can be bound to key combinations to allow the user to move the viewport,
+i.e. change what part of the text view is visible in a containing scrolled
+window.
There are no default bindings for this signal.
@@ -15279,13 +17592,14 @@ There are no default bindings for this signal.
<signal name="GtkTextView::paste-clipboard">
<description>
-The ::paste-clipboard signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to paste the contents of the clipboard
+Gets emitted to paste the contents of the clipboard
into the text view.
+The ::paste-clipboard signal is a [keybinding signal](class.SignalAction.html).
+
The default bindings for this signal are
-Ctrl-v and Shift-Insert.
+<kbd>Ctrl</kbd>-<kbd>v</kbd> and
+<kbd>Shift</kbd>-<kbd>Insert</kbd>.
</description>
<parameters>
@@ -15299,6 +17613,8 @@ Ctrl-v and Shift-Insert.
<signal name="GtkTextView::preedit-changed">
<description>
+Emitted when preedit text of the active IM changes.
+
If an input method is used, the typed text will not immediately
be committed to the buffer. So if you are interested in the text,
connect to this signal.
@@ -15322,13 +17638,15 @@ is actually editable.
<signal name="GtkTextView::select-all">
<description>
-The ::select-all signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to select or unselect the complete
-contents of the text view.
+Gets emitted to select or unselect the complete contents of the text view.
+
+The ::select-all signal is a [keybinding signal](class.SignalAction.html).
-The default bindings for this signal are Ctrl-a and Ctrl-/
-for selecting and Shift-Ctrl-a and Ctrl-\ for unselecting.
+The default bindings for this signal are
+<kbd>Ctrl</kbd>-<kbd>a</kbd> and
+<kbd>Ctrl</kbd>-<kbd>/</kbd> for selecting and
+<kbd>Shift</kbd>-<kbd>Ctrl</kbd>-<kbd>a</kbd> and
+<kbd>Ctrl</kbd>-<kbd>\</kbd> for unselecting.
</description>
<parameters>
@@ -15346,9 +17664,10 @@ for selecting and Shift-Ctrl-a and Ctrl-\ for unselecting.
<signal name="GtkTextView::set-anchor">
<description>
-The ::set-anchor signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user initiates setting the "anchor"
+Gets emitted when the user initiates settings the "anchor" mark.
+
+The ::set-anchor signal is a [keybinding signal](class.SignalAction.html)
+which gets emitted when the user initiates setting the "anchor"
mark. The "anchor" mark gets placed at the same position as the
"insert" mark.
@@ -15366,12 +17685,12 @@ This signal has no default bindings.
<signal name="GtkTextView::toggle-cursor-visible">
<description>
+Gets emitted to toggle the `cursor-visible` property.
+
The ::toggle-cursor-visible signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to toggle the #GtkTextView:cursor-visible
-property.
+[keybinding signal](class.SignalAction.html).
-The default binding for this signal is F7.
+The default binding for this signal is <kbd>F7</kbd>.
</description>
<parameters>
@@ -15385,11 +17704,11 @@ The default binding for this signal is F7.
<signal name="GtkTextView::toggle-overwrite">
<description>
-The ::toggle-overwrite signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted to toggle the overwrite mode of the text view.
+Gets emitted to toggle the overwrite mode of the text view.
+
+The ::toggle-overwrite signal is a [keybinding signal](class.SignalAction.html).
-The default bindings for this signal is Insert.
+The default binding for this signal is <kbd>Insert</kbd>.
</description>
<parameters>
@@ -15401,6 +17720,13 @@ The default bindings for this signal is Insert.
<return></return>
</signal>
+<property name="GtkTextView:accepts-tab">
+<description>
+Whether Tab will result in a tab character being entered.
+
+</description>
+</property>
+
<property name="GtkTextView:bottom-margin">
<description>
The bottom margin for text in the text view.
@@ -15409,27 +17735,55 @@ Note that this property is confusingly named. In CSS terms,
the value set here is padding, and it is applied in addition
to the padding from the theme.
-Don't confuse this property with #GtkWidget:margin-bottom.
+Don't confuse this property with [property@Gtk.Widget:margin-bottom].
+
+</description>
+</property>
+
+<property name="GtkTextView:buffer">
+<description>
+The buffer which is displayed.
+
+</description>
+</property>
+
+<property name="GtkTextView:cursor-visible">
+<description>
+If the insertion cursor is shown.
+
+</description>
+</property>
+
+<property name="GtkTextView:extra-menu">
+<description>
+A menu model whose contents will be appended to the context menu.
</description>
</property>
<property name="GtkTextView:im-module">
<description>
-Which IM (input method) module should be used for this text_view.
-See #GtkIMContext.
+Which IM (input method) module should be used for this text_view.
+
+See [class@Gtk.IMContext].
+
+Setting this to a non-%NULL value overrides the system-wide IM module
+setting. See the GtkSettings [property@Gtk.Settings:gtk-im-module] property.
+
+</description>
+</property>
-Setting this to a non-%NULL value overrides the
-system-wide IM module setting. See the GtkSettings
-#GtkSettings:gtk-im-module property.
+<property name="GtkTextView:indent">
+<description>
+Amount to indent the paragraph, in pixels.
</description>
</property>
<property name="GtkTextView:input-hints">
<description>
-Additional hints (beyond #GtkTextView:input-purpose) that
-allow input methods to fine-tune their behaviour.
+Additional hints (beyond [property@Gtk.TextView:input-purpose])
+that allow input methods to fine-tune their behaviour.
</description>
</property>
@@ -15447,6 +17801,7 @@ methods to adjust their behaviour.
<property name="GtkTextView:left-margin">
<description>
The default left margin for text in the text view.
+
Tags in the buffer may override the default.
Note that this property is confusingly named. In CSS terms,
@@ -15458,15 +17813,25 @@ to the padding from the theme.
<property name="GtkTextView:monospace">
<description>
+Whether text should be displayed in a monospace font.
+
If %TRUE, set the .monospace style class on the
text view to indicate that a monospace font is desired.
</description>
</property>
+<property name="GtkTextView:overwrite">
+<description>
+Whether entered text overwrites existing contents.
+
+</description>
+</property>
+
<property name="GtkTextView:right-margin">
<description>
The default right margin for text in the text view.
+
Tags in the buffer may override the default.
Note that this property is confusingly named. In CSS terms,
@@ -15484,7 +17849,7 @@ Note that this property is confusingly named. In CSS terms,
the value set here is padding, and it is applied in addition
to the padding from the theme.
-Don't confuse this property with #GtkWidget:margin-top.
+Don't confuse this property with [property@Gtk.Widget:margin-top].
</description>
</property>
@@ -15548,10 +17913,58 @@ Used to reference the parts of #GtkTextView.
</parameters>
</enum>
+<property name="GtkTextview:editable">
+<description>
+Whether the text can be modified by the user.
+
+</description>
+</property>
+
+<property name="GtkTextview:justification">
+<description>
+Left, right, or center justification.
+
+</description>
+</property>
+
+<property name="GtkTextview:pixels-above-lines">
+<description>
+Pixels of blank space above paragraphs.
+
+</description>
+</property>
+
+<property name="GtkTextview:pixels-below-lines">
+<description>
+Pixels of blank space below paragraphs.
+
+</description>
+</property>
+
+<property name="GtkTextview:pixels-inside-wrap">
+<description>
+Pixels of blank space between wrapped lines in a paragraph.
+
+</description>
+</property>
+
+<property name="GtkTextview:tabs">
+<description>
+Custom tabs for this text.
+
+</description>
+</property>
+
+<property name="GtkTextview:wrap-mode">
+<description>
+Whether to wrap lines never, at word boundaries, or at character boundaries.
+
+</description>
+</property>
+
<signal name="GtkToggleButton::toggled">
<description>
-Should be connected if you wish to perform an action whenever the
-#GtkToggleButton's state is changed.
+Emitted whenever the `GtkToggleButton`'s state is changed.
</description>
<parameters>
@@ -15563,46 +17976,62 @@ Should be connected if you wish to perform an action whenever the
<return></return>
</signal>
+<property name="GtkToggleButton:active">
+<description>
+If the toggle button should be pressed in.
+
+</description>
+</property>
+
+<property name="GtkToggleButton:group">
+<description>
+The toggle button whose group this widget belongs to.
+
+</description>
+</property>
+
<property name="GtkTreeExpander:child">
<description>
-The child widget with the actual contents
+The child widget with the actual contents.
</description>
</property>
<property name="GtkTreeExpander:item">
<description>
-The item held by this expander's row
+The item held by this expander's row.
</description>
</property>
<property name="GtkTreeExpander:list-row">
<description>
-The list row to track for expander state
+The list row to track for expander state.
</description>
</property>
<property name="GtkTreeListModel:autoexpand">
<description>
-If all rows should be expanded by default
+If all rows should be expanded by default.
</description>
</property>
<property name="GtkTreeListModel:model">
<description>
-The root model displayed
+The root model displayed.
</description>
</property>
<property name="GtkTreeListModel:passthrough">
<description>
-If %FALSE, the #GListModel functions for this object return custom
-#GtkTreeListRow objects.
-If %TRUE, the values of the child models are pass through unmodified.
+Gets whether the model is in passthrough mode.
+
+If %FALSE, the `GListModel` functions for this object return custom
+[class@Gtk.TreeListRow] objects. If %TRUE, the values of the child
+models are pass through unmodified.
</description>
</property>
@@ -15616,28 +18045,28 @@ The model holding the row's children.
<property name="GtkTreeListRow:depth">
<description>
-The depth in the tree of this row
+The depth in the tree of this row.
</description>
</property>
<property name="GtkTreeListRow:expandable">
<description>
-If this row can ever be expanded
+If this row can ever be expanded.
</description>
</property>
<property name="GtkTreeListRow:expanded">
<description>
-If this row is currently expanded
+If this row is currently expanded.
</description>
</property>
<property name="GtkTreeListRow:item">
<description>
-The item held in this row
+The item held in this row.
</description>
</property>
@@ -16262,12 +18691,26 @@ The media-stream played
</description>
</property>
+<property name="GtkViewport:child">
+<description>
+The child widget.
+
+</description>
+</property>
+
+<property name="GtkViewport:scroll-to-focus">
+<description>
+Whether to scroll when the focus changes.
+
+</description>
+</property>
+
<property name="GtkVolumeButton:use-symbolic">
<description>
-Whether to use symbolic icons as the icons. Note that
-if the symbolic icons are not available in your installed
-theme, then the normal (potentially colorful) icons will
-be used.
+Whether to use symbolic icons as the icons.
+
+Note that if the symbolic icons are not available in your installed
+theme, then the normal (potentially colorful) icons will be used.
</description>
</property>
@@ -16275,8 +18718,9 @@ be used.
<signal name="GtkWidget::destroy">
<description>
Signals that all holders of a reference to the widget should release
-the reference that they hold. May result in finalization of the widget
-if all references are released.
+the reference that they hold.
+
+May result in finalization of the widget if all references are released.
This signal is not suitable for saving widget state.
@@ -16292,8 +18736,7 @@ This signal is not suitable for saving widget state.
<signal name="GtkWidget::direction-changed">
<description>
-The ::direction-changed signal is emitted when the text direction
-of a widget changes.
+Emitted when the text direction of a widget changes.
</description>
<parameters>
@@ -16311,8 +18754,7 @@ of a widget changes.
<signal name="GtkWidget::hide">
<description>
-The ::hide signal is emitted when @widget is hidden, for example with
-gtk_widget_hide().
+Emitted when @widget is hidden.
</description>
<parameters>
@@ -16326,8 +18768,9 @@ gtk_widget_hide().
<signal name="GtkWidget::keynav-failed">
<description>
-Gets emitted if keyboard navigation fails.
-See gtk_widget_keynav_failed() for details.
+Emitted if keyboard navigation fails.
+
+See [method@Gtk.Widget.keynav_failed] for details.
</description>
@@ -16349,14 +18792,15 @@ navigation attempt in its parent widget(s).
<signal name="GtkWidget::map">
<description>
-The ::map signal is emitted when @widget is going to be mapped, that is
-when the widget is visible (which is controlled with
-gtk_widget_set_visible()) and all its parents up to the toplevel widget
+Emitted when @widget is going to be mapped.
+
+A widget is mapped when the widget is visible (which is controlled with
+[property@Gtk.Widget:visible]) and all its parents up to the toplevel widget
are also visible.
The ::map signal can be used to determine whether a widget will be drawn,
for instance it can resume an animation that was stopped during the
-emission of #GtkWidget::unmap.
+emission of [signal@Gtk.Widget::unmap].
</description>
<parameters>
@@ -16370,6 +18814,8 @@ emission of #GtkWidget::unmap.
<signal name="GtkWidget::mnemonic-activate">
<description>
+Emitted when a widget is activated via a mnemonic.
+
The default handler for this signal activates @widget if @group_cycling
is %FALSE, or just makes @widget grab focus if @group_cycling is %TRUE.
@@ -16410,9 +18856,11 @@ Emitted when the focus is moved.
<signal name="GtkWidget::query-tooltip">
<description>
-Emitted when #GtkWidget:has-tooltip is %TRUE and the hover timeout
-has expired with the cursor hovering "above" @widget; or emitted when @widget got
-focus in keyboard mode.
+Emitted when the widgets tooltip is about to be shown.
+
+This happens when the [property@Gtk.Widget:has-tooltip] property
+is %TRUE and the hover timeout has expired with the cursor hovering
+"above" @widget; or emitted when @widget got focus in keyboard mode.
Using the given coordinates, the signal handler should determine
whether a tooltip should be shown for @widget. If this is the case
@@ -16455,9 +18903,10 @@ been emitted, relative to @widget's top
<signal name="GtkWidget::realize">
<description>
-The ::realize signal is emitted when @widget is associated with a
-#GdkSurface, which means that gtk_widget_realize() has been called or the
-widget has been mapped (that is, it is going to be drawn).
+Emitted when @widget is associated with a `GdkSurface`.
+
+This means that [method@Gtk.Widget.realize] has been called
+or the widget has been mapped (that is, it is going to be drawn).
</description>
<parameters>
@@ -16471,8 +18920,7 @@ widget has been mapped (that is, it is going to be drawn).
<signal name="GtkWidget::show">
<description>
-The ::show signal is emitted when @widget is shown, for example with
-gtk_widget_show().
+Emitted when @widget is shown.
</description>
<parameters>
@@ -16486,8 +18934,9 @@ gtk_widget_show().
<signal name="GtkWidget::state-flags-changed">
<description>
-The ::state-flags-changed signal is emitted when the widget state
-changes, see gtk_widget_get_state_flags().
+Emitted when the widget state changes.
+
+See [method@Gtk.Widget.get_state_flags].
</description>
<parameters>
@@ -16505,12 +18954,13 @@ changes, see gtk_widget_get_state_flags().
<signal name="GtkWidget::unmap">
<description>
-The ::unmap signal is emitted when @widget is going to be unmapped, which
-means that either it or any of its parents up to the toplevel widget have
-been set as hidden.
+Emitted when @widget is going to be unmapped.
+
+A widget is unmapped when either it or any of its parents up to the
+toplevel widget have been set as hidden.
-As ::unmap indicates that a widget will not be shown any longer, it can be
-used to, for example, stop an animation on the widget.
+As ::unmap indicates that a widget will not be shown any longer,
+it can be used to, for example, stop an animation on the widget.
</description>
<parameters>
@@ -16524,10 +18974,10 @@ used to, for example, stop an animation on the widget.
<signal name="GtkWidget::unrealize">
<description>
-The ::unrealize signal is emitted when the #GdkSurface associated with
-@widget is destroyed, which means that gtk_widget_unrealize() has been
-called or the widget has been unmapped (that is, it is going to be
-hidden).
+Emitted when the `GdkSurface` associated with @widget is destroyed.
+
+This means that [method@Gtk.Widget.unrealize] has been called
+or the widget has been unmapped (that is, it is going to be hidden).
</description>
<parameters>
@@ -16550,6 +19000,13 @@ typically in their instance init function.
</description>
</property>
+<property name="GtkWidget:can-target">
+<description>
+Whether the widget can receive pointer events.
+
+</description>
+</property>
+
<property name="GtkWidget:css-classes">
<description>
A list of css classes applied to this widget.
@@ -16569,7 +19026,7 @@ typically in their instance init function.
<property name="GtkWidget:cursor">
<description>
-The cursor used by @widget. See gtk_widget_set_cursor() for details.
+The cursor used by @widget.
</description>
</property>
@@ -16592,38 +19049,62 @@ Whether this widget itself will accept the input focus.
<property name="GtkWidget:halign">
<description>
-How to distribute horizontal space if widget gets extra space, see #GtkAlign
+How to distribute horizontal space if widget gets extra space.
+
+</description>
+</property>
+
+<property name="GtkWidget:has-default">
+<description>
+Whether the widget is the default widget.
+
+</description>
+</property>
+
+<property name="GtkWidget:has-focus">
+<description>
+Whether the widget has the input focus.
</description>
</property>
<property name="GtkWidget:has-tooltip">
<description>
-Enables or disables the emission of #GtkWidget::query-tooltip on @widget.
+Enables or disables the emission of the ::query-tooltip signal on @widget.
+
A value of %TRUE indicates that @widget can have a tooltip, in this case
-the widget will be queried using #GtkWidget::query-tooltip to determine
-whether it will provide a tooltip or not.
+the widget will be queried using [signal@Gtk.Widget::query-tooltip] to
+determine whether it will provide a tooltip or not.
+
+</description>
+</property>
+
+<property name="GtkWidget:height-request">
+<description>
+Override for height request of the widget.
+
+If this is -1, the natural request will be used.
</description>
</property>
<property name="GtkWidget:hexpand">
<description>
-Whether to expand horizontally. See gtk_widget_set_hexpand().
+Whether to expand horizontally.
</description>
</property>
<property name="GtkWidget:hexpand-set">
<description>
-Whether to use the #GtkWidget:hexpand property. See gtk_widget_get_hexpand_set().
+Whether to use the `hexpand` property.
</description>
</property>
<property name="GtkWidget:layout-manager">
<description>
-The #GtkLayoutManager instance to use to compute the preferred size
+The `GtkLayoutManager` instance to use to compute the preferred size
of the widget, and allocate its children.
This property is meant to be set by widget implementations,
@@ -16638,31 +19119,35 @@ Margin on bottom side of widget.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
-gtk_widget_set_size_request() for example.
+[method@Gtk.Widget.set_size_request] for example.
</description>
</property>
<property name="GtkWidget:margin-end">
<description>
-Margin on end of widget, horizontally. This property supports
-left-to-right and right-to-left text directions.
+Margin on end of widget, horizontally.
+
+This property supports left-to-right and right-to-left text
+directions.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
-gtk_widget_set_size_request() for example.
+[method@Gtk.Widget.set_size_request] for example.
</description>
</property>
<property name="GtkWidget:margin-start">
<description>
-Margin on start of widget, horizontally. This property supports
-left-to-right and right-to-left text directions.
+Margin on start of widget, horizontally.
+
+This property supports left-to-right and right-to-left text
+directions.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
-gtk_widget_set_size_request() for example.
+[method@Gtk.Widget.set_size_request] for example.
</description>
</property>
@@ -16673,15 +19158,21 @@ Margin on top side of widget.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
-gtk_widget_set_size_request() for example.
+[method@Gtk.Widget.set_size_request] for example.
+
+</description>
+</property>
+
+<property name="GtkWidget:name">
+<description>
+The name of the widget.
</description>
</property>
<property name="GtkWidget:opacity">
<description>
-The requested opacity of the widget. See gtk_widget_set_opacity() for
-more details about window opacity.
+The requested opacity of the widget.
</description>
</property>
@@ -16696,18 +19187,39 @@ typically in their instance init function.
</description>
</property>
+<property name="GtkWidget:parent">
+<description>
+The parent widget of this widget.
+
+</description>
+</property>
+
+<property name="GtkWidget:receives-default">
+<description>
+Whether the widget will receive the default action when it is focused.
+
+</description>
+</property>
+
<property name="GtkWidget:root">
<description>
-The #GtkRoot widget of the widget tree containing this widget or %NULL if
-the widget is not contained in a root widget.
+The `GtkRoot` widget of the widget tree containing this widget.
+
+This will be %NULL if the widget is not contained in a root widget.
</description>
</property>
<property name="GtkWidget:scale-factor">
<description>
-The scale factor of the widget. See gtk_widget_get_scale_factor() for
-more details about widget scaling.
+The scale factor of the widget.
+
+</description>
+</property>
+
+<property name="GtkWidget:sensitive">
+<description>
+Whether the widget responds to input.
</description>
</property>
@@ -16715,16 +19227,18 @@ more details about widget scaling.
<property name="GtkWidget:tooltip-markup">
<description>
Sets the text of tooltip to be the given string, which is marked up
-with the [Pango text markup language][PangoMarkupFormat].
-Also see gtk_tooltip_set_markup().
+with Pango markup.
+
+Also see [method@Gtk.Tooltip.set_markup].
This is a convenience property which will take care of getting the
-tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip
-will automatically be set to %TRUE and there will be taken care of
-#GtkWidget::query-tooltip in the default signal handler.
+tooltip shown if the given string is not %NULL:
+[property@Gtk.Widget:has-tooltip] will automatically be set to %TRUE
+and there will be taken care of [signal@Gtk.Widget::query-tooltip] in
+the default signal handler.
-Note that if both #GtkWidget:tooltip-text and #GtkWidget:tooltip-markup
-are set, the last one wins.
+Note that if both [property@Gtk.Widget:tooltip-text] and
+[property@Gtk.Widget:tooltip-markup] are set, the last one wins.
</description>
</property>
@@ -16733,36 +19247,53 @@ are set, the last one wins.
<description>
Sets the text of tooltip to be the given string.
-Also see gtk_tooltip_set_text().
+Also see [method@Gtk.Tooltip.set_text].
This is a convenience property which will take care of getting the
-tooltip shown if the given string is not %NULL: #GtkWidget:has-tooltip
-will automatically be set to %TRUE and there will be taken care of
-#GtkWidget::query-tooltip in the default signal handler.
+tooltip shown if the given string is not %NULL:
+[property@Gtk.Widget:has-tooltip] will automatically be set to %TRUE
+and there will be taken care of [signal@Gtk.Widget::query-tooltip] in
+the default signal handler.
-Note that if both #GtkWidget:tooltip-text and #GtkWidget:tooltip-markup
-are set, the last one wins.
+Note that if both [property@Gtk.Widget:tooltip-text] and
+[property@Gtk.Widget:tooltip-markup] are set, the last one wins.
</description>
</property>
<property name="GtkWidget:valign">
<description>
-How to distribute vertical space if widget gets extra space, see #GtkAlign
+How to distribute vertical space if widget gets extra space.
</description>
</property>
<property name="GtkWidget:vexpand">
<description>
-Whether to expand vertically. See gtk_widget_set_vexpand().
+Whether to expand vertically.
</description>
</property>
<property name="GtkWidget:vexpand-set">
<description>
-Whether to use the #GtkWidget:vexpand property. See gtk_widget_get_vexpand_set().
+Whether to use the `vexpand` property.
+
+</description>
+</property>
+
+<property name="GtkWidget:visible">
+<description>
+Whether the widget is visible.
+
+</description>
+</property>
+
+<property name="GtkWidget:width-request">
+<description>
+Override for width request of the widget.
+
+If this is -1, the natural request will be used.
</description>
</property>
@@ -16776,11 +19307,11 @@ The observed widget or %NULL if none.
<signal name="GtkWindow::activate-default">
<description>
-The ::activate-default signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user activates the default widget
+Emitted when the user activates the default widget
of @window.
+This is a [keybinding signal](class.SignalAction.html).
+
</description>
<parameters>
<parameter name="window">
@@ -16793,10 +19324,10 @@ of @window.
<signal name="GtkWindow::activate-focus">
<description>
-The ::activate-focus signal is a
-[keybinding signal][GtkSignalAction]
-which gets emitted when the user activates the currently
-focused widget of @window.
+Emitted when the user activates the currently focused
+widget of @window.
+
+This is a [keybinding signal](class.SignalAction.html).
</description>
<parameters>
@@ -16810,8 +19341,7 @@ focused widget of @window.
<signal name="GtkWindow::close-request">
<description>
-The ::close-request signal is emitted when the user clicks on the close
-button of the window.
+Emitted when the user clicks on the close button of the window.
Return: %TRUE to stop other handlers from being invoked for the signal
@@ -16827,11 +19357,13 @@ Return: %TRUE to stop other handlers from being invoked for the signal
<signal name="GtkWindow::enable-debugging">
<description>
-The ::enable-debugging signal is a [keybinding signal][GtkSignalAction]
-which gets 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 under the pointer.
+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
+under the pointer.
+
+This is a [keybinding signal](class.SignalAction.html).
The default bindings for this signal are Ctrl-Shift-I
and Ctrl-Shift-D.
@@ -16854,8 +19386,8 @@ Return: %TRUE if the key binding was handled
<signal name="GtkWindow::keys-changed">
<description>
-The ::keys-changed signal gets 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 @window changes.
</description>
<parameters>
@@ -16869,7 +19401,7 @@ or mnemonics that are associated with @window changes.
<property name="GtkWindow:application">
<description>
-The #GtkApplication associated with the window.
+The `GtkApplication` 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()
@@ -16882,9 +19414,37 @@ remove it by setting the :application property to %NULL.
</description>
</property>
+<property name="GtkWindow:child">
+<description>
+The child widget.
+
+</description>
+</property>
+
<property name="GtkWindow:decorated">
<description>
-Whether the window should be decorated by the window manager.
+Whether the window should have a frame (also known as *decorations*).
+
+</description>
+</property>
+
+<property name="GtkWindow:default-height">
+<description>
+The default height of the window.
+
+</description>
+</property>
+
+<property name="GtkWindow:default-widget">
+<description>
+The default widget.
+
+</description>
+</property>
+
+<property name="GtkWindow:default-width">
+<description>
+The default width of the window.
</description>
</property>
@@ -16896,6 +19456,20 @@ Whether the window frame should have a close button.
</description>
</property>
+<property name="GtkWindow:destroy-with-parent">
+<description>
+If this window should be destroyed when the parent is destroyed.
+
+</description>
+</property>
+
+<property name="GtkWindow:display">
+<description>
+The display that will display this window.
+
+</description>
+</property>
+
<property name="GtkWindow:focus-visible">
<description>
Whether 'focus rectangles' are currently visible in this window.
@@ -16906,22 +19480,55 @@ and should not be set by applications.
</description>
</property>
+<property name="GtkWindow:focus-widget">
+<description>
+The focus widget.
+
+</description>
+</property>
+
<property name="GtkWindow:fullscreened">
<description>
Whether the window is fullscreen.
-Setting this property is the equivalent of calling gtk_window_fullscreen()
-and gtk_window_unfullscreen(); either operation is asynchronous, which
-means you will need to connect to the #GObject::notify signal in order to
-know whether the operation was successful.
+Setting this property is the equivalent of calling
+[method@Gtk.Window.fullscreen] or [method@Gtk.Window.unfullscreen];
+either operation is asynchronous, which means you will need to
+connect to the ::notify signal in order to know whether the
+operation was successful.
+
+</description>
+</property>
+
+<property name="GtkWindow:handle-menubar-accel">
+<description>
+Whether the window frame should handle F10 for activating
+menubars.
+
+Since: 4.2
+
+</description>
+</property>
+
+<property name="GtkWindow:hide-on-close">
+<description>
+If this window should be hidden when the users clicks the close button.
</description>
</property>
<property name="GtkWindow:icon-name">
<description>
-The :icon-name property specifies the name of the themed icon to
-use as the window icon. See #GtkIconTheme for more details.
+Specifies the name of the themed icon to use as the window icon.
+
+See [class@Gtk.IconTheme] for more details.
+
+</description>
+</property>
+
+<property name="GtkWindow:is-active">
+<description>
+Whether the toplevel is the currently active window.
</description>
</property>
@@ -16930,10 +19537,11 @@ use as the window icon. See #GtkIconTheme for more details.
<description>
Whether the window is maximized.
-Setting this property is the equivalent of calling gtk_window_maximize()
-and gtk_window_unmaximize(); either operation is asynchronous, which
-means you will need to connect to the #GObject::notify signal in order to
-know whether the operation was successful.
+Setting this property is the equivalent of calling
+[method@Gtk.Window.maximize] or [method@Gtk.Window.unmaximize];
+either operation is asynchronous, which means you will need to
+connect to the ::notify signal in order to know whether the
+operation was successful.
</description>
</property>
@@ -16948,30 +19556,47 @@ and should not be set by applications.
</description>
</property>
+<property name="GtkWindow:modal">
+<description>
+If %TRUE, the window is modal.
+
+</description>
+</property>
+
+<property name="GtkWindow:resizable">
+<description>
+If %TRUE, users can resize the window.
+
+</description>
+</property>
+
<property name="GtkWindow:startup-id">
<description>
-The :startup-id is a write-only property for setting window's
-startup notification identifier. See gtk_window_set_startup_id()
-for more details.
+A write-only property for setting window's startup notification identifier.
+
+</description>
+</property>
+
+<property name="GtkWindow:title">
+<description>
+The title of the window.
</description>
</property>
<property name="GtkWindow:transient-for">
<description>
-The transient parent of the window. See gtk_window_set_transient_for() for
-more details about transient windows.
+The transient parent of the window.
</description>
</property>
<property name="GtkWindowControls:decoration-layout">
<description>
-The decoration layout for window buttons. If this property is not set,
-the #GtkSettings:gtk-decoration-layout setting is used.
+The decoration layout for window buttons.
-See gtk_window_controls_set_decoration_layout() for information
-about the format of this string.
+If this property is not set, the
+[property@Gtk.Settings:gtk-decoration-layout] setting is used.
</description>
</property>
@@ -16987,7 +19612,14 @@ Whether the widget has any window buttons.
<description>
Whether the widget shows start or end side of the decoration layout.
-See gtk_window_controls_set_decoration_layout().
+See [property@Gtk.WindowControls:decoration_layout].
+
+</description>
+</property>
+
+<property name="GtkWindowHandle:child">
+<description>
+The child widget.
</description>
</property>
@@ -17062,12 +19694,12 @@ freeze and thaw calls are balanced.
<function name="gtk_about_dialog_add_credit_section">
<description>
-Creates a new section in the Credits page.
+Creates a new section in the "Credits" page.
</description>
<parameters>
<parameter name="about">
-<parameter_description> A #GtkAboutDialog
+<parameter_description> A `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="section_name">
@@ -17084,19 +19716,19 @@ Creates a new section in the Credits page.
<function name="gtk_about_dialog_get_artists">
<description>
-Returns the string which are displayed in the artists tab
+Returns the string which are displayed in the "Artists" tab
of the secondary credits dialog.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
</parameters>
<return> A
-%NULL-terminated string array containing the artists. The array is
+`NULL`-terminated string array containing the artists. The array is
owned by the about dialog and must not be modified.
</return>
</function>
@@ -17110,12 +19742,12 @@ of the secondary credits dialog.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
</parameters>
<return> A
-%NULL-terminated string array containing the authors. The array is
+`NULL`-terminated string array containing the authors. The array is
owned by the about dialog and must not be modified.
</return>
</function>
@@ -17128,7 +19760,7 @@ Returns the comments string.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
</parameters>
@@ -17145,7 +19777,7 @@ Returns the copyright string.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
</parameters>
@@ -17156,19 +19788,19 @@ dialog and must not be modified.
<function name="gtk_about_dialog_get_documenters">
<description>
-Returns the string which are displayed in the documenters
+Returns the string which are displayed in the "Documenters"
tab of the secondary credits dialog.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
</parameters>
<return> A
-%NULL-terminated string array containing the documenters. The
+`NULL`-terminated string array containing the documenters. The
array is owned by the about dialog and must not be modified.
</return>
</function>
@@ -17181,7 +19813,7 @@ Returns the license information.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
</parameters>
@@ -17192,17 +19824,17 @@ dialog and must not be modified.
<function name="gtk_about_dialog_get_license_type">
<description>
-Retrieves the license set using gtk_about_dialog_set_license_type()
+Retrieves the license type.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkLicense value
+<return> a [enum@Gtk.License] value
</return>
</function>
@@ -17214,15 +19846,14 @@ Returns the paintable displayed as logo in the about dialog.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
</parameters>
<return> the paintable displayed as
-logo or %NULL if the logo is unset or has been set via
-gtk_about_dialog_set_logo_icon_name(). The
-paintable is owned by the about dialog. If you want to keep a
-reference to it, you have to call g_object_ref() on it.
+logo or `NULL` if the logo is unset or has been set via
+[method@Gtk.AboutDialog.set_logo_icon_name]. The
+paintable is owned by the about dialog.
</return>
</function>
@@ -17234,14 +19865,13 @@ Returns the icon name displayed as logo in the about dialog.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
</parameters>
-<return> the icon name displayed as logo or %NULL
-if the logo has been set via gtk_about_dialog_set_logo().
-The string is owned by the dialog. If you want to keep a reference
-to it, you have to call g_strdup() on it.
+<return> the icon name displayed as logo,
+or `NULL` if the logo has been set via [method@Gtk.AboutDialog.set_logo].
+The string is owned by the dialog.
</return>
</function>
@@ -17253,7 +19883,7 @@ Returns the program name displayed in the about dialog.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
</parameters>
@@ -17270,7 +19900,7 @@ Returns the system information that is shown in the about dialog.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
</parameters>
@@ -17287,12 +19917,11 @@ in the translators tab of the secondary credits dialog.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
</parameters>
-<return> The translator credits string. The string is
-owned by the about dialog and must not be modified.
+<return> The translator credits string.
</return>
</function>
@@ -17304,7 +19933,7 @@ Returns the version string.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
</parameters>
@@ -17321,12 +19950,11 @@ Returns the website URL.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
</parameters>
-<return> The website URL. The string is owned by the about
-dialog and must not be modified.
+<return> The website URL
</return>
</function>
@@ -17338,57 +19966,57 @@ Returns the label used for the website link.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
</parameters>
-<return> The label used for the website link. The string is
-owned by the about dialog and must not be modified.
+<return> The label used for the website link.
</return>
</function>
<function name="gtk_about_dialog_get_wrap_license">
<description>
-Returns whether the license text in @about is
+Returns whether the license text in the about dialog is
automatically wrapped.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the license text is wrapped
+<return> `TRUE` if the license text is wrapped
</return>
</function>
<function name="gtk_about_dialog_new">
<description>
-Creates a new #GtkAboutDialog.
+Creates a new `GtkAboutDialog`.
</description>
<parameters>
</parameters>
-<return> a newly created #GtkAboutDialog
+<return> a newly created `GtkAboutDialog`
</return>
</function>
<function name="gtk_about_dialog_set_artists">
<description>
-Sets the strings which are displayed in the artists tab
+Sets the strings which are displayed in the "Artists" tab
of the secondary credits dialog.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="artists">
-<parameter_description> a %NULL-terminated array of strings
+<parameter_description> the authors of the artwork
+of the application
</parameter_description>
</parameter>
</parameters>
@@ -17397,17 +20025,17 @@ of the secondary credits dialog.
<function name="gtk_about_dialog_set_authors">
<description>
-Sets the strings which are displayed in the authors tab
+Sets the strings which are displayed in the "Authors" tab
of the secondary credits dialog.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="authors">
-<parameter_description> a %NULL-terminated array of strings
+<parameter_description> the authors of the application
</parameter_description>
</parameter>
</parameters>
@@ -17417,12 +20045,13 @@ of the secondary credits dialog.
<function name="gtk_about_dialog_set_comments">
<description>
Sets the comments string to display in the about dialog.
+
This should be a short string of one or two lines.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="comments">
@@ -17436,12 +20065,13 @@ This should be a short string of one or two lines.
<function name="gtk_about_dialog_set_copyright">
<description>
Sets the copyright string to display in the about dialog.
+
This should be a short string of one or two lines.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="copyright">
@@ -17454,17 +20084,18 @@ This should be a short string of one or two lines.
<function name="gtk_about_dialog_set_documenters">
<description>
-Sets the strings which are displayed in the documenters tab
+Sets the strings which are displayed in the "Documenters" tab
of the credits dialog.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="documenters">
-<parameter_description> a %NULL-terminated array of strings
+<parameter_description> the authors of the documentation
+of the application
</parameter_description>
</parameter>
</parameters>
@@ -17474,17 +20105,18 @@ of the credits dialog.
<function name="gtk_about_dialog_set_license">
<description>
Sets the license information to be displayed in the secondary
-license dialog. If @license is %NULL, the license button is
-hidden.
+license dialog.
+
+If `license` is `NULL`, the license button is hidden.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="license">
-<parameter_description> the license information or %NULL
+<parameter_description> the license information
</parameter_description>
</parameter>
</parameters>
@@ -17493,16 +20125,16 @@ hidden.
<function name="gtk_about_dialog_set_license_type">
<description>
-Sets the license of the application showing the @about dialog from a
+Sets the license of the application showing the about dialog from a
list of known licenses.
This function overrides the license set using
-gtk_about_dialog_set_license().
+[method@Gtk.AboutDialog.set_license].
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="license_type">
@@ -17520,11 +20152,11 @@ Sets the logo in the about dialog.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="logo">
-<parameter_description> a #GdkPaintable, or %NULL
+<parameter_description> a `GdkPaintable`
</parameter_description>
</parameter>
</parameters>
@@ -17538,11 +20170,11 @@ Sets the icon name to be displayed as logo in the about dialog.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="icon_name">
-<parameter_description> an icon name, or %NULL
+<parameter_description> an icon name
</parameter_description>
</parameter>
</parameters>
@@ -17552,12 +20184,13 @@ Sets the icon name to be displayed as logo in the about dialog.
<function name="gtk_about_dialog_set_program_name">
<description>
Sets the name to display in the about dialog.
-If this is not set, it defaults to g_get_application_name().
+
+If `name` is not set, it defaults to `g_get_application_name()`.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="name">
@@ -17571,19 +20204,21 @@ If this is not set, it defaults to g_get_application_name().
<function name="gtk_about_dialog_set_system_information">
<description>
Sets the system information to be displayed in the about
-dialog. If @system_information is %NULL, the system information
+dialog.
+
+If `system_information` is `NULL`, the system information
tab is hidden.
-See #GtkAboutDialog:system-information.
+See [property@Gtk.AboutDialog:system-information].
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="system_information">
-<parameter_description> system information or %NULL
+<parameter_description> system information
</parameter_description>
</parameter>
</parameters>
@@ -17597,22 +20232,24 @@ the translators tab of the secondary credits dialog.
The intended use for this string is to display the translator
of the language which is currently used in the user interface.
-Using gettext(), a simple way to achieve that is to mark the
+Using `gettext()`, a simple way to achieve that is to mark the
string for translation:
-|[<!-- language="C" -->
+
+```c
GtkWidget *about = gtk_about_dialog_new ();
gtk_about_dialog_set_translator_credits (GTK_ABOUT_DIALOG (about),
_("translator-credits"));
-]|
-It is a good idea to use the customary msgid “translator-credits” for this
-purpose, since translators will already know the purpose of that msgid, and
-since #GtkAboutDialog will detect if “translator-credits” is untranslated
+```
+
+It is a good idea to use the customary `msgid` “translator-credits” for this
+purpose, since translators will already know the purpose of that `msgid`, and
+since `GtkAboutDialog` will detect if “translator-credits” is untranslated
and hide the tab.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="translator_credits">
@@ -17630,7 +20267,7 @@ Sets the version string to display in the about dialog.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="version">
@@ -17648,11 +20285,11 @@ Sets the URL to use for the website link.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="website">
-<parameter_description> a URL string starting with "http://"
+<parameter_description> a URL string starting with `http://`
</parameter_description>
</parameter>
</parameters>
@@ -17666,7 +20303,7 @@ Sets the label to be used for the website link.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="website_label">
@@ -17679,13 +20316,13 @@ Sets the label to be used for the website link.
<function name="gtk_about_dialog_set_wrap_license">
<description>
-Sets whether the license text in @about is
+Sets whether the license text in the about dialog should be
automatically wrapped.
</description>
<parameters>
<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter_description> a `GtkAboutDialog`
</parameter_description>
</parameter>
<parameter name="wrap_license">
@@ -17736,9 +20373,12 @@ which can be used to represent the accelerator to the user.
<function name="gtk_accelerator_get_label_with_keycode">
<description>
Converts an accelerator keyval and modifier mask
-into a (possibly translated) string that can be displayed to
-a user, similarly to gtk_accelerator_get_label(), but handling
-keycodes.
+into a string that can be displayed to the user.
+
+The string may be translated.
+
+This function is similar to [func@Gtk.accelerator_get_label],
+but handling keycodes.
This is only useful for system-level components, applications
should use gtk_accelerator_parse() instead.
@@ -17770,11 +20410,13 @@ should use gtk_accelerator_parse() instead.
<function name="gtk_accelerator_name">
<description>
Converts an accelerator keyval and modifier mask into a string
-parseable by gtk_accelerator_parse(). For example, if you pass in
-#GDK_KEY_q and #GDK_CONTROL_MASK, this function returns “<Control>q”.
+parseable by gtk_accelerator_parse().
+
+For example, if you pass in %GDK_KEY_q and %GDK_CONTROL_MASK,
+this function returns `<Control>q`.
If you need to display accelerators in the user interface,
-see gtk_accelerator_get_label().
+see [func@Gtk.accelerator_get_label].
</description>
@@ -17795,8 +20437,9 @@ see gtk_accelerator_get_label().
<function name="gtk_accelerator_name_with_keycode">
<description>
Converts an accelerator keyval and modifier mask
-into a string parseable by gtk_accelerator_parse_with_keycode(),
-similarly to gtk_accelerator_name() but handling keycodes.
+into a string parseable by gtk_accelerator_parse_with_keycode().
+
+This is similar to [func@Gtk.accelerator_name] but handling keycodes.
This is only useful for system-level components, applications
should use gtk_accelerator_parse() instead.
@@ -17826,12 +20469,13 @@ should use gtk_accelerator_parse() instead.
<function name="gtk_accelerator_parse">
<description>
-Parses a string representing an accelerator. The format looks like
-“<Control>a” or “<Shift><Alt>F1”.
+Parses a string representing an accelerator.
+
+The format looks like “<Control>a” or “<Shift><Alt>F1”.
The parser is fairly liberal and allows lower or upper case, and also
abbreviations such as “<Ctl>” and “<Ctrl>”. Key names are parsed using
-gdk_keyval_from_name(). For character keys the name is not the symbol,
+[func@Gdk.keyval_from_name]. For character keys the name is not the symbol,
but the lowercase name, e.g. one would use “<Ctrl>minus” instead of
“<Ctrl>-”.
@@ -17860,10 +20504,11 @@ modifier mask, %NULL
<function name="gtk_accelerator_parse_with_keycode">
<description>
-Parses a string representing an accelerator, similarly to
-gtk_accelerator_parse() but handles keycodes as well. This is only
-useful for system-level components, applications should use
-gtk_accelerator_parse() instead.
+Parses a string representing an accelerator.
+
+This is similar to [func@Gtk.accelerator_parse] but handles keycodes as
+well. This is only useful for system-level components, applications should
+use gtk_accelerator_parse() instead.
If @accelerator_codes is given and the result stored in it is non-%NULL,
the result must be freed with g_free().
@@ -17908,10 +20553,11 @@ modifier mask, %NULL
<function name="gtk_accelerator_valid">
<description>
Determines whether a given keyval and modifier mask constitute
-a valid keyboard accelerator. For example, the #GDK_KEY_a keyval
-plus #GDK_CONTROL_MASK is valid - this is a “Ctrl+a” accelerator.
-But, you can't, for instance, use the #GDK_KEY_Control_L keyval
-as an accelerator.
+a valid keyboard accelerator.
+
+For example, the %GDK_KEY_a keyval plus %GDK_CONTROL_MASK mark is valid,
+and matches the “Ctrl+a” accelerator. But, you can't, for instance, use
+the %GDK_KEY_Control_L keyval as an accelerator.
</description>
@@ -17931,17 +20577,17 @@ as an accelerator.
<function name="gtk_accessible_get_accessible_role">
<description>
-Retrieves the #GtkAccessibleRole for the given #GtkAccessible.
+Retrieves the `GtkAccessibleRole` for the given `GtkAccessible`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAccessible
+<parameter_description> a `GtkAccessible`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkAccessibleRole
+<return> a `GtkAccessibleRole`
</return>
</function>
@@ -17994,11 +20640,11 @@ Resets the accessible @property to its default value.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAccessible
+<parameter_description> a `GtkAccessible`
</parameter_description>
</parameter>
<parameter name="property">
-<parameter_description> a #GtkAccessibleProperty
+<parameter_description> a `GtkAccessibleProperty`
</parameter_description>
</parameter>
</parameters>
@@ -18012,11 +20658,11 @@ Resets the accessible @relation to its default value.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAccessible
+<parameter_description> a `GtkAccessible`
</parameter_description>
</parameter>
<parameter name="relation">
-<parameter_description> a #GtkAccessibleRelation
+<parameter_description> a `GtkAccessibleRelation`
</parameter_description>
</parameter>
</parameters>
@@ -18030,11 +20676,11 @@ Resets the accessible @state to its default value.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAccessible
+<parameter_description> a `GtkAccessible`
</parameter_description>
</parameter>
<parameter name="state">
-<parameter_description> a #GtkAccessibleState
+<parameter_description> a `GtkAccessibleState`
</parameter_description>
</parameter>
</parameters>
@@ -18064,28 +20710,31 @@ with gtk_accessible_update_relation_state().
<function name="gtk_accessible_update_property">
<description>
-Updates a list of accessible properties. See the #GtkAccessibleProperty
-documentation for the value types of accessible properties.
+Updates a list of accessible properties.
-This function should be called by #GtkWidget types whenever an accessible
-property change must be communicated to assistive technologies.
+See the [enum@Gtk.AccessibleProperty] documentation for the
+value types of accessible properties.
+
+This function should be called by `GtkWidget` types whenever
+an accessible property change must be communicated to assistive
+technologies.
Example:
-|[
+```c
value = gtk_adjustment_get_value (adjustment);
gtk_accessible_update_property (GTK_ACCESSIBLE (spin_button),
- GTK_ACCESSIBLE_PROPERTY_VALUE_NOW, value,
- -1);
-]|
+ GTK_ACCESSIBLE_PROPERTY_VALUE_NOW, value,
+ -1);
+```
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAccessible
+<parameter_description> a `GtkAccessible`
</parameter_description>
</parameter>
<parameter name="first_property">
-<parameter_description> the first #GtkAccessibleProperty
+<parameter_description> the first `GtkAccessibleProperty`
</parameter_description>
</parameter>
<parameter name="Varargs">
@@ -18100,7 +20749,7 @@ gtk_accessible_update_property (GTK_ACCESSIBLE (spin_button),
<description>
Updates an array of accessible properties.
-This function should be called by #GtkWidget types whenever an accessible
+This function should be called by `GtkWidget` types whenever an accessible
property change must be communicated to assistive technologies.
This function is meant to be used by language bindings.
@@ -18108,7 +20757,7 @@ This function is meant to be used by language bindings.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAccessible
+<parameter_description> a `GtkAccessible`
</parameter_description>
</parameter>
<parameter name="n_properties">
@@ -18116,11 +20765,11 @@ This function is meant to be used by language bindings.
</parameter_description>
</parameter>
<parameter name="properties">
-<parameter_description> an array of #GtkAccessibleProperty
+<parameter_description> an array of `GtkAccessibleProperty`
</parameter_description>
</parameter>
<parameter name="values">
-<parameter_description> an array of #GValues, one for each property
+<parameter_description> an array of `GValues`, one for each property
</parameter_description>
</parameter>
</parameters>
@@ -18131,29 +20780,29 @@ This function is meant to be used by language bindings.
<description>
Updates a list of accessible relations.
-This function should be called by #GtkWidget types whenever an accessible
+This function should be called by `GtkWidget` types whenever an accessible
relation change must be communicated to assistive technologies.
-If the #GtkAccessibleRelation requires a list of references, you should
-pass each reference individually, followed by %NULL, e.g.
+If the [enum@Gtk.AccessibleRelation] requires a list of references,
+you should pass each reference individually, followed by %NULL, e.g.
-|[<!-- language="C" -->
+```c
gtk_accessible_update_relation (accessible,
GTK_ACCESSIBLE_RELATION_CONTROLS,
ref1, NULL,
GTK_ACCESSIBLE_LABELLED_BY,
ref1, ref2, ref3, NULL,
-1);
-]|
+```
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAccessible
+<parameter_description> a `GtkAccessible`
</parameter_description>
</parameter>
<parameter name="first_relation">
-<parameter_description> the first #GtkAccessibleRelation
+<parameter_description> the first `GtkAccessibleRelation`
</parameter_description>
</parameter>
<parameter name="Varargs">
@@ -18168,7 +20817,7 @@ ref1, ref2, ref3, NULL,
<description>
Updates an array of accessible relations.
-This function should be called by #GtkWidget types whenever an accessible
+This function should be called by `GtkWidget` types whenever an accessible
relation change must be communicated to assistive technologies.
This function is meant to be used by language bindings.
@@ -18176,7 +20825,7 @@ This function is meant to be used by language bindings.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAccessible
+<parameter_description> a `GtkAccessible`
</parameter_description>
</parameter>
<parameter name="n_relations">
@@ -18184,11 +20833,11 @@ This function is meant to be used by language bindings.
</parameter_description>
</parameter>
<parameter name="relations">
-<parameter_description> an array of #GtkAccessibleRelation
+<parameter_description> an array of `GtkAccessibleRelation`
</parameter_description>
</parameter>
<parameter name="values">
-<parameter_description> an array of #GValues, one for each relation
+<parameter_description> an array of `GValues`, one for each relation
</parameter_description>
</parameter>
</parameters>
@@ -18197,28 +20846,28 @@ This function is meant to be used by language bindings.
<function name="gtk_accessible_update_state">
<description>
-Updates a list of accessible states. See the #GtkAccessibleState
+Updates a list of accessible states. See the [enum@Gtk.AccessibleState]
documentation for the value types of accessible states.
-This function should be called by #GtkWidget types whenever an accessible
+This function should be called by `GtkWidget` types whenever an accessible
state change must be communicated to assistive technologies.
Example:
-|[
+```c
value = GTK_ACCESSIBLE_TRISTATE_MIXED;
gtk_accessible_update_state (GTK_ACCESSIBLE (check_button),
GTK_ACCESSIBLE_STATE_CHECKED, value,
-1);
-]|
+```
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAccessible
+<parameter_description> a `GtkAccessible`
</parameter_description>
</parameter>
<parameter name="first_state">
-<parameter_description> the first #GtkAccessibleState
+<parameter_description> the first `GtkAccessibleState`
</parameter_description>
</parameter>
<parameter name="Varargs">
@@ -18233,7 +20882,7 @@ GTK_ACCESSIBLE_STATE_CHECKED, value,
<description>
Updates an array of accessible states.
-This function should be called by #GtkWidget types whenever an accessible
+This function should be called by `GtkWidget` types whenever an accessible
state change must be communicated to assistive technologies.
This function is meant to be used by language bindings.
@@ -18241,7 +20890,7 @@ This function is meant to be used by language bindings.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAccessible
+<parameter_description> a `GtkAccessible`
</parameter_description>
</parameter>
<parameter name="n_states">
@@ -18249,11 +20898,11 @@ This function is meant to be used by language bindings.
</parameter_description>
</parameter>
<parameter name="states">
-<parameter_description> an array of #GtkAccessibleState
+<parameter_description> an array of `GtkAccessibleState`
</parameter_description>
</parameter>
<parameter name="values">
-<parameter_description> an array of #GValues, one for each state
+<parameter_description> an array of `GValues`, one for each state
</parameter_description>
</parameter>
</parameters>
@@ -18268,39 +20917,40 @@ Retrieves the center bar widget of the bar.
</description>
<parameters>
<parameter name="action_bar">
-<parameter_description> a #GtkActionBar
+<parameter_description> a `GtkActionBar`
</parameter_description>
</parameter>
</parameters>
-<return> the center #GtkWidget or %NULL.
+<return> the center `GtkWidget` or %NULL.
</return>
</function>
<function name="gtk_action_bar_get_revealed">
<description>
-Gets the value of the #GtkActionBar:revealed property.
+Gets whether the contents of the action bar are revealed.
</description>
<parameters>
<parameter name="action_bar">
-<parameter_description> a #GtkActionBar
+<parameter_description> a `GtkActionBar`
</parameter_description>
</parameter>
</parameters>
-<return> the current value of the #GtkActionBar:revealed property.
+<return> the current value of the [property@Gtk.ActionBar:revealed]
+property.
</return>
</function>
<function name="gtk_action_bar_new">
<description>
-Creates a new #GtkActionBar widget.
+Creates a new `GtkActionBar` widget.
</description>
<parameters>
</parameters>
-<return> a new #GtkActionBar
+<return> a new `GtkActionBar`
</return>
</function>
@@ -18312,11 +20962,11 @@ end of the @action_bar.
</description>
<parameters>
<parameter name="action_bar">
-<parameter_description> A #GtkActionBar
+<parameter_description> A `GtkActionBar`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to be added to @action_bar
+<parameter_description> the `GtkWidget` to be added to @action_bar
</parameter_description>
</parameter>
</parameters>
@@ -18331,11 +20981,11 @@ start of the @action_bar.
</description>
<parameters>
<parameter name="action_bar">
-<parameter_description> A #GtkActionBar
+<parameter_description> A `GtkActionBar`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to be added to @action_bar
+<parameter_description> the `GtkWidget` to be added to @action_bar
</parameter_description>
</parameter>
</parameters>
@@ -18349,11 +20999,11 @@ Removes a child from @action_bar.
</description>
<parameters>
<parameter name="action_bar">
-<parameter_description> a #GtkActionBar
+<parameter_description> a `GtkActionBar`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to be removed
+<parameter_description> the `GtkWidget` to be removed
</parameter_description>
</parameter>
</parameters>
@@ -18362,12 +21012,12 @@ Removes a child from @action_bar.
<function name="gtk_action_bar_set_center_widget">
<description>
-Sets the center widget for the #GtkActionBar.
+Sets the center widget for the `GtkActionBar`.
</description>
<parameters>
<parameter name="action_bar">
-<parameter_description> a #GtkActionBar
+<parameter_description> a `GtkActionBar`
</parameter_description>
</parameter>
<parameter name="center_widget">
@@ -18380,17 +21030,16 @@ Sets the center widget for the #GtkActionBar.
<function name="gtk_action_bar_set_revealed">
<description>
-Sets the #GtkActionBar:revealed property to @revealed. Changing this will
-make @action_bar reveal (%TRUE) or conceal (%FALSE) itself via a sliding
-transition.
+Reveals or conceals the content of the action bar.
-Note: this does not show or hide @action_bar in the #GtkWidget:visible sense,
-so revealing has no effect if #GtkWidget:visible is %FALSE.
+Note: this does not show or hide @action_bar in the
+[property@Gtk.Widget:visible] sense, so revealing has
+no effect if the action bar is hidden.
</description>
<parameters>
<parameter name="action_bar">
-<parameter_description> a #GtkActionBar
+<parameter_description> a `GtkActionBar`
</parameter_description>
</parameter>
<parameter name="revealed">
@@ -18454,13 +21103,11 @@ unregistered an equal number of times.
<description>
Gets the action name for @actionable.
-See gtk_actionable_set_action_name() for more information.
-
</description>
<parameters>
<parameter name="actionable">
-<parameter_description> a #GtkActionable widget
+<parameter_description> a `GtkActionable` widget
</parameter_description>
</parameter>
</parameters>
@@ -18472,13 +21119,11 @@ See gtk_actionable_set_action_name() for more information.
<description>
Gets the current target value of @actionable.
-See gtk_actionable_set_action_target_value() for more information.
-
</description>
<parameters>
<parameter name="actionable">
-<parameter_description> a #GtkActionable widget
+<parameter_description> a `GtkActionable` widget
</parameter_description>
</parameter>
</parameters>
@@ -18489,21 +21134,23 @@ See gtk_actionable_set_action_target_value() for more information.
<function name="gtk_actionable_set_action_name">
<description>
Specifies the name of the action with which this widget should be
-associated. If @action_name is %NULL then the widget will be
-unassociated from any previous action.
+associated.
+
+If @action_name is %NULL then the widget will be unassociated from
+any previous action.
Usually this function is used when the widget is located (or will be
-located) within the hierarchy of a #GtkApplicationWindow.
+located) within the hierarchy of a `GtkApplicationWindow`.
Names are of the form “win.save” or “app.quit” for actions on the
-containing #GtkApplicationWindow or its associated #GtkApplication,
-respectively. This is the same form used for actions in the #GMenu
+containing `GtkApplicationWindow` or its associated `GtkApplication`,
+respectively. This is the same form used for actions in the `GMenu`
associated with the window.
</description>
<parameters>
<parameter name="actionable">
-<parameter_description> a #GtkActionable widget
+<parameter_description> a `GtkActionable` widget
</parameter_description>
</parameter>
<parameter name="action_name">
@@ -18520,16 +21167,16 @@ Sets the target of an actionable widget.
This is a convenience function that calls g_variant_new() for
@format_string and uses the result to call
-gtk_actionable_set_action_target_value().
+[method@Gtk.Actionable.set_action_target_value].
-If you are setting a string-valued target and want to set the action
-name at the same time, you can use
-gtk_actionable_set_detailed_action_name ().
+If you are setting a string-valued target and want to set
+the action name at the same time, you can use
+[method@Gtk.Actionable.set_detailed_action_name].
</description>
<parameters>
<parameter name="actionable">
-<parameter_description> a #GtkActionable widget
+<parameter_description> a `GtkActionable` widget
</parameter_description>
</parameter>
<parameter name="format_string">
@@ -18550,16 +21197,15 @@ Sets the target value of an actionable widget.
If @target_value is %NULL then the target value is unset.
-The target value has two purposes. First, it is used as the
-parameter to activation of the action associated with the
-#GtkActionable widget. Second, it is used to determine if the widget
-should be rendered as “active” — the widget is active if the state
-is equal to the given target.
+The target value has two purposes. First, it is used as the parameter
+to activation of the action associated with the `GtkActionable` widget.
+Second, it is used to determine if the widget should be rendered as
+“active” — the widget is active if the state is equal to the given target.
-Consider the example of associating a set of buttons with a #GAction
-with string state in a typical “radio button” situation. Each button
+Consider the example of associating a set of buttons with a `GAction`
+with string state in a typical “radio button” situation. Each button
will be associated with the same action, but with a different target
-value for that action. Clicking on a particular button will activate
+value for that action. Clicking on a particular button will activate
the action with the target of that button, which will typically cause
the action’s state to change to that value. Since the action’s state
is now equal to the target value of the button, the button will now
@@ -18569,7 +21215,7 @@ rendered inactive).
</description>
<parameters>
<parameter name="actionable">
-<parameter_description> a #GtkActionable widget
+<parameter_description> a `GtkActionable` widget
</parameter_description>
</parameter>
<parameter name="target_value">
@@ -18588,16 +21234,10 @@ actionable widget.
@detailed_action_name is a string in the format accepted by
g_action_parse_detailed_name().
-(Note that prior to version 3.22.25,
-this function is only usable for actions with a simple "s" target, and
-@detailed_action_name must be of the form `"action::target"` where
-`action` is the action name and `target` is the string to use
-as the target.)
-
</description>
<parameters>
<parameter name="actionable">
-<parameter_description> a #GtkActionable widget
+<parameter_description> a `GtkActionable` widget
</parameter_description>
</parameter>
<parameter name="detailed_action_name">
@@ -18610,7 +21250,9 @@ as the target.)
<function name="gtk_activate_action_get">
<description>
-Gets the activate action. This is an action that calls gtk_widget_activate()
+Gets the activate action.
+
+This is an action that calls gtk_widget_activate()
on the given widget upon activation.
@@ -18623,18 +21265,20 @@ on the given widget upon activation.
<function name="gtk_adjustment_clamp_page">
<description>
-Updates the #GtkAdjustment:value property to ensure that the range
-between @lower and @upper is in the current page (i.e. between
-#GtkAdjustment:value and #GtkAdjustment:value + #GtkAdjustment:page-size).
-If the range is larger than the page size, then only the start of it will
-be in the current page.
+Updates the value property to ensure that the range
+between @lower and @upper is 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
+start of it will be in the current page.
-A #GtkAdjustment::value-changed signal will be emitted if the value is changed.
+A [signal@Gtk.Adjustment::value-changed] signal will be emitted
+if the value is changed.
</description>
<parameters>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
<parameter name="lower">
@@ -18654,14 +21298,15 @@ A #GtkAdjustment::value-changed signal will be emitted if the value is changed.
Sets all properties of the adjustment at once.
Use this function to avoid multiple emissions of the
-#GtkAdjustment::changed signal. See gtk_adjustment_set_lower()
-for an alternative way of compressing multiple emissions of
-#GtkAdjustment::changed into one.
+[signal@Gtk.Adjustment::changed] signal. See
+[method@Gtk.Adjustment.set_lower] for an alternative
+way of compressing multiple emissions of
+[signal@Gtk.Adjustment::changed] into one.
</description>
<parameters>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
<parameter name="value">
@@ -18700,7 +21345,7 @@ Retrieves the minimum value of the adjustment.
</description>
<parameters>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
</parameters>
@@ -18716,7 +21361,7 @@ Gets the smaller of step increment and page increment.
</description>
<parameters>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
</parameters>
@@ -18732,7 +21377,7 @@ Retrieves the page increment of the adjustment.
</description>
<parameters>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
</parameters>
@@ -18748,7 +21393,7 @@ Retrieves the page size of the adjustment.
</description>
<parameters>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
</parameters>
@@ -18764,7 +21409,7 @@ Retrieves the step increment of the adjustment.
</description>
<parameters>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
</parameters>
@@ -18780,7 +21425,7 @@ Retrieves the maximum value of the adjustment.
</description>
<parameters>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
</parameters>
@@ -18791,13 +21436,12 @@ Retrieves the maximum value of the adjustment.
<function name="gtk_adjustment_get_value">
<description>
Gets the current value of the adjustment.
-See gtk_adjustment_set_value().
</description>
<parameters>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
</parameters>
@@ -18807,7 +21451,7 @@ See gtk_adjustment_set_value().
<function name="gtk_adjustment_new">
<description>
-Creates a new #GtkAdjustment.
+Creates a new `GtkAdjustment`.
</description>
@@ -18837,7 +21481,7 @@ Creates a new #GtkAdjustment.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkAdjustment
+<return> a new `GtkAdjustment`
</return>
</function>
@@ -18846,21 +21490,21 @@ Creates a new #GtkAdjustment.
Sets the minimum value of the adjustment.
When setting multiple adjustment properties via their individual
-setters, multiple #GtkAdjustment::changed signals will be emitted.
-However, since the emission of the #GtkAdjustment::changed signal
-is tied to the emission of the #GObject::notify signals of the changed
-properties, it’s possible to compress the #GtkAdjustment::changed
-signals into one by calling g_object_freeze_notify() and
-g_object_thaw_notify() around the calls to the individual setters.
+setters, multiple [signal@Gtk.Adjustment::changed] signals will
+be emitted. However, since the emission of the
+[signal@Gtk.Adjustment::changed] signal is tied to the emission
+of the ::notify signals of the changed properties, it’s possible
+to compress the [signal@Gtk.Adjustment::changed] signals into one
+by calling g_object_freeze_notify() and g_object_thaw_notify()
+around the calls to the individual setters.
Alternatively, using a single g_object_set() for all the properties
-to change, or using gtk_adjustment_configure() has the same effect
-of compressing #GtkAdjustment::changed emissions.
+to change, or using [method@Gtk.Adjustment.configure] has the same effect.
</description>
<parameters>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
<parameter name="lower">
@@ -18875,14 +21519,14 @@ of compressing #GtkAdjustment::changed emissions.
<description>
Sets the page increment of the adjustment.
-See gtk_adjustment_set_lower() about how to compress multiple
-emissions of the #GtkAdjustment::changed signal when setting
-multiple adjustment properties.
+See [method@Gtk.Adjustment.set_lower] about how to compress
+multiple emissions of the [signal@Gtk.Adjustment::changed]
+signal when setting multiple adjustment properties.
</description>
<parameters>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
<parameter name="page_increment">
@@ -18897,14 +21541,14 @@ multiple adjustment properties.
<description>
Sets the page size of the adjustment.
-See gtk_adjustment_set_lower() about how to compress multiple
-emissions of the GtkAdjustment::changed signal when setting
-multiple adjustment properties.
+See [method@Gtk.Adjustment.set_lower] about how to compress
+multiple emissions of the [signal@Gtk.Adjustment::changed]
+signal when setting multiple adjustment properties.
</description>
<parameters>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
<parameter name="page_size">
@@ -18919,14 +21563,14 @@ multiple adjustment properties.
<description>
Sets the step increment of the adjustment.
-See gtk_adjustment_set_lower() about how to compress multiple
-emissions of the #GtkAdjustment::changed signal when setting
-multiple adjustment properties.
+See [method@Gtk.Adjustment.set_lower] about how to compress
+multiple emissions of the [signal@Gtk.Adjustment::changed]
+signal when setting multiple adjustment properties.
</description>
<parameters>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
<parameter name="step_increment">
@@ -18944,14 +21588,14 @@ Sets the maximum value of the adjustment.
Note that values will be restricted by `upper - page-size`
if the page-size property is nonzero.
-See gtk_adjustment_set_lower() about how to compress multiple
-emissions of the #GtkAdjustment::changed signal when setting
-multiple adjustment properties.
+See [method@Gtk.Adjustment.set_lower] about how to compress
+multiple emissions of the [signal@Gtk.Adjustment::changed]
+signal when setting multiple adjustment properties.
</description>
<parameters>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
<parameter name="upper">
@@ -18964,17 +21608,20 @@ multiple adjustment properties.
<function name="gtk_adjustment_set_value">
<description>
-Sets the #GtkAdjustment value. The value is clamped to lie between
-#GtkAdjustment:lower and #GtkAdjustment:upper.
+Sets the `GtkAdjustment` value.
-Note that for adjustments which are used in a #GtkScrollbar, the
-effective range of allowed values goes from #GtkAdjustment:lower to
-#GtkAdjustment:upper - #GtkAdjustment:page-size.
+The value is clamped to lie between [property@Gtk.Adjustment:lower]
+and [property@Gtk.Adjustment:upper].
+
+Note that for adjustments which are used in a `GtkScrollbar`,
+the effective range of allowed values goes from
+[property@Gtk.Adjustment:lower] to
+[property@Gtk.Adjustment:upper] - [property@Gtk.Adjustment:page-size].
</description>
<parameters>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
<parameter name="value">
@@ -18988,14 +21635,16 @@ effective range of allowed values goes from #GtkAdjustment:lower to
<function name="gtk_alternative_trigger_get_first">
<description>
Gets the first of the two alternative triggers that may
-trigger @self. gtk_alternative_trigger_get_second() will
-return the other one.
+trigger @self.
+
+[method@Gtk.AlternativeTrigger.get_second] will return
+the other one.
</description>
<parameters>
<parameter name="self">
-<parameter_description> an alternative #GtkShortcutTrigger
+<parameter_description> an alternative `GtkShortcutTrigger`
</parameter_description>
</parameter>
</parameters>
@@ -19006,14 +21655,16 @@ return the other one.
<function name="gtk_alternative_trigger_get_second">
<description>
Gets the second of the two alternative triggers that may
-trigger @self. gtk_alternative_trigger_get_first() will
-return the other one.
+trigger @self.
+
+[method@Gtk.AlternativeTrigger.get_first] will return
+the other one.
</description>
<parameters>
<parameter name="self">
-<parameter_description> an alternative #GtkShortcutTrigger
+<parameter_description> an alternative `GtkShortcutTrigger`
</parameter_description>
</parameter>
</parameters>
@@ -19023,7 +21674,7 @@ return the other one.
<function name="gtk_alternative_trigger_new">
<description>
-Creates a #GtkShortcutTrigger that will trigger whenever
+Creates a `GtkShortcutTrigger` that will trigger whenever
either of the two given triggers gets triggered.
Note that nesting is allowed, so if you want more than two
@@ -19041,41 +21692,44 @@ alternative, create a new alternative trigger for each option.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkShortcutTrigger
+<return> a new `GtkShortcutTrigger`
</return>
</function>
<function name="gtk_any_filter_new">
<description>
Creates a new empty "any" filter.
-Use gtk_multi_filter_append() to add filters to it.
+
+Use [method@Gtk.MultiFilter.append] to add filters to it.
This filter matches an item if any of the filters added to it
-matches the item.
-In particular, this means that if no filter has been added to
-it, the filter matches no item.
+matches the item. In particular, this means that if no filter
+has been added to it, the filter matches no item.
</description>
<parameters>
</parameters>
-<return> a new #GtkAnyFilter
+<return> a new `GtkAnyFilter`
</return>
</function>
<function name="gtk_app_chooser_button_append_custom_item">
<description>
Appends a custom item to the list of applications that is shown
-in the popup; the item name must be unique per-widget.
-Clients can use the provided name as a detail for the
-#GtkAppChooserButton::custom-item-activated signal, to add a
+in the popup.
+
+The item name must be unique per-widget. Clients can use the
+provided name as a detail for the
+[signal@Gtk.AppChooserButton::custom-item-activated] signal, to add a
callback for the activation of a particular custom item in the list.
-See also gtk_app_chooser_button_append_separator().
+
+See also [method@Gtk.AppChooserButton.append_separator].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserButton
+<parameter_description> a `GtkAppChooserButton`
</parameter_description>
</parameter>
<parameter name="name">
@@ -19102,7 +21756,7 @@ in the popup.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserButton
+<parameter_description> a `GtkAppChooserButton`
</parameter_description>
</parameter>
</parameters>
@@ -19117,7 +21771,7 @@ Returns the text to display at the top of the dialog.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserButton
+<parameter_description> a `GtkAppChooserButton`
</parameter_description>
</parameter>
</parameters>
@@ -19134,7 +21788,7 @@ Gets whether the dialog is modal.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserButton
+<parameter_description> a `GtkAppChooserButton`
</parameter_description>
</parameter>
</parameters>
@@ -19144,41 +21798,41 @@ Gets whether the dialog is modal.
<function name="gtk_app_chooser_button_get_show_default_item">
<description>
-Returns the current value of the #GtkAppChooserButton:show-default-item
-property.
+Returns whether the dropdown menu should show the default
+application at the top.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserButton
+<parameter_description> a `GtkAppChooserButton`
</parameter_description>
</parameter>
</parameters>
-<return> the value of #GtkAppChooserButton:show-default-item
+<return> the value of [property@Gtk.AppChooserButton:show-default-item]
</return>
</function>
<function name="gtk_app_chooser_button_get_show_dialog_item">
<description>
-Returns the current value of the #GtkAppChooserButton:show-dialog-item
-property.
+Returns whether the dropdown menu shows an item
+for a `GtkAppChooserDialog`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserButton
+<parameter_description> a `GtkAppChooserButton`
</parameter_description>
</parameter>
</parameters>
-<return> the value of #GtkAppChooserButton:show-dialog-item
+<return> the value of [property@Gtk.AppChooserButton:show-dialog-item]
</return>
</function>
<function name="gtk_app_chooser_button_new">
<description>
-Creates a new #GtkAppChooserButton for applications
+Creates a new `GtkAppChooserButton` for applications
that can handle content of the given type.
@@ -19189,22 +21843,23 @@ that can handle content of the given type.
</parameter_description>
</parameter>
</parameters>
-<return> a newly created #GtkAppChooserButton
+<return> a newly created `GtkAppChooserButton`
</return>
</function>
<function name="gtk_app_chooser_button_set_active_custom_item">
<description>
-Selects a custom item previously added with
-gtk_app_chooser_button_append_custom_item().
+Selects a custom item.
+
+See [method@Gtk.AppChooserButton.append_custom_item].
-Use gtk_app_chooser_refresh() to bring the selection
+Use [method@Gtk.AppChooser.refresh] to bring the selection
to its initial state.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserButton
+<parameter_description> a `GtkAppChooserButton`
</parameter_description>
</parameter>
<parameter name="name">
@@ -19218,12 +21873,13 @@ to its initial state.
<function name="gtk_app_chooser_button_set_heading">
<description>
Sets the text to display at the top of the dialog.
+
If the heading is not set, the dialog displays a default text.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserButton
+<parameter_description> a `GtkAppChooserButton`
</parameter_description>
</parameter>
<parameter name="heading">
@@ -19241,7 +21897,7 @@ Sets whether the dialog should be modal.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserButton
+<parameter_description> a `GtkAppChooserButton`
</parameter_description>
</parameter>
<parameter name="modal">
@@ -19260,11 +21916,11 @@ default application for the given content type at top.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserButton
+<parameter_description> a `GtkAppChooserButton`
</parameter_description>
</parameter>
<parameter name="setting">
-<parameter_description> the new value for #GtkAppChooserButton:show-default-item
+<parameter_description> the new value for [property@Gtk.AppChooserButton:show-default-item]
</parameter_description>
</parameter>
</parameters>
@@ -19274,16 +21930,16 @@ default application for the given content type at top.
<function name="gtk_app_chooser_button_set_show_dialog_item">
<description>
Sets whether the dropdown menu of this button should show an
-entry to trigger a #GtkAppChooserDialog.
+entry to trigger a `GtkAppChooserDialog`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserButton
+<parameter_description> a `GtkAppChooserButton`
</parameter_description>
</parameter>
<parameter name="setting">
-<parameter_description> the new value for #GtkAppChooserButton:show-dialog-item
+<parameter_description> the new value for [property@Gtk.AppChooserButton:show-dialog-item]
</parameter_description>
</parameter>
</parameters>
@@ -19298,41 +21954,42 @@ Returns the text to display at the top of the dialog.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserDialog
+<parameter_description> a `GtkAppChooserDialog`
</parameter_description>
</parameter>
</parameters>
-<return> the text to display at the top of the dialog, or %NULL, in which
-case a default text is displayed
+<return> the text to display at the top of the dialog,
+or %NULL, in which case a default text is displayed
</return>
</function>
<function name="gtk_app_chooser_dialog_get_widget">
<description>
-Returns the #GtkAppChooserWidget of this dialog.
+Returns the `GtkAppChooserWidget` of this dialog.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserDialog
+<parameter_description> a `GtkAppChooserDialog`
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkAppChooserWidget of @self
+<return> the `GtkAppChooserWidget` of @self
</return>
</function>
<function name="gtk_app_chooser_dialog_new">
<description>
-Creates a new #GtkAppChooserDialog for the provided #GFile,
-to allow the user to select an application for it.
+Creates a new `GtkAppChooserDialog` for the provided `GFile`.
+
+The dialog will show applications that can open the file.
</description>
<parameters>
<parameter name="parent">
-<parameter_description> a #GtkWindow, or %NULL
+<parameter_description> a `GtkWindow`, or %NULL
</parameter_description>
</parameter>
<parameter name="flags">
@@ -19340,24 +21997,25 @@ to allow the user to select an application for it.
</parameter_description>
</parameter>
<parameter name="file">
-<parameter_description> a #GFile
+<parameter_description> a `GFile`
</parameter_description>
</parameter>
</parameters>
-<return> a newly created #GtkAppChooserDialog
+<return> a newly created `GtkAppChooserDialog`
</return>
</function>
<function name="gtk_app_chooser_dialog_new_for_content_type">
<description>
-Creates a new #GtkAppChooserDialog for the provided content type,
-to allow the user to select an application for it.
+Creates a new `GtkAppChooserDialog` for the provided content type.
+
+The dialog will show applications that can open the content type.
</description>
<parameters>
<parameter name="parent">
-<parameter_description> a #GtkWindow, or %NULL
+<parameter_description> a `GtkWindow`, or %NULL
</parameter_description>
</parameter>
<parameter name="flags">
@@ -19369,19 +22027,20 @@ to allow the user to select an application for it.
</parameter_description>
</parameter>
</parameters>
-<return> a newly created #GtkAppChooserDialog
+<return> a newly created `GtkAppChooserDialog`
</return>
</function>
<function name="gtk_app_chooser_dialog_set_heading">
<description>
Sets the text to display at the top of the dialog.
+
If the heading is not set, the dialog displays a default text.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserDialog
+<parameter_description> a `GtkAppChooserDialog`
</parameter_description>
</parameter>
<parameter name="heading">
@@ -19400,24 +22059,26 @@ Returns the currently selected application.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooser
+<parameter_description> a `GtkAppChooser`
</parameter_description>
</parameter>
</parameters>
-<return> a #GAppInfo for the currently selected
-application, or %NULL if none is selected. Free with g_object_unref()
+<return> a `GAppInfo` for the
+currently selected application, or %NULL if none is selected.
+Free with g_object_unref()
</return>
</function>
<function name="gtk_app_chooser_get_content_type">
<description>
-Returns the current value of the #GtkAppChooser:content-type property.
+Returns the content type for which the `GtkAppChooser`
+shows applications.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooser
+<parameter_description> a `GtkAppChooser`
</parameter_description>
</parameter>
</parameters>
@@ -19432,7 +22093,7 @@ Reloads the list of applications.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooser
+<parameter_description> a `GtkAppChooser`
</parameter_description>
</parameter>
</parameters>
@@ -19448,102 +22109,102 @@ that can handle the content type.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserWidget
+<parameter_description> a `GtkAppChooserWidget`
</parameter_description>
</parameter>
</parameters>
-<return> the value of #GtkAppChooserWidget:default-text
+<return> the value of [property@Gtk.AppChooserWidget:default-text]
</return>
</function>
<function name="gtk_app_chooser_widget_get_show_all">
<description>
-Returns the current value of the #GtkAppChooserWidget:show-all
-property.
+Gets whether the app chooser should show all applications
+in a flat list.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserWidget
+<parameter_description> a `GtkAppChooserWidget`
</parameter_description>
</parameter>
</parameters>
-<return> the value of #GtkAppChooserWidget:show-all
+<return> the value of [property@Gtk.AppChooserWidget:show-all]
</return>
</function>
<function name="gtk_app_chooser_widget_get_show_default">
<description>
-Returns the current value of the #GtkAppChooserWidget:show-default
-property.
+Gets whether the app chooser should show the default handler
+for the content type in a separate section.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserWidget
+<parameter_description> a `GtkAppChooserWidget`
</parameter_description>
</parameter>
</parameters>
-<return> the value of #GtkAppChooserWidget:show-default
+<return> the value of [property@Gtk.AppChooserWidget:show-default]
</return>
</function>
<function name="gtk_app_chooser_widget_get_show_fallback">
<description>
-Returns the current value of the #GtkAppChooserWidget:show-fallback
-property.
+Gets whether the app chooser should show related applications
+for the content type in a separate section.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserWidget
+<parameter_description> a `GtkAppChooserWidget`
</parameter_description>
</parameter>
</parameters>
-<return> the value of #GtkAppChooserWidget:show-fallback
+<return> the value of [property@Gtk.AppChooserWidget:show-fallback]
</return>
</function>
<function name="gtk_app_chooser_widget_get_show_other">
<description>
-Returns the current value of the #GtkAppChooserWidget:show-other
-property.
+Gets whether the app chooser should show applications
+which are unrelated to the content type.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserWidget
+<parameter_description> a `GtkAppChooserWidget`
</parameter_description>
</parameter>
</parameters>
-<return> the value of #GtkAppChooserWidget:show-other
+<return> the value of [property@Gtk.AppChooserWidget:show-other]
</return>
</function>
<function name="gtk_app_chooser_widget_get_show_recommended">
<description>
-Returns the current value of the #GtkAppChooserWidget:show-recommended
-property.
+Gets whether the app chooser should show recommended applications
+for the content type in a separate section.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserWidget
+<parameter_description> a `GtkAppChooserWidget`
</parameter_description>
</parameter>
</parameters>
-<return> the value of #GtkAppChooserWidget:show-recommended
+<return> the value of [property@Gtk.AppChooserWidget:show-recommended]
</return>
</function>
<function name="gtk_app_chooser_widget_new">
<description>
-Creates a new #GtkAppChooserWidget for applications
+Creates a new `GtkAppChooserWidget` for applications
that can handle content of the given type.
@@ -19554,7 +22215,7 @@ that can handle content of the given type.
</parameter_description>
</parameter>
</parameters>
-<return> a newly created #GtkAppChooserWidget
+<return> a newly created `GtkAppChooserWidget`
</return>
</function>
@@ -19566,11 +22227,11 @@ that can handle the content type.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserWidget
+<parameter_description> a `GtkAppChooserWidget`
</parameter_description>
</parameter>
<parameter name="text">
-<parameter_description> the new value for #GtkAppChooserWidget:default-text
+<parameter_description> the new value for [property@Gtk.AppChooserWidget:default-text]
</parameter_description>
</parameter>
</parameters>
@@ -19585,11 +22246,11 @@ in a flat list.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserWidget
+<parameter_description> a `GtkAppChooserWidget`
</parameter_description>
</parameter>
<parameter name="setting">
-<parameter_description> the new value for #GtkAppChooserWidget:show-all
+<parameter_description> the new value for [property@Gtk.AppChooserWidget:show-all]
</parameter_description>
</parameter>
</parameters>
@@ -19604,11 +22265,11 @@ for the content type in a separate section.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserWidget
+<parameter_description> a `GtkAppChooserWidget`
</parameter_description>
</parameter>
<parameter name="setting">
-<parameter_description> the new value for #GtkAppChooserWidget:show-default
+<parameter_description> the new value for [property@Gtk.AppChooserWidget:show-default]
</parameter_description>
</parameter>
</parameters>
@@ -19623,11 +22284,11 @@ for the content type in a separate section.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserWidget
+<parameter_description> a `GtkAppChooserWidget`
</parameter_description>
</parameter>
<parameter name="setting">
-<parameter_description> the new value for #GtkAppChooserWidget:show-fallback
+<parameter_description> the new value for [property@Gtk.AppChooserWidget:show-fallback]
</parameter_description>
</parameter>
</parameters>
@@ -19642,11 +22303,11 @@ which are unrelated to the content type.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserWidget
+<parameter_description> a `GtkAppChooserWidget`
</parameter_description>
</parameter>
<parameter name="setting">
-<parameter_description> the new value for #GtkAppChooserWidget:show-other
+<parameter_description> the new value for [property@Gtk.AppChooserWidget:show-other]
</parameter_description>
</parameter>
</parameters>
@@ -19661,11 +22322,11 @@ for the content type in a separate section.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAppChooserWidget
+<parameter_description> a `GtkAppChooserWidget`
</parameter_description>
</parameter>
<parameter name="setting">
-<parameter_description> the new value for #GtkAppChooserWidget:show-recommended
+<parameter_description> the new value for [property@Gtk.AppChooserWidget:show-recommended]
</parameter_description>
</parameter>
</parameters>
@@ -19674,30 +22335,30 @@ for the content type in a separate section.
<function name="gtk_application_add_window">
<description>
-Adds a window to @application.
+Adds a window to `application`.
-This call can only happen after the @application has started;
+This call can only happen after the `application` has started;
typically, you should add new application windows in response
-to the emission of the #GApplication::activate signal.
+to the emission of the `GApplication::activate` signal.
-This call is equivalent to setting the #GtkWindow:application
-property of @window to @application.
+This call is equivalent to setting the [property@Gtk.Window:application]
+property of `window` to `application`.
Normally, the connection between the application and the window
will remain until the window is destroyed, but you can explicitly
-remove it with gtk_application_remove_window().
+remove it with [method@Gtk.Application.remove_window].
-GTK+ will keep the @application running as long as it has
+GTK will keep the `application` running as long as it has
any windows.
</description>
<parameters>
<parameter name="application">
-<parameter_description> a #GtkApplication
+<parameter_description> a `GtkApplication`
</parameter_description>
</parameter>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -19713,7 +22374,7 @@ the given action.
</description>
<parameters>
<parameter name="application">
-<parameter_description> a #GtkApplication
+<parameter_description> a `GtkApplication`
</parameter_description>
</parameter>
<parameter name="detailed_action_name">
@@ -19722,14 +22383,15 @@ and target to obtain accelerators for
</parameter_description>
</parameter>
</parameters>
-<return> accelerators for @detailed_action_name, as
-a %NULL-terminated array. Free with g_strfreev() when no longer needed
+<return>
+accelerators for `detailed_action_name`
</return>
</function>
<function name="gtk_application_get_actions_for_accel">
<description>
-Returns the list of actions (possibly empty) that @accel maps to.
+Returns the list of actions (possibly empty) that `accel` maps to.
+
Each item in the list is a detailed action name in the usual form.
This might be useful to discover if an accel already exists in
@@ -19740,24 +22402,25 @@ and might make sense in cases where the actions never appear in the
same context.
In case there are no actions for a given accelerator, an empty array
-is returned. %NULL is never returned.
+is returned. `NULL` is never returned.
It is a programmer error to pass an invalid accelerator string.
-If you are unsure, check it with gtk_accelerator_parse() first.
+
+If you are unsure, check it with [func@Gtk.accelerator_parse] first.
</description>
<parameters>
<parameter name="application">
-<parameter_description> a #GtkApplication
+<parameter_description> a `GtkApplication`
</parameter_description>
</parameter>
<parameter name="accel">
-<parameter_description> an accelerator that can be parsed by gtk_accelerator_parse()
+<parameter_description> an accelerator that can be parsed by [func@Gtk.accelerator_parse]
</parameter_description>
</parameter>
</parameters>
-<return> a %NULL-terminated array of actions for @accel
+<return> a %NULL-terminated array of actions for `accel`
</return>
</function>
@@ -19774,19 +22437,19 @@ recently-focused window within this application.
</description>
<parameters>
<parameter name="application">
-<parameter_description> a #GtkApplication
+<parameter_description> a `GtkApplication`
</parameter_description>
</parameter>
</parameters>
-<return> the active window, or %NULL if
-there isn't one.
+<return> the active window
</return>
</function>
<function name="gtk_application_get_menu_by_id">
<description>
Gets a menu from automatically loaded resources.
-See [Automatic resources][automatic-resources]
+
+See [the section on Automatic resources](class.Application.html#automatic-resources)
for more information.
@@ -19809,32 +22472,32 @@ given id from the automatically loaded resources
<function name="gtk_application_get_menubar">
<description>
Returns the menu model that has been set with
-gtk_application_set_menubar().
+[method@Gtk.Application.set_menubar].
</description>
<parameters>
<parameter name="application">
-<parameter_description> a #GtkApplication
+<parameter_description> a `GtkApplication`
</parameter_description>
</parameter>
</parameters>
-<return> the menubar for windows of @application
+<return> the menubar for windows of `application`
</return>
</function>
<function name="gtk_application_get_window_by_id">
<description>
-Returns the #GtkApplicationWindow with the given ID.
+Returns the [class@Gtk.ApplicationWindow] with the given ID.
-The ID of a #GtkApplicationWindow can be retrieved with
-gtk_application_window_get_id().
+The ID of a `GtkApplicationWindow` can be retrieved with
+[method@Gtk.ApplicationWindow.get_id].
</description>
<parameters>
<parameter name="application">
-<parameter_description> a #GtkApplication
+<parameter_description> a `GtkApplication`
</parameter_description>
</parameter>
<parameter name="id">
@@ -19842,14 +22505,13 @@ gtk_application_window_get_id().
</parameter_description>
</parameter>
</parameters>
-<return> the window with ID @id, or
-%NULL if there is no window with this ID
+<return> the window for the given `id`
</return>
</function>
<function name="gtk_application_get_windows">
<description>
-Gets a list of the #GtkWindows associated with @application.
+Gets a list of the [class@Gtk.Window] instances associated with `application`.
The list is sorted by most recently focused window, such that the first
element is the currently focused window. (Useful for choosing a parent
@@ -19863,26 +22525,29 @@ deletion.
</description>
<parameters>
<parameter name="application">
-<parameter_description> a #GtkApplication
+<parameter_description> a `GtkApplication`
</parameter_description>
</parameter>
</parameters>
-<return> a #GList of #GtkWindow
+<return> a `GList` of `GtkWindow`
+instances
</return>
</function>
<function name="gtk_application_inhibit">
<description>
Inform the session manager that certain types of actions should be
-inhibited. This is not guaranteed to work on all platforms and for
-all types of actions.
+inhibited.
+
+This is not guaranteed to work on all platforms and for all types of
+actions.
Applications should invoke this method when they begin an operation
that should not be interrupted, such as creating a CD or DVD. The
-types of actions that may be blocked are specified by the @flags
+types of actions that may be blocked are specified by the `flags`
parameter. When the application completes the operation it should
-call gtk_application_uninhibit() to remove the inhibitor. Note that
-an application can have multiple inhibitors, and all of them must
+call [method@Gtk.Application.uninhibit] to remove the inhibitor. Note
+that an application can have multiple inhibitors, and all of them must
be individually removed. Inhibitors are also cleared when the
application exits.
@@ -19890,20 +22555,20 @@ Applications should not expect that they will always be able to block
the action. In most cases, users will be given the option to force
the action to take place.
-Reasons should be short and to the point.
+The `reason` message should be short and to the point.
-If @window is given, the session manager may point the user to
+If `window` is given, the session manager may point the user to
this window to find out more about why the action is inhibited.
</description>
<parameters>
<parameter name="application">
-<parameter_description> the #GtkApplication
+<parameter_description> the `GtkApplication`
</parameter_description>
</parameter>
<parameter name="window">
-<parameter_description> a #GtkWindow, or %NULL
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="flags">
@@ -19917,7 +22582,7 @@ why these operations are inhibited
</parameter>
</parameters>
<return> A non-zero cookie that is used to uniquely identify this
-request. It should be used as an argument to gtk_application_uninhibit()
+request. It should be used as an argument to [method@Gtk.Application.uninhibit]
in order to remove the request. If the platform does not support
inhibiting or the request failed for some reason, 0 is returned.
</return>
@@ -19926,43 +22591,38 @@ inhibiting or the request failed for some reason, 0 is returned.
<function name="gtk_application_list_action_descriptions">
<description>
Lists the detailed action names which have associated accelerators.
-See gtk_application_set_accels_for_action().
+
+See [method@Gtk.Application.set_accels_for_action].
</description>
<parameters>
<parameter name="application">
-<parameter_description> a #GtkApplication
+<parameter_description> a `GtkApplication`
</parameter_description>
</parameter>
</parameters>
-<return> a %NULL-terminated array of strings,
-free with g_strfreev() when done
+<return> the detailed action names
</return>
</function>
<function name="gtk_application_new">
<description>
-Creates a new #GtkApplication instance.
+Creates a new `GtkApplication` instance.
-When using #GtkApplication, it is not necessary to call gtk_init()
+When using `GtkApplication`, it is not necessary to call [func Gtk init]
manually. It is called as soon as the application gets registered as
the primary instance.
-Concretely, gtk_init() is called in the default handler for the
-#GApplication::startup signal. Therefore, #GtkApplication subclasses should
-chain up in their #GApplication::startup handler before using any GTK+ API.
+Concretely, [func Gtk init] is called in the default handler for the
+`GApplication::startup` signal. Therefore, `GtkApplication` subclasses should
+always chain up in their `GApplication::startup` handler before using any GTK
+API.
-Note that commandline arguments are not passed to gtk_init().
-All GTK+ functionality that is available via commandline arguments
-can also be achieved by setting suitable environment variables
-such as `G_DEBUG`, so this should not be a big
-problem. If you absolutely must support GTK+ commandline arguments,
-you can explicitly call gtk_init() before creating the application
-instance.
+Note that commandline arguments are not passed to [func Gtk init].
-If non-%NULL, the application ID must be valid. See
-g_application_id_is_valid().
+If `application_id` is not %NULL, then it must be valid. See
+`g_application_id_is_valid()`.
If no application ID is given then some features (most notably application
uniqueness) will be disabled.
@@ -19971,7 +22631,7 @@ uniqueness) will be disabled.
</description>
<parameters>
<parameter name="application_id">
-<parameter_description> The application ID.
+<parameter_description> The application ID
</parameter_description>
</parameter>
<parameter name="flags">
@@ -19979,29 +22639,29 @@ uniqueness) will be disabled.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkApplication instance
+<return> a new `GtkApplication` instance
</return>
</function>
<function name="gtk_application_remove_window">
<description>
-Remove a window from @application.
+Remove a window from `application`.
-If @window belongs to @application then this call is equivalent to
-setting the #GtkWindow:application property of @window to
-%NULL.
+If `window` belongs to `application` then this call is equivalent to
+setting the [property@Gtk.Window:application] property of `window` to
+`NULL`.
The application may stop running as a result of a call to this
-function.
+function, if `window` was the last window of the `application`.
</description>
<parameters>
<parameter name="application">
-<parameter_description> a #GtkApplication
+<parameter_description> a `GtkApplication`
</parameter_description>
</parameter>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -20011,19 +22671,21 @@ function.
<function name="gtk_application_set_accels_for_action">
<description>
Sets zero or more keyboard accelerators that will trigger the
-given action. The first item in @accels will be the primary
-accelerator, which may be displayed in the UI.
+given action.
+
+The first item in `accels` will be the primary accelerator, which may be
+displayed in the UI.
To remove all accelerators for an action, use an empty, zero-terminated
-array for @accels.
+array for `accels`.
-For the @detailed_action_name, see g_action_parse_detailed_name() and
-g_action_print_detailed_name().
+For the `detailed_action_name`, see `g_action_parse_detailed_name()` and
+`g_action_print_detailed_name()`.
</description>
<parameters>
<parameter name="application">
-<parameter_description> a #GtkApplication
+<parameter_description> a `GtkApplication`
</parameter_description>
</parameter>
<parameter name="detailed_action_name">
@@ -20033,7 +22695,7 @@ and target to associate accelerators with
</parameter>
<parameter name="accels">
<parameter_description> a list of accelerators in the format
-understood by gtk_accelerator_parse()
+understood by [func@Gtk.accelerator_parse]
</parameter_description>
</parameter>
</parameters>
@@ -20042,12 +22704,12 @@ understood by gtk_accelerator_parse()
<function name="gtk_application_set_menubar">
<description>
-Sets or unsets the menubar for windows of @application.
+Sets or unsets the menubar for windows of `application`.
This is a menubar in the traditional sense.
This can only be done in the primary instance of the application,
-after it has been registered. #GApplication::startup is a good place
+after it has been registered. `GApplication::startup` is a good place
to call this.
Depending on the desktop environment, this may appear at the top of
@@ -20058,17 +22720,17 @@ Other environments treat the two as completely separate — for example,
the application menu may be rendered by the desktop shell while the
menubar (if set) remains in each individual window.
-Use the base #GActionMap interface to add actions, to respond to the
+Use the base `GActionMap` interface to add actions, to respond to the
user selecting these menu items.
</description>
<parameters>
<parameter name="application">
-<parameter_description> a #GtkApplication
+<parameter_description> a `GtkApplication`
</parameter_description>
</parameter>
<parameter name="menubar">
-<parameter_description> a #GMenuModel, or %NULL
+<parameter_description> a `GMenuModel`
</parameter_description>
</parameter>
</parameters>
@@ -20077,17 +22739,20 @@ user selecting these menu items.
<function name="gtk_application_uninhibit">
<description>
-Removes an inhibitor that has been established with gtk_application_inhibit().
+Removes an inhibitor that has been previously established.
+
+See [method@Gtk.Application.inhibit].
+
Inhibitors are also cleared when the application exits.
</description>
<parameters>
<parameter name="application">
-<parameter_description> the #GtkApplication
+<parameter_description> the `GtkApplication`
</parameter_description>
</parameter>
<parameter name="cookie">
-<parameter_description> a cookie that was returned by gtk_application_inhibit()
+<parameter_description> a cookie that was returned by [method@Gtk.Application.inhibit]
</parameter_description>
</parameter>
</parameters>
@@ -20096,36 +22761,39 @@ Inhibitors are also cleared when the application exits.
<function name="gtk_application_window_get_help_overlay">
<description>
-Gets the #GtkShortcutsWindow that has been set up with
-a prior call to gtk_application_window_set_help_overlay().
+Gets the `GtkShortcutsWindow` that is associated with @window.
+
+See [method@Gtk.ApplicationWindow.set_help_overlay].
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkApplicationWindow
+<parameter_description> a `GtkApplicationWindow`
</parameter_description>
</parameter>
</parameters>
-<return> the help overlay associated with @window, or %NULL
+<return> the help overlay associated
+with @window, or %NULL
</return>
</function>
<function name="gtk_application_window_get_id">
<description>
-Returns the unique ID of the window. If the window has not yet been added to
-a #GtkApplication, returns `0`.
+Returns the unique ID of the window.
+
+If the window has not yet been added to a `GtkApplication`, returns `0`.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkApplicationWindow
+<parameter_description> a `GtkApplicationWindow`
</parameter_description>
</parameter>
</parameters>
<return> the unique ID for @window, or `0` if the window
-has not yet been added to a #GtkApplication
+has not yet been added to a `GtkApplication`
</return>
</function>
@@ -20138,7 +22806,7 @@ and menubar as needed.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkApplicationWindow
+<parameter_description> a `GtkApplicationWindow`
</parameter_description>
</parameter>
</parameters>
@@ -20148,36 +22816,37 @@ and menubar as needed.
<function name="gtk_application_window_new">
<description>
-Creates a new #GtkApplicationWindow.
+Creates a new `GtkApplicationWindow`.
</description>
<parameters>
<parameter name="application">
-<parameter_description> a #GtkApplication
+<parameter_description> a `GtkApplication`
</parameter_description>
</parameter>
</parameters>
-<return> a newly created #GtkApplicationWindow
+<return> a newly created `GtkApplicationWindow`
</return>
</function>
<function name="gtk_application_window_set_help_overlay">
<description>
-Associates a shortcuts window with the application window, and
-sets up an action with the name win.show-help-overlay to present
-it.
+Associates a shortcuts window with the application window.
+
+Additionally, sets up an action with the name
+`win.show-help-overlay` to present it.
@window takes responsibility for destroying @help_overlay.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkApplicationWindow
+<parameter_description> a `GtkApplicationWindow`
</parameter_description>
</parameter>
<parameter name="help_overlay">
-<parameter_description> a #GtkShortcutsWindow
+<parameter_description> a `GtkShortcutsWindow`
</parameter_description>
</parameter>
</parameters>
@@ -20192,7 +22861,7 @@ and menubar as needed.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkApplicationWindow
+<parameter_description> a `GtkApplicationWindow`
</parameter_description>
</parameter>
<parameter name="show_menubar">
@@ -20211,7 +22880,7 @@ Gets the child widget of @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAspectFrame
+<parameter_description> a `GtkAspectFrame`
</parameter_description>
</parameter>
</parameters>
@@ -20222,13 +22891,13 @@ Gets the child widget of @self.
<function name="gtk_aspect_frame_get_obey_child">
<description>
Returns whether the child's size request should override
-the set aspect ratio of the #GtkAspectFrame.
+the set aspect ratio of the `GtkAspectFrame`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAspectFrame
+<parameter_description> a `GtkAspectFrame`
</parameter_description>
</parameter>
</parameters>
@@ -20244,7 +22913,7 @@ Returns the desired aspect ratio of the child.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAspectFrame
+<parameter_description> a `GtkAspectFrame`
</parameter_description>
</parameter>
</parameters>
@@ -20255,13 +22924,13 @@ Returns the desired aspect ratio of the child.
<function name="gtk_aspect_frame_get_xalign">
<description>
Returns the horizontal alignment of the child within the
-allocation of the #GtkAspectFrame.
+allocation of the `GtkAspectFrame`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAspectFrame
+<parameter_description> a `GtkAspectFrame`
</parameter_description>
</parameter>
</parameters>
@@ -20272,13 +22941,13 @@ allocation of the #GtkAspectFrame.
<function name="gtk_aspect_frame_get_yalign">
<description>
Returns the vertical alignment of the child within the
-allocation of the #GtkAspectFrame.
+allocation of the `GtkAspectFrame`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAspectFrame
+<parameter_description> a `GtkAspectFrame`
</parameter_description>
</parameter>
</parameters>
@@ -20288,21 +22957,19 @@ allocation of the #GtkAspectFrame.
<function name="gtk_aspect_frame_new">
<description>
-Create a new #GtkAspectFrame.
+Create a new `GtkAspectFrame`.
</description>
<parameters>
<parameter name="xalign">
-<parameter_description> Horizontal alignment of the child within the allocation of
-the #GtkAspectFrame. This ranges from 0.0 (left aligned)
-to 1.0 (right aligned)
+<parameter_description> Horizontal alignment of the child within the parent.
+Ranges from 0.0 (left aligned) to 1.0 (right aligned)
</parameter_description>
</parameter>
<parameter name="yalign">
-<parameter_description> Vertical alignment of the child within the allocation of
-the #GtkAspectFrame. This ranges from 0.0 (top aligned)
-to 1.0 (bottom aligned)
+<parameter_description> Vertical alignment of the child within the parent.
+Ranges from 0.0 (top aligned) to 1.0 (bottom aligned)
</parameter_description>
</parameter>
<parameter name="ratio">
@@ -20315,7 +22982,7 @@ ratio is taken from the requistion of the child.
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkAspectFrame.
+<return> the new `GtkAspectFrame`.
</return>
</function>
@@ -20326,7 +22993,7 @@ Sets the child widget of @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAspectFrame
+<parameter_description> a `GtkAspectFrame`
</parameter_description>
</parameter>
<parameter name="child">
@@ -20341,12 +23008,12 @@ Sets the child widget of @self.
<description>
Sets whether the aspect ratio of the child's size
request should override the set aspect ratio of
-the #GtkAspectFrame.
+the `GtkAspectFrame`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAspectFrame
+<parameter_description> a `GtkAspectFrame`
</parameter_description>
</parameter>
<parameter name="obey_child">
@@ -20365,7 +23032,7 @@ Sets the desired aspect ratio of the child.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAspectFrame
+<parameter_description> a `GtkAspectFrame`
</parameter_description>
</parameter>
<parameter name="ratio">
@@ -20379,12 +23046,12 @@ Sets the desired aspect ratio of the child.
<function name="gtk_aspect_frame_set_xalign">
<description>
Sets the horizontal alignment of the child within the allocation
-of the #GtkAspectFrame.
+of the `GtkAspectFrame`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAspectFrame
+<parameter_description> a `GtkAspectFrame`
</parameter_description>
</parameter>
<parameter name="xalign">
@@ -20398,12 +23065,12 @@ of the #GtkAspectFrame.
<function name="gtk_aspect_frame_set_yalign">
<description>
Sets the vertical alignment of the child within the allocation
-of the #GtkAspectFrame.
+of the `GtkAspectFrame`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkAspectFrame
+<parameter_description> a `GtkAspectFrame`
</parameter_description>
</parameter>
<parameter name="yalign">
@@ -20416,16 +23083,16 @@ of the #GtkAspectFrame.
<function name="gtk_assistant_add_action_widget">
<description>
-Adds a widget to the action area of a #GtkAssistant.
+Adds a widget to the action area of a `GtkAssistant`.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -20440,11 +23107,11 @@ Appends a page to the @assistant.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="page">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -20454,9 +23121,10 @@ Appends a page to the @assistant.
<function name="gtk_assistant_commit">
<description>
-Erases the visited page history so the back button is not
-shown on the current page, and removes the cancel button
-from subsequent pages.
+Erases the visited page history.
+
+GTK will then hide the back button on the current page,
+and removes the cancel button from subsequent pages.
Use this when the information provided up to the current
page is hereafter deemed permanent and cannot be modified
@@ -20467,7 +23135,7 @@ clicked apply on a confirmation page.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
</parameters>
@@ -20482,7 +23150,7 @@ Returns the page number of the current page.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
</parameters>
@@ -20500,7 +23168,7 @@ Returns the number of pages in the @assistant
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
</parameters>
@@ -20516,7 +23184,7 @@ Returns the child widget contained in page number @page_num.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="page_num">
@@ -20532,13 +23200,13 @@ if @page_num is out of bounds
<function name="gtk_assistant_get_page">
<description>
-Returns the #GtkAssistantPage object for @child.
+Returns the `GtkAssistantPage` object for @child.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="child">
@@ -20546,7 +23214,7 @@ Returns the #GtkAssistantPage object for @child.
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkAssistantPage for @child
+<return> the `GtkAssistantPage` for @child
</return>
</function>
@@ -20558,7 +23226,7 @@ Gets whether @page is complete.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="page">
@@ -20578,7 +23246,7 @@ Gets the title for @page.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="page">
@@ -20598,7 +23266,7 @@ Gets the page type of @page.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="page">
@@ -20618,7 +23286,7 @@ Gets a list model of the assistant pages.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
</parameters>
@@ -20634,11 +23302,11 @@ Inserts a page in the @assistant at a given position.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="page">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="position">
@@ -20653,13 +23321,13 @@ or -1 to append the page to the @assistant
<function name="gtk_assistant_new">
<description>
-Creates a new #GtkAssistant.
+Creates a new `GtkAssistant`.
</description>
<parameters>
</parameters>
-<return> a newly created #GtkAssistant
+<return> a newly created `GtkAssistant`
</return>
</function>
@@ -20671,12 +23339,12 @@ It is a programming error to call this function when
there is no next page.
This function is for use when creating pages of the
-#GTK_ASSISTANT_PAGE_CUSTOM type.
+%GTK_ASSISTANT_PAGE_CUSTOM type.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
</parameters>
@@ -20691,7 +23359,7 @@ Returns the child to which @page belongs.
</description>
<parameters>
<parameter name="page">
-<parameter_description> a #GtkAssistantPage
+<parameter_description> a `GtkAssistantPage`
</parameter_description>
</parameter>
</parameters>
@@ -20707,11 +23375,11 @@ Prepends a page to the @assistant.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="page">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -20727,12 +23395,12 @@ It is a programming error to call this function when
no previous page is available.
This function is for use when creating pages of the
-#GTK_ASSISTANT_PAGE_CUSTOM type.
+%GTK_ASSISTANT_PAGE_CUSTOM type.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
</parameters>
@@ -20741,16 +23409,16 @@ This function is for use when creating pages of the
<function name="gtk_assistant_remove_action_widget">
<description>
-Removes a widget from the action area of a #GtkAssistant.
+Removes a widget from the action area of a `GtkAssistant`.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -20764,7 +23432,7 @@ Removes the @page_num’s page from @assistant.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="page_num">
@@ -20787,7 +23455,7 @@ gtk_assistant_set_forward_page_func().
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="page_num">
@@ -20814,11 +23482,11 @@ next visible page.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="page_func">
-<parameter_description> the #GtkAssistantPageFunc, or %NULL
+<parameter_description> the `GtkAssistant`PageFunc, or %NULL
to use the default one
</parameter_description>
</parameter>
@@ -20844,7 +23512,7 @@ to be able to continue the task.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="page">
@@ -20869,7 +23537,7 @@ when @page is the current page.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="page">
@@ -20893,7 +23561,7 @@ The page type determines the page behavior in the @assistant.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
<parameter name="page">
@@ -20923,7 +23591,7 @@ affects the future page flow of the assistant.
</description>
<parameters>
<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter_description> a `GtkAssistant`
</parameter_description>
</parameter>
</parameters>
@@ -20932,45 +23600,45 @@ affects the future page flow of the assistant.
<function name="gtk_at_context_create">
<description>
-Creates a new #GtkATContext instance for the given accessible role,
+Creates a new `GtkATContext` instance for the given accessible role,
accessible instance, and display connection.
-The #GtkATContext implementation being instantiated will depend on the
+The `GtkATContext` implementation being instantiated will depend on the
platform.
</description>
<parameters>
<parameter name="accessible_role">
-<parameter_description> the accessible role used by the #GtkATContext
+<parameter_description> the accessible role used by the `GtkATContext`
</parameter_description>
</parameter>
<parameter name="accessible">
-<parameter_description> the #GtkAccessible implementation using the #GtkATContext
+<parameter_description> the `GtkAccessible` implementation using the `GtkATContext`
</parameter_description>
</parameter>
<parameter name="display">
-<parameter_description> the #GdkDisplay used by the #GtkATContext
+<parameter_description> the `GdkDisplay` used by the `GtkATContext`
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkATContext
+<return> the `GtkATContext`
</return>
</function>
<function name="gtk_at_context_get_accessible">
<description>
-Retrieves the #GtkAccessible using this context.
+Retrieves the `GtkAccessible` using this context.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkATContext
+<parameter_description> a `GtkATContext`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkAccessible
+<return> a `GtkAccessible`
</return>
</function>
@@ -20982,23 +23650,23 @@ Retrieves the accessible role of this context.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkATContext
+<parameter_description> a `GtkATContext`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkAccessibleRole
+<return> a `GtkAccessibleRole`
</return>
</function>
<function name="gtk_bin_layout_new">
<description>
-Creates a new #GtkBinLayout instance.
+Creates a new `GtkBinLayout` instance.
</description>
<parameters>
</parameters>
-<return> the newly created #GtkBinLayout
+<return> the newly created `GtkBinLayout`
</return>
</function>
@@ -21010,7 +23678,7 @@ Adds @value to @self if it wasn't part of it before.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="value">
@@ -21031,7 +23699,7 @@ Adds all values from @start (inclusive) to @start + @n_items
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="start">
@@ -21054,7 +23722,7 @@ values in between. @first must be smaller than @last.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="first">
@@ -21077,7 +23745,7 @@ and inside that grid, adds a rectangle with the given @width and @height.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="start">
@@ -21102,13 +23770,13 @@ and inside that grid, adds a rectangle with the given @width and @height.
<function name="gtk_bitset_contains">
<description>
-Checks if the given @value has been added to @bitset
+Checks if the given @value has been added to @self
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="value">
@@ -21128,7 +23796,7 @@ Creates a copy of @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
</parameters>
@@ -21139,9 +23807,10 @@ values as @self
<function name="gtk_bitset_difference">
<description>
-Sets @self to be the symmetric difference of @self and @other, that
-is set @self to contain all values that were either contained in @self
-or in @other, but not in both.
+Sets @self to be the symmetric difference of @self and @other.
+
+The symmetric difference is set @self to contain all values that
+were either contained in @self or in @other, but not in both.
This operation is also called an XOR.
It is allowed for @self and @other to be the same bitset. The bitset
@@ -21150,11 +23819,11 @@ will be emptied in that case.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="other">
-<parameter_description> the #GtkBitset to compute the difference from
+<parameter_description> the `GtkBitset` to compute the difference from
</parameter_description>
</parameter>
</parameters>
@@ -21169,11 +23838,11 @@ Returns %TRUE if @self and @other contain the same values.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="other">
-<parameter_description> another #GtkBitset
+<parameter_description> another `GtkBitset`
</parameter_description>
</parameter>
</parameters>
@@ -21183,14 +23852,15 @@ Returns %TRUE if @self and @other contain the same values.
<function name="gtk_bitset_get_maximum">
<description>
-Returns the largest value in @self. If @self is empty,
-0 is returned.
+Returns the largest value in @self.
+
+If @self is empty, 0 is returned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
</parameters>
@@ -21200,14 +23870,15 @@ Returns the largest value in @self. If @self is empty,
<function name="gtk_bitset_get_minimum">
<description>
-Returns the smallest value in @self. If @self is empty,
-G_MAXUINT is returned.
+Returns the smallest value in @self.
+
+If @self is empty, `G_MAXUINT` is returned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
</parameters>
@@ -21225,7 +23896,7 @@ If @nth is >= the size of @self, 0 is returned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="nth">
@@ -21240,17 +23911,19 @@ If @nth is >= the size of @self, 0 is returned.
<function name="gtk_bitset_get_size">
<description>
Gets the number of values that were added to the set.
+
For example, if the set is empty, 0 is returned.
-Note that this function returns a #guint64, because when all values are
-set, the return value is #G_MAXUINT + 1. Unless you are sure this cannot
-happen (it can't with #GListModel), be sure to use a 64bit type.
+Note that this function returns a `guint64`, because when all
+values are set, the return value is `G_MAXUINT + 1`. Unless you
+are sure this cannot happen (it can't with `GListModel`), be sure
+to use a 64bit type.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
</parameters>
@@ -21263,15 +23936,15 @@ happen (it can't with #GListModel), be sure to use a 64bit type.
Gets the number of values that are part of the set from @first to @last
(inclusive).
-Note that this function returns a #guint64, because when all values are
-set, the return value is #G_MAXUINT + 1. Unless you are sure this cannot
-happen (it can't with #GListModel), be sure to use a 64bit type.
+Note that this function returns a `guint64`, because when all values are
+set, the return value is `G_MAXUINT + 1`. Unless you are sure this cannot
+happen (it can't with `GListModel`), be sure to use a 64bit type.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="first">
@@ -21289,8 +23962,9 @@ happen (it can't with #GListModel), be sure to use a 64bit type.
<function name="gtk_bitset_intersect">
<description>
-Sets @self to be the intersection of @self and @other, that is remove
-all values from @self that are not part of @other.
+Sets @self to be the intersection of @self and @other.
+
+In other words, remove all values from @self that are not part of @other.
It is allowed for @self and @other to be the same bitset. Nothing will
happen in that case.
@@ -21298,11 +23972,11 @@ happen in that case.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="other">
-<parameter_description> the #GtkBitset to intersect with
+<parameter_description> the `GtkBitset` to intersect with
</parameter_description>
</parameter>
</parameters>
@@ -21317,7 +23991,7 @@ Check if no value is contained in bitset.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
</parameters>
@@ -21329,14 +24003,14 @@ Check if no value is contained in bitset.
<description>
Gets the current value that @iter points to.
-If @iter is not valid and gtk_bitset_iter_is_valid() returns
-%FALSE, this function returns 0.
+If @iter is not valid and [method@Gtk.BitsetIter.is_valid]
+returns %FALSE, this function returns 0.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkBitsetIter
+<parameter_description> a `GtkBitsetIter`
</parameter_description>
</parameter>
</parameters>
@@ -21346,19 +24020,20 @@ If @iter is not valid and gtk_bitset_iter_is_valid() returns
<function name="gtk_bitset_iter_init_at">
<description>
-Initializes @iter to point to @target. If @target is not found, finds
-the next value after it. If no value >= @target exists in @set, this
-function returns %FALSE.
+Initializes @iter to point to @target.
+
+If @target is not found, finds the next value after it.
+If no value >= @target exists in @set, this function returns %FALSE.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a pointer to an uninitialized #GtkBitsetIter
+<parameter_description> a pointer to an uninitialized `GtkBitsetIter`
</parameter_description>
</parameter>
<parameter name="set">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="target">
@@ -21377,18 +24052,19 @@ function returns %FALSE.
<function name="gtk_bitset_iter_init_first">
<description>
Initializes an iterator for @set and points it to the first
-value in @set. If @set is empty, %FALSE is returned and @value
-is set to %G_MAXUINT.
+value in @set.
+
+If @set is empty, %FALSE is returned and @value is set to %G_MAXUINT.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a pointer to an uninitialized #GtkBitsetIter
+<parameter_description> a pointer to an uninitialized `GtkBitsetIter`
</parameter_description>
</parameter>
<parameter name="set">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="value">
@@ -21403,17 +24079,19 @@ is set to %G_MAXUINT.
<function name="gtk_bitset_iter_init_last">
<description>
Initializes an iterator for @set and points it to the last
-value in @set. If @set is empty, %FALSE is returned.
+value in @set.
+
+If @set is empty, %FALSE is returned.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a pointer to an uninitialized #GtkBitsetIter
+<parameter_description> a pointer to an uninitialized `GtkBitsetIter`
</parameter_description>
</parameter>
<parameter name="set">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="value">
@@ -21433,7 +24111,7 @@ Checks if @iter points to a valid value.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkBitsetIter
+<parameter_description> a `GtkBitsetIter`
</parameter_description>
</parameter>
</parameters>
@@ -21443,15 +24121,16 @@ Checks if @iter points to a valid value.
<function name="gtk_bitset_iter_next">
<description>
-Moves @iter to the next value in the set. If it was already
-pointing to the last value in the set, %FALSE is returned and
-@iter is invalidated.
+Moves @iter to the next value in the set.
+
+If it was already pointing to the last value in the set,
+%FALSE is returned and @iter is invalidated.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a pointer to a valid #GtkBitsetIter
+<parameter_description> a pointer to a valid `GtkBitsetIter`
</parameter_description>
</parameter>
<parameter name="value">
@@ -21465,15 +24144,16 @@ pointing to the last value in the set, %FALSE is returned and
<function name="gtk_bitset_iter_previous">
<description>
-Moves @iter to the previous value in the set. If it was already
-pointing to the first value in the set, %FALSE is returned and
-@iter is invalidated.
+Moves @iter to the previous value in the set.
+
+If it was already pointing to the first value in the set,
+%FALSE is returned and @iter is invalidated.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a pointer to a valid #GtkBitsetIter
+<parameter_description> a pointer to a valid `GtkBitsetIter`
</parameter_description>
</parameter>
<parameter name="value">
@@ -21519,17 +24199,17 @@ Creates a bitset with the given range set.
<function name="gtk_bitset_ref">
<description>
-Acquires a reference on the given #GtkBitset.
+Acquires a reference on the given `GtkBitset`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkBitset with an additional reference
+<return> the `GtkBitset` with an additional reference
</return>
</function>
@@ -21541,7 +24221,7 @@ Removes @value from @self if it was part of it before.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="value">
@@ -21561,7 +24241,7 @@ Removes all values from the bitset so that it is empty again.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
</parameters>
@@ -21576,7 +24256,7 @@ in @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="start">
@@ -21599,7 +24279,7 @@ values in between. @first must be smaller than @last.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="first">
@@ -21622,7 +24302,7 @@ and inside that grid, removes a rectangle with the given @width and @height.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="start">
@@ -21647,13 +24327,14 @@ and inside that grid, removes a rectangle with the given @width and @height.
<function name="gtk_bitset_shift_left">
<description>
-Shifts all values in @self to the left by @amount. Values
-smaller than @amount are discarded.
+Shifts all values in @self to the left by @amount.
+
+Values smaller than @amount are discarded.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a $GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="amount">
@@ -21666,13 +24347,14 @@ smaller than @amount are discarded.
<function name="gtk_bitset_shift_right">
<description>
-Shifts all values in @self to the right by @amount. Values
-that end up too large to be held in a #guint are discarded.
+Shifts all values in @self to the right by @amount.
+
+Values that end up too large to be held in a #guint are discarded.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a $GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="amount">
@@ -21685,8 +24367,8 @@ that end up too large to be held in a #guint are discarded.
<function name="gtk_bitset_splice">
<description>
-This is a support function for #GListModel handling, by mirroring
-the #GlistModel::items-changed signal.
+This is a support function for `GListModel` handling, by mirroring
+the `GlistModel::items-changed` signal.
First, it "cuts" the values from @position to @removed from
the bitset. That is, it removes all those values and shifts
@@ -21699,7 +24381,7 @@ up space that can then be filled.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="position">
@@ -21720,8 +24402,9 @@ up space that can then be filled.
<function name="gtk_bitset_subtract">
<description>
-Sets @self to be the subtraction of @other from @self, that is remove
-all values from @self that are part of @other.
+Sets @self to be the subtraction of @other from @self.
+
+In other words, remove all values from @self that are part of @other.
It is allowed for @self and @other to be the same bitset. The bitset
will be emptied in that case.
@@ -21729,11 +24412,11 @@ will be emptied in that case.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="other">
-<parameter_description> the #GtkBitset to subtract
+<parameter_description> the `GtkBitset` to subtract
</parameter_description>
</parameter>
</parameters>
@@ -21742,8 +24425,9 @@ will be emptied in that case.
<function name="gtk_bitset_union">
<description>
-Sets @self to be the union of @self and @other, that is add all values
-from @other into @self that weren't part of it.
+Sets @self to be the union of @self and @other.
+
+That is, add all values from @other into @self that weren't part of it.
It is allowed for @self and @other to be the same bitset. Nothing will
happen in that case.
@@ -21751,11 +24435,11 @@ happen in that case.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
<parameter name="other">
-<parameter_description> the #GtkBitset to union with
+<parameter_description> the `GtkBitset` to union with
</parameter_description>
</parameter>
</parameters>
@@ -21764,7 +24448,7 @@ happen in that case.
<function name="gtk_bitset_unref">
<description>
-Releases a reference on the given #GtkBitset.
+Releases a reference on the given `GtkBitset`.
If the reference was the last, the resources associated to the @self are
freed.
@@ -21772,7 +24456,7 @@ freed.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBitset
+<parameter_description> a `GtkBitset`
</parameter_description>
</parameter>
</parameters>
@@ -21787,7 +24471,7 @@ Gets the attributes queried on the children.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBookmarkList
+<parameter_description> a `GtkBookmarkList`
</parameter_description>
</parameter>
</parameters>
@@ -21804,7 +24488,7 @@ this list is loading.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBookmarkList
+<parameter_description> a `GtkBookmarkList`
</parameter_description>
</parameter>
</parameters>
@@ -21814,13 +24498,13 @@ this list is loading.
<function name="gtk_bookmark_list_get_io_priority">
<description>
-Gets the IO priority set via gtk_bookmark_list_set_io_priority().
+Gets the IO priority to use while loading file.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBookmarkList
+<parameter_description> a `GtkBookmarkList`
</parameter_description>
</parameter>
</parameters>
@@ -21840,7 +24524,7 @@ in between runs.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBookmarkList
+<parameter_description> a `GtkBookmarkList`
</parameter_description>
</parameter>
</parameters>
@@ -21850,7 +24534,7 @@ in between runs.
<function name="gtk_bookmark_list_new">
<description>
-Creates a new #GtkBookmarkList with the given @attributes.
+Creates a new `GtkBookmarkList` with the given @attributes.
</description>
@@ -21864,7 +24548,7 @@ Creates a new #GtkBookmarkList with the given @attributes.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkBookmarkList
+<return> a new `GtkBookmarkList`
</return>
</function>
@@ -21878,7 +24562,7 @@ of #GFileInfos will still be created.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBookmarkList
+<parameter_description> a `GtkBookmarkList`
</parameter_description>
</parameter>
<parameter name="attributes">
@@ -21898,7 +24582,7 @@ The default IO priority is %G_PRIORITY_DEFAULT.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBookmarkList
+<parameter_description> a `GtkBookmarkList`
</parameter_description>
</parameter>
<parameter name="io_priority">
@@ -21918,11 +24602,11 @@ an item should be filtered.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBoolFilter
+<parameter_description> a `GtkBoolFilter`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkExpression
+<return> a `GtkExpression`
</return>
</function>
@@ -21934,7 +24618,7 @@ Returns whether the filter inverts the expression.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBoolFilter
+<parameter_description> a `GtkBoolFilter`
</parameter_description>
</parameter>
</parameters>
@@ -21955,24 +24639,25 @@ or %NULL for none
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkBoolFilter
+<return> a new `GtkBoolFilter`
</return>
</function>
<function name="gtk_bool_filter_set_expression">
<description>
-Sets the expression that the filter uses to
-check if items should be filtered. The expression must have
-a value type of #G_TYPE_BOOLEAN.
+Sets the expression that the filter uses to check if items
+should be filtered.
+
+The expression must have a value type of %G_TYPE_BOOLEAN.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBoolFilter
+<parameter_description> a `GtkBoolFilter`
</parameter_description>
</parameter>
<parameter name="expression">
-<parameter_description> a #GtkExpression
+<parameter_description> a `GtkExpression`
</parameter_description>
</parameter>
</parameters>
@@ -21986,7 +24671,7 @@ Sets whether the filter should invert the expression.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBoolFilter
+<parameter_description> a `GtkBoolFilter`
</parameter_description>
</parameter>
<parameter name="invert">
@@ -22047,11 +24732,11 @@ Adds @child as the last child to @box.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter_description> a `GtkBox`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to append
+<parameter_description> the `GtkWidget` to append
</parameter_description>
</parameter>
</parameters>
@@ -22066,7 +24751,7 @@ Gets the value set by gtk_box_set_baseline_position().
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter_description> a `GtkBox`
</parameter_description>
</parameter>
</parameters>
@@ -22077,13 +24762,13 @@ Gets the value set by gtk_box_set_baseline_position().
<function name="gtk_box_get_homogeneous">
<description>
Returns whether the box is homogeneous (all children are the
-same size). See gtk_box_set_homogeneous().
+same size).
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter_description> a `GtkBox`
</parameter_description>
</parameter>
</parameters>
@@ -22099,7 +24784,7 @@ Gets the value set by gtk_box_set_spacing().
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter_description> a `GtkBox`
</parameter_description>
</parameter>
</parameters>
@@ -22110,21 +24795,22 @@ Gets the value set by gtk_box_set_spacing().
<function name="gtk_box_insert_child_after">
<description>
Inserts @child in the position after @sibling in the list
-of @box children. If @sibling is %NULL, insert @child at
-the first position.
+of @box children.
+
+If @sibling is %NULL, insert @child at the first position.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter_description> a `GtkBox`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to insert
+<parameter_description> the `GtkWidget` to insert
</parameter_description>
</parameter>
<parameter name="sibling">
-<parameter_description> the sibling to move @child after, or %NULL
+<parameter_description> the sibling after which to insert @child
</parameter_description>
</parameter>
</parameters>
@@ -22139,7 +24825,7 @@ Gets the value set by gtk_box_layout_set_baseline_position().
</description>
<parameters>
<parameter name="box_layout">
-<parameter_description> a #GtkBoxLayout
+<parameter_description> a `GtkBoxLayout`
</parameter_description>
</parameter>
</parameters>
@@ -22156,7 +24842,7 @@ Return: %TRUE if the layout is homogeneous
</description>
<parameters>
<parameter name="box_layout">
-<parameter_description> a #GtkBoxLayout
+<parameter_description> a `GtkBoxLayout`
</parameter_description>
</parameter>
</parameters>
@@ -22171,7 +24857,7 @@ Returns the space that @box_layout puts between children.
</description>
<parameters>
<parameter name="box_layout">
-<parameter_description> a #GtkBoxLayout
+<parameter_description> a `GtkBoxLayout`
</parameter_description>
</parameter>
</parameters>
@@ -22181,7 +24867,7 @@ Returns the space that @box_layout puts between children.
<function name="gtk_box_layout_new">
<description>
-Creates a new box layout.
+Creates a new `GtkBoxLayout`.
</description>
@@ -22208,11 +24894,11 @@ space available.
</description>
<parameters>
<parameter name="box_layout">
-<parameter_description> a #GtkBoxLayout
+<parameter_description> a `GtkBoxLayout`
</parameter_description>
</parameter>
<parameter name="position">
-<parameter_description> a #GtkBaselinePosition
+<parameter_description> a `GtkBaselinePosition`
</parameter_description>
</parameter>
</parameters>
@@ -22227,7 +24913,7 @@ size to all children.
</description>
<parameters>
<parameter name="box_layout">
-<parameter_description> a #GtkBoxLayout
+<parameter_description> a `GtkBoxLayout`
</parameter_description>
</parameter>
<parameter name="homogeneous">
@@ -22245,7 +24931,7 @@ Sets how much spacing to put between children.
</description>
<parameters>
<parameter name="box_layout">
-<parameter_description> a #GtkBoxLayout
+<parameter_description> a `GtkBoxLayout`
</parameter_description>
</parameter>
<parameter name="spacing">
@@ -22258,21 +24944,21 @@ Sets how much spacing to put between children.
<function name="gtk_box_new">
<description>
-Creates a new #GtkBox.
+Creates a new `GtkBox`.
</description>
<parameters>
<parameter name="orientation">
-<parameter_description> the box’s orientation.
+<parameter_description> the box’s orientation
</parameter_description>
</parameter>
<parameter name="spacing">
-<parameter_description> the number of pixels to place by default between children.
+<parameter_description> the number of pixels to place by default between children
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkBox.
+<return> a new `GtkBox`.
</return>
</function>
@@ -22283,11 +24969,11 @@ Adds @child as the first child to @box.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter_description> a `GtkBox`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to prepend
+<parameter_description> the `GtkWidget` to prepend
</parameter_description>
</parameter>
</parameters>
@@ -22296,14 +24982,16 @@ Adds @child as the first child to @box.
<function name="gtk_box_remove">
<description>
-Removes a child widget from @box, after it has been
-added with gtk_box_append(), gtk_box_prepend(), or
-gtk_box_insert_child_after().
+Removes a child widget from @box.
+
+The child must have been added before with
+[method Gtk Box.append], [method Gtk Box.prepend], or
+[method Gtk Box.insert_child_after].
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter_description> a `GtkBox`
</parameter_description>
</parameter>
<parameter name="child">
@@ -22317,17 +25005,18 @@ gtk_box_insert_child_after().
<function name="gtk_box_reorder_child_after">
<description>
Moves @child to the position after @sibling in the list
-of @box children. If @sibling is %NULL, move @child to
-the first position.
+of @box children.
+
+If @sibling is %NULL, move @child to the first position.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter_description> a `GtkBox`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to move, must be a child of @box
+<parameter_description> the `GtkWidget` to move, must be a child of @box
</parameter_description>
</parameter>
<parameter name="sibling">
@@ -22340,21 +25029,22 @@ the first position.
<function name="gtk_box_set_baseline_position">
<description>
-Sets the baseline position of a box. 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
+Sets the baseline position of a box.
+
+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 with respect to the
extra space available.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter_description> a `GtkBox`
</parameter_description>
</parameter>
<parameter name="position">
-<parameter_description> a #GtkBaselinePosition
+<parameter_description> a `GtkBaselinePosition`
</parameter_description>
</parameter>
</parameters>
@@ -22363,14 +25053,13 @@ extra space available.
<function name="gtk_box_set_homogeneous">
<description>
-Sets the #GtkBox:homogeneous property of @box, controlling
-whether or not all children of @box are given equal space
+Sets whether or not all children of @box are given equal space
in the box.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter_description> a `GtkBox`
</parameter_description>
</parameter>
<parameter name="homogeneous">
@@ -22384,13 +25073,12 @@ in the box.
<function name="gtk_box_set_spacing">
<description>
-Sets the #GtkBox:spacing property of @box, which is the
-number of pixels to place between children of @box.
+Sets the number of pixels to place between children of @box.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter_description> a `GtkBox`
</parameter_description>
</parameter>
<parameter name="spacing">
@@ -22405,19 +25093,18 @@ number of pixels to place between children of @box.
<description>
Gets the ID of the @buildable object.
-#GtkBuilder sets the name based on the
-[GtkBuilder UI definition][BUILDER-UI]
-used to construct the @buildable.
+`GtkBuilder` sets the name based on the ID attribute
+of the <object> tag used to construct the @buildable.
</description>
<parameters>
<parameter name="buildable">
-<parameter_description> a #GtkBuildable
+<parameter_description> a `GtkBuildable`
</parameter_description>
</parameter>
</parameters>
-<return> the ID set with gtk_buildable_set_buildable_id()
+<return> the ID of the buildable object
</return>
</function>
@@ -22572,27 +25259,30 @@ has the same kind of API.
<function name="gtk_builder_add_from_file">
<description>
-Parses a file containing a [GtkBuilder UI definition][BUILDER-UI]
-and merges it with the current contents of @builder.
+Parses a file containing a UI definition and merges it with
+the current contents of @builder.
-Most users will probably want to use gtk_builder_new_from_file().
+This function is useful if you need to call
+[method@Gtk.Builder.set_current_object]) to add user data to
+callbacks before loading GtkBuilder UI. Otherwise, you probably
+want [ctor@Gtk.Builder.new_from_file] instead.
If an error occurs, 0 will be returned and @error will be assigned a
-#GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR
-domain.
+`GError` from the `GTK_BUILDER_ERROR`, `G_MARKUP_ERROR` or `G_FILE_ERROR`
+domains.
It’s not really reasonable to attempt to handle failures of this
call. You should not use this function with untrusted files (ie:
-files that are not part of your application). Broken #GtkBuilder
+files that are not part of your application). Broken `GtkBuilder`
files can easily crash your program, and it’s possible that memory
was leaked leading up to the reported failure. The only reasonable
-thing to do when an error is detected is to call g_error().
+thing to do when an error is detected is to call `g_error()`.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
<parameter name="filename">
@@ -22610,13 +25300,16 @@ thing to do when an error is detected is to call g_error().
<function name="gtk_builder_add_from_resource">
<description>
-Parses a resource file containing a [GtkBuilder UI definition][BUILDER-UI]
+Parses a resource file containing a UI definition
and merges it with the current contents of @builder.
-Most users will probably want to use gtk_builder_new_from_resource().
+This function is useful if you need to call
+[method@Gtk.Builder.set_current_object] to add user data to
+callbacks before loading GtkBuilder UI. Otherwise, you probably
+want [ctor@Gtk.Builder.new_from_resource] instead.
If an error occurs, 0 will be returned and @error will be assigned a
-#GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_RESOURCE_ERROR
+`GError` from the %GTK_BUILDER_ERROR, %G_MARKUP_ERROR or %G_RESOURCE_ERROR
domain.
It’s not really reasonable to attempt to handle failures of this
@@ -22627,7 +25320,7 @@ to call g_error().
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
<parameter name="resource_path">
@@ -22645,14 +25338,17 @@ to call g_error().
<function name="gtk_builder_add_from_string">
<description>
-Parses a string containing a [GtkBuilder UI definition][BUILDER-UI]
-and merges it with the current contents of @builder.
+Parses a string containing a UI definition and merges it
+with the current contents of @builder.
-Most users will probably want to use gtk_builder_new_from_string().
+This function is useful if you need to call
+[method@Gtk.Builder.set_current_object] to add user data to
+callbacks before loading `GtkBuilder` UI. Otherwise, you probably
+want [ctor@Gtk.Builder.new_from_string] instead.
Upon errors %FALSE will be returned and @error will be assigned a
-#GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or
-#G_VARIANT_PARSE_ERROR domain.
+`GError` from the %GTK_BUILDER_ERROR, %G_MARKUP_ERROR or
+%G_VARIANT_PARSE_ERROR domain.
It’s not really reasonable to attempt to handle failures of this
call. The only reasonable thing to do when an error is detected is
@@ -22662,7 +25358,7 @@ to call g_error().
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
<parameter name="buffer">
@@ -22684,23 +25380,23 @@ to call g_error().
<function name="gtk_builder_add_objects_from_file">
<description>
-Parses a file containing a [GtkBuilder UI definition][BUILDER-UI]
-building only the requested objects and merges
-them with the current contents of @builder.
+Parses a file containing a UI definition building only the
+requested objects and merges them with the current contents
+of @builder.
-Upon errors 0 will be returned and @error will be assigned a
-#GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR
+Upon errors, 0 will be returned and @error will be assigned a
+`GError` from the %GTK_BUILDER_ERROR, %G_MARKUP_ERROR or %G_FILE_ERROR
domain.
If you are adding an object that depends on an object that is not
-its child (for instance a #GtkTreeView that depends on its
-#GtkTreeModel), you have to explicitly list all of them in @object_ids.
+its child (for instance a `GtkTreeView` that depends on its
+`GtkTreeModel`), you have to explicitly list all of them in @object_ids.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
<parameter name="filename">
@@ -22722,23 +25418,23 @@ its child (for instance a #GtkTreeView that depends on its
<function name="gtk_builder_add_objects_from_resource">
<description>
-Parses a resource file containing a [GtkBuilder UI definition][BUILDER-UI]
-building only the requested objects and merges
-them with the current contents of @builder.
+Parses a resource file containing a UI definition, building
+only the requested objects and merges them with the current
+contents of @builder.
-Upon errors 0 will be returned and @error will be assigned a
-#GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_RESOURCE_ERROR
+Upon errors, 0 will be returned and @error will be assigned a
+`GError` from the %GTK_BUILDER_ERROR, %G_MARKUP_ERROR or %G_RESOURCE_ERROR
domain.
If you are adding an object that depends on an object that is not
-its child (for instance a #GtkTreeView that depends on its
-#GtkTreeModel), you have to explicitly list all of them in @object_ids.
+its child (for instance a `GtkTreeView` that depends on its
+`GtkTreeModel`), you have to explicitly list all of them in @object_ids.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
<parameter name="resource_path">
@@ -22760,22 +25456,22 @@ its child (for instance a #GtkTreeView that depends on its
<function name="gtk_builder_add_objects_from_string">
<description>
-Parses a string containing a [GtkBuilder UI definition][BUILDER-UI]
-building only the requested objects and merges
-them with the current contents of @builder.
+Parses a string containing a UI definition, building only the
+requested objects and merges them with the current contents of
+@builder.
Upon errors %FALSE will be returned and @error will be assigned a
-#GError from the #GTK_BUILDER_ERROR or #G_MARKUP_ERROR domain.
+`GError` from the %GTK_BUILDER_ERROR or %G_MARKUP_ERROR domain.
If you are adding an object that depends on an object that is not
-its child (for instance a #GtkTreeView that depends on its
-#GtkTreeModel), you have to explicitly list all of them in @object_ids.
+its child (for instance a `GtkTreeView` that depends on its
+`GtkTreeModel`), you have to explicitly list all of them in @object_ids.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
<parameter name="buffer">
@@ -22801,9 +25497,10 @@ its child (for instance a #GtkTreeView that depends on its
<function name="gtk_builder_create_closure">
<description>
-Creates a closure to invoke the function called @function_name,
-by using the create_closure() implementation of @builder's
-#GtkBuilderScope.
+Creates a closure to invoke the function called @function_name.
+
+This is using the create_closure() implementation of @builder's
+[class@Gtk.BuilderScope].
If no closure could be created, %NULL will be returned and @error
will be set.
@@ -22812,7 +25509,7 @@ will be set.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
<parameter name="function_name">
@@ -22838,17 +25535,19 @@ will be set.
<function name="gtk_builder_cscope_add_callback_symbol">
<description>
-Adds the @callback_symbol to the scope of @builder under the given @callback_name.
+Adds the @callback_symbol to the scope of @builder under the
+given @callback_name.
-Using this function overrides the behavior of gtk_builder_create_closure()
-for any callback symbols that are added. Using this method allows for better
-encapsulation as it does not require that callback symbols be declared in
-the global namespace.
+Using this function overrides the behavior of
+[method@Gtk.Builder.create_closure] for any callback symbols that
+are added. Using this method allows for better encapsulation as it
+does not require that callback symbols be declared in the global
+namespace.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBuilderCScope
+<parameter_description> a `GtkBuilderCScope`
</parameter_description>
</parameter>
<parameter name="callback_name">
@@ -22865,13 +25564,15 @@ the global namespace.
<function name="gtk_builder_cscope_add_callback_symbols">
<description>
-A convenience function to add many callbacks instead of calling
-gtk_builder_cscope_add_callback_symbol() for each symbol.
+A convenience function to add many callbacks.
+
+This is equivalent to calling [method@Gtk.BuilderCScope.add_callback_symbol]
+for each symbol.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBuilderCScope
+<parameter_description> a `GtkBuilderCScope`
</parameter_description>
</parameter>
<parameter name="first_callback_name">
@@ -22892,14 +25593,14 @@ gtk_builder_cscope_add_callback_symbol() for each symbol.
<function name="gtk_builder_cscope_lookup_callback_symbol">
<description>
-Fetches a symbol previously added to @self
-with gtk_builder_cscope_add_callback_symbol().
+Fetches a symbol previously added with
+gtk_builder_cscope_add_callback_symbol().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBuilderCScope
+<parameter_description> a `GtkBuilderCScope`
</parameter_description>
</parameter>
<parameter name="callback_name">
@@ -22907,35 +25608,36 @@ with gtk_builder_cscope_add_callback_symbol().
</parameter_description>
</parameter>
</parameters>
-<return> The callback symbol in @builder for @callback_name, or %NULL
+<return> The callback symbol
+in @builder for @callback_name, or %NULL
</return>
</function>
<function name="gtk_builder_cscope_new">
<description>
-Creates a new #GtkBuilderCScope object to use with future #GtkBuilder
-instances.
+Creates a new `GtkBuilderCScope` object to use with future
+`GtkBuilder` instances.
-Calling this function is only necessary if you want to add custom
-callbacks via gtk_builder_cscope_add_callback_symbol().
+Calling this function is only necessary if you want to add
+custom callbacks via [method@Gtk.BuilderCScope.add_callback_symbol].
</description>
<parameters>
</parameters>
-<return> a new #GtkBuilderCScope
+<return> a new `GtkBuilderCScope`
</return>
</function>
<function name="gtk_builder_expose_object">
<description>
-Add @object to the @builder object pool so it can be referenced just like any
-other object built by builder.
+Add @object to the @builder object pool so it can be
+referenced just like any other object built by builder.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
<parameter name="name">
@@ -22952,17 +25654,17 @@ other object built by builder.
<function name="gtk_builder_extend_with_template">
<description>
-Main private entry point for building composite container
-components from template XML.
+Main private entry point for building composite components
+from template XML.
-This is exported purely to let gtk-builder-tool validate
+This is exported purely to let `gtk-builder-tool` validate
templates, applications have no need to call this function.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
<parameter name="object">
@@ -22998,7 +25700,7 @@ Gets the current object set via gtk_builder_set_current_object().
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
</parameters>
@@ -23008,14 +25710,16 @@ Gets the current object set via gtk_builder_set_current_object().
<function name="gtk_builder_get_object">
<description>
-Gets the object named @name. Note that this function does not
-increment the reference count of the returned object.
+Gets the object named @name.
+
+Note that this function does not increment the reference count
+of the returned object.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
<parameter name="name">
@@ -23023,28 +25727,30 @@ increment the reference count of the returned object.
</parameter_description>
</parameter>
</parameters>
-<return> the object named @name or %NULL if
-it could not be found in the object tree.
+<return> the object named @name
+or %NULL if it could not be found in the object tree.
</return>
</function>
<function name="gtk_builder_get_objects">
<description>
-Gets all objects that have been constructed by @builder. Note that
-this function does not increment the reference counts of the returned
-objects.
+Gets all objects that have been constructed by @builder.
+
+Note that this function does not increment the reference
+counts of the returned objects.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated #GSList containing all the objects
-constructed by the #GtkBuilder instance. It should be freed by
-g_slist_free()
+<return> a
+newly-allocated `GSList` containing all the objects
+constructed by the `GtkBuilder instance`. It should be
+freed by g_slist_free()
</return>
</function>
@@ -23052,17 +25758,15 @@ g_slist_free()
<description>
Gets the scope in use that was set via gtk_builder_set_scope().
-See the #GtkBuilderScope documentation for details.
-
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
</parameters>
-<return> the current scope
+<return> the current scope
</return>
</function>
@@ -23074,27 +25778,29 @@ Gets the translation domain of @builder.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
</parameters>
-<return> the translation domain or %NULL
-in case it was never set or explicitly unset via gtk_builder_set_translation_domain().
-This string is owned by the builder object and must not be modified or freed.
+<return> the translation domain
+or %NULL. This string is owned by the builder object and
+must not be modified or freed.
</return>
</function>
<function name="gtk_builder_get_type_from_name">
<description>
-Looks up a type by name, using the virtual function that
-#GtkBuilder has for that purpose. This is mainly used when
-implementing the #GtkBuildable interface on a type.
+Looks up a type by name.
+
+This is using the virtual function that `GtkBuilder` has
+for that purpose. This is mainly used when implementing
+the `GtkBuildable` interface on a type.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
<parameter name="type_name">
@@ -23102,26 +25808,25 @@ implementing the #GtkBuildable interface on a type.
</parameter_description>
</parameter>
</parameters>
-<return> the #GType found for @type_name or #G_TYPE_INVALID
+<return> the `GType` found for @type_name or %G_TYPE_INVALID
if no type was found
</return>
</function>
<function name="gtk_builder_list_item_factory_get_bytes">
<description>
-Gets the data used as the #GtkBuilder UI template for constructing
+Gets the data used as the `GtkBuilder` UI template for constructing
listitems.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBuilderListItemFactory
+<parameter_description> a `GtkBuilderListItemFactory`
</parameter_description>
</parameter>
</parameters>
-<return> The GtkBuilder data
-
+<return> The `GtkBuilder` data
</return>
</function>
@@ -23133,7 +25838,7 @@ If the data references a resource, gets the path of that resource.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBuilderListItemFactory
+<parameter_description> a `GtkBuilderListItemFactory`
</parameter_description>
</parameter>
</parameters>
@@ -23150,7 +25855,7 @@ Gets the scope used when constructing listitems.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkBuilderListItemFactory
+<parameter_description> a `GtkBuilderListItemFactory`
</parameter_description>
</parameter>
</parameters>
@@ -23160,8 +25865,8 @@ Gets the scope used when constructing listitems.
<function name="gtk_builder_list_item_factory_new_from_bytes">
<description>
-Creates s new #GtkBuilderListItemFactory that instantiates widgets
-using @bytes as the data to pass to #GtkBuilder.
+Creates a new `GtkBuilderListItemFactory` that instantiates widgets
+using @bytes as the data to pass to `GtkBuilder`.
</description>
@@ -23171,18 +25876,18 @@ using @bytes as the data to pass to #GtkBuilder.
</parameter_description>
</parameter>
<parameter name="bytes">
-<parameter_description> the bytes containing the ui file to instantiate
+<parameter_description> the `GBytes` containing the ui file to instantiate
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkBuilderListItemFactory
+<return> a new `GtkBuilderListItemFactory`
</return>
</function>
<function name="gtk_builder_list_item_factory_new_from_resource">
<description>
-Creates s new #GtkBuilderListItemFactory that instantiates widgets
-using data read from the given @resource_path to pass to #GtkBuilder.
+Creates a new `GtkBuilderListItemFactory` that instantiates widgets
+using data read from the given @resource_path to pass to `GtkBuilder`.
</description>
@@ -23196,7 +25901,7 @@ using data read from the given @resource_path to pass to #GtkBuilder.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkBuilderListItemFactory
+<return> a new `GtkBuilderListItemFactory`
</return>
</function>
@@ -23205,28 +25910,24 @@ using data read from the given @resource_path to pass to #GtkBuilder.
Creates a new empty builder object.
This function is only useful if you intend to make multiple calls
-to gtk_builder_add_from_file(), gtk_builder_add_from_resource()
-or gtk_builder_add_from_string() in order to merge multiple UI
+to [method@Gtk.Builder.add_from_file], [method@Gtk.Builder.add_from_resource]
+or [method@Gtk.Builder.add_from_string] in order to merge multiple UI
descriptions into a single builder.
-Most users will probably want to use gtk_builder_new_from_file(),
-gtk_builder_new_from_resource() or gtk_builder_new_from_string().
-
</description>
<parameters>
</parameters>
-<return> a new (empty) #GtkBuilder object
+<return> a new (empty) `GtkBuilder` object
</return>
</function>
<function name="gtk_builder_new_from_file">
<description>
-Builds the [GtkBuilder UI definition][BUILDER-UI]
-in the file @filename.
+Parses the UI definition in the file @filename.
If there is an error opening the file or parsing the description then
-the program will be aborted. You should only ever attempt to parse
+the program will be aborted. You should only ever attempt to parse
user interface descriptions that are shipped as part of your program.
@@ -23237,14 +25938,13 @@ user interface descriptions that are shipped as part of your program.
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkBuilder containing the described interface
+<return> a `GtkBuilder` containing the described interface
</return>
</function>
<function name="gtk_builder_new_from_resource">
<description>
-Builds the [GtkBuilder UI definition][BUILDER-UI]
-at @resource_path.
+Parses the UI definition at @resource_path.
If there is an error locating the resource or parsing the
description, then the program will be aborted.
@@ -23253,18 +25953,17 @@ description, then the program will be aborted.
</description>
<parameters>
<parameter name="resource_path">
-<parameter_description> a #GResource resource path
+<parameter_description> a `GResource` resource path
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkBuilder containing the described interface
+<return> a `GtkBuilder` containing the described interface
</return>
</function>
<function name="gtk_builder_new_from_string">
<description>
-Builds the user interface described by @string (in the
-[GtkBuilder UI definition][BUILDER-UI] format).
+Parses the UI definition in @string.
If @string is %NULL-terminated, then @length should be -1.
If @length is not -1, then it is the length of @string.
@@ -23285,25 +25984,26 @@ from untrusted sources.
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkBuilder containing the interface described by @string
+<return> a `GtkBuilder` containing the interface described by @string
</return>
</function>
<function name="gtk_builder_set_current_object">
<description>
-Sets the current object for the @builder. The current object can be
-thought of as the `this` object that the builder is working for and
-will often be used as the default object when an object is optional.
+Sets the current object for the @builder.
-gtk_widget_init_template() for example will set the current object to
-the widget the template is inited for.
-For functions like gtk_builder_new_from_resource(), the current object
-will be %NULL.
+The current object can be thought of as the `this` object that the
+builder is working for and will often be used as the default object
+when an object is optional.
+
+[method@Gtk.Widget.init_template] for example will set the current
+object to the widget the template is inited for. For functions like
+[ctor@Gtk.Builder.new_from_resource], the current object will be %NULL.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
<parameter name="current_object">
@@ -23319,14 +26019,12 @@ will be %NULL.
<description>
Sets the scope the builder should operate in.
-If @scope is %NULL a new #GtkBuilderCScope will be created.
-
-See the #GtkBuilderScope documentation for details.
+If @scope is %NULL a new [class@Gtk.BuilderCScope] will be created.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
<parameter name="scope">
@@ -23341,12 +26039,11 @@ See the #GtkBuilderScope documentation for details.
<function name="gtk_builder_set_translation_domain">
<description>
Sets the translation domain of @builder.
-See #GtkBuilder:translation-domain.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
<parameter name="domain">
@@ -23359,27 +26056,27 @@ See #GtkBuilder:translation-domain.
<function name="gtk_builder_value_from_string">
<description>
-This function demarshals a value from a string. This function
-calls g_value_init() on the @value argument, so it need not be
-initialised beforehand.
+Demarshals a value from a string.
-This function can handle char, uchar, boolean, int, uint, long,
-ulong, enum, flags, float, double, string, #GdkRGBA and
-#GtkAdjustment type values. Support for #GtkWidget type values is
-still to come.
+This function calls g_value_init() on the @value argument,
+so it need not be initialised beforehand.
-Upon errors %FALSE will be returned and @error will be assigned a
-#GError from the #GTK_BUILDER_ERROR domain.
+Can handle char, uchar, boolean, int, uint, long,
+ulong, enum, flags, float, double, string, `GdkRGBA` and
+`GtkAdjustment` type values.
+
+Upon errors %FALSE will be returned and @error will be
+assigned a `GError` from the %GTK_BUILDER_ERROR domain.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
<parameter name="pspec">
-<parameter_description> the #GParamSpec for the property
+<parameter_description> the `GParamSpec` for the property
</parameter_description>
</parameter>
<parameter name="string">
@@ -23387,7 +26084,7 @@ Upon errors %FALSE will be returned and @error will be assigned a
</parameter_description>
</parameter>
<parameter name="value">
-<parameter_description> the #GValue to store the result in
+<parameter_description> the `GValue` to store the result in
</parameter_description>
</parameter>
<parameter name="error">
@@ -23401,23 +26098,26 @@ Upon errors %FALSE will be returned and @error will be assigned a
<function name="gtk_builder_value_from_string_type">
<description>
-Like gtk_builder_value_from_string(), this function demarshals
-a value from a string, but takes a #GType instead of #GParamSpec.
-This function calls g_value_init() on the @value argument, so it
+Demarshals a value from a string.
+
+Unlike [method@Gtk.Builder.value_from_string], this function
+takes a `GType` instead of `GParamSpec`.
+
+Calls g_value_init() on the @value argument, so it
need not be initialised beforehand.
-Upon errors %FALSE will be returned and @error will be assigned a
-#GError from the #GTK_BUILDER_ERROR domain.
+Upon errors %FALSE will be returned and @error will be
+assigned a `GError` from the %GTK_BUILDER_ERROR domain.
</description>
<parameters>
<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter_description> a `GtkBuilder`
</parameter_description>
</parameter>
<parameter name="type">
-<parameter_description> the #GType of the value
+<parameter_description> the `GType` of the value
</parameter_description>
</parameter>
<parameter name="string">
@@ -23445,7 +26145,7 @@ Gets the child widget of @button.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter_description> a `GtkButton`
</parameter_description>
</parameter>
</parameters>
@@ -23461,7 +26161,7 @@ Returns whether the button has a frame.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter_description> a `GtkButton`
</parameter_description>
</parameter>
</parameters>
@@ -23471,33 +26171,37 @@ Returns whether the button has a frame.
<function name="gtk_button_get_icon_name">
<description>
-Returns the icon name set via gtk_button_set_icon_name().
+Returns the icon name of the button.
+
+If the icon name has not been set with [method@Gtk.Button.set_icon_name]
+the return value will be %NULL. This will be the case if you create
+an empty button with [ctor Gtk Button new] to use as a container.
</description>
<parameters>
<parameter name="button">
-<parameter_description> A #GtkButton
+<parameter_description> A `GtkButton`
</parameter_description>
</parameter>
</parameters>
-<return> The icon name set via gtk_button_set_icon_name()
+<return> The icon name set via [method@Gtk.Button.set_icon_name]
</return>
</function>
<function name="gtk_button_get_label">
<description>
-Fetches the text from the label of the button, as set by
-gtk_button_set_label(). If the label text has not
-been set the return value will be %NULL. This will be the
-case if you create an empty button with gtk_button_new() to
-use as a container.
+Fetches the text from the label of the button.
+
+If the label text has not been set with [method@Gtk.Button.set_label]
+the return value will be %NULL. This will be the case if you create
+an empty button with [ctor Gtk Button new] to use as a container.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter_description> a `GtkButton`
</parameter_description>
</parameter>
</parameters>
@@ -23508,14 +26212,15 @@ by the widget and must not be modified or freed.
<function name="gtk_button_get_use_underline">
<description>
-Returns whether an embedded underline in the button label indicates a
-mnemonic. See gtk_button_set_use_underline().
+gets whether underlines are interpreted as mnemonics.
+
+See [method@Gtk.Button.set_use_underline].
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter_description> a `GtkButton`
</parameter_description>
</parameter>
</parameters>
@@ -23526,14 +26231,15 @@ indicates the mnemonic accelerator keys.
<function name="gtk_button_new">
<description>
-Creates a new #GtkButton widget. To add a child widget to the button,
-use gtk_button_set_child().
+Creates a new `GtkButton` widget.
+
+To add a child widget to the button, use [method@Gtk.Button.set_child].
</description>
<parameters>
</parameters>
-<return> The newly created #GtkButton widget.
+<return> The newly created `GtkButton` widget.
</return>
</function>
@@ -23553,35 +26259,34 @@ will be updated appropriately.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkButton displaying the themed icon
+<return> a new `GtkButton` displaying the themed icon
</return>
</function>
<function name="gtk_button_new_with_label">
<description>
-Creates a #GtkButton widget with a #GtkLabel child containing the given
-text.
+Creates a `GtkButton` widget with a `GtkLabel` child.
</description>
<parameters>
<parameter name="label">
-<parameter_description> The text you want the #GtkLabel to hold.
+<parameter_description> The text you want the `GtkLabel` to hold
</parameter_description>
</parameter>
</parameters>
-<return> The newly created #GtkButton widget.
+<return> The newly created `GtkButton` widget
</return>
</function>
<function name="gtk_button_new_with_mnemonic">
<description>
-Creates a new #GtkButton containing a label.
+Creates a new `GtkButton` containing a label.
+
If characters in @label are preceded by an underscore, they are underlined.
If you need a literal underscore character in a label, use “__” (two
underscores). The first underlined character represents a keyboard
-accelerator called a mnemonic.
-Pressing Alt and that key activates the button.
+accelerator called a mnemonic. Pressing Alt and that key activates the button.
</description>
@@ -23592,7 +26297,7 @@ mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkButton
+<return> a new `GtkButton`
</return>
</function>
@@ -23603,7 +26308,7 @@ Sets the child widget of @button.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter_description> a `GtkButton`
</parameter_description>
</parameter>
<parameter name="child">
@@ -23616,13 +26321,14 @@ Sets the child widget of @button.
<function name="gtk_button_set_has_frame">
<description>
-Sets the style of the button. Buttons can has a flat appearance
-or have a frame drawn around them.
+Sets the style of the button.
+
+Buttons can has a flat appearance or have a frame drawn around them.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter_description> a `GtkButton`
</parameter_description>
</parameter>
<parameter name="has_frame">
@@ -23635,14 +26341,15 @@ or have a frame drawn around them.
<function name="gtk_button_set_icon_name">
<description>
-Adds a #GtkImage with the given icon name as a child. If @button already
-contains a child widget, that child widget will be removed and replaced
-with the image.
+Adds a `GtkImage` with the given icon name as a child.
+
+If @button already contains a child widget, that child widget will
+be removed and replaced with the image.
</description>
<parameters>
<parameter name="button">
-<parameter_description> A #GtkButton
+<parameter_description> A `GtkButton`
</parameter_description>
</parameter>
<parameter name="icon_name">
@@ -23662,7 +26369,7 @@ This will also clear any previously set labels.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter_description> a `GtkButton`
</parameter_description>
</parameter>
<parameter name="label">
@@ -23675,13 +26382,15 @@ This will also clear any previously set labels.
<function name="gtk_button_set_use_underline">
<description>
+Sets whether to use underlines as mnemonics.
+
If true, an underline in the text of the button label indicates
the next character should be used for the mnemonic accelerator key.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter_description> a `GtkButton`
</parameter_description>
</parameter>
<parameter name="use_underline">
@@ -23699,7 +26408,7 @@ Remove all visual markers.
</description>
<parameters>
<parameter name="calendar">
-<parameter_description> a #GtkCalendar
+<parameter_description> a `GtkCalendar`
</parameter_description>
</parameter>
</parameters>
@@ -23709,18 +26418,19 @@ Remove all visual markers.
<function name="gtk_calendar_get_date">
<description>
Returns a #GDateTime representing the shown
-year, month and the selected day, in the local
-time zone.
+year, month and the selected day.
+
+The returned date is in the local time zone.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCalendar
+<parameter_description> a `GtkCalendar`
</parameter_description>
</parameter>
</parameters>
-<return> the #GDate representing
+<return> the `GDate` representing
the shown date.
</return>
</function>
@@ -23733,7 +26443,7 @@ Returns if the @day of the @calendar is already marked.
</description>
<parameters>
<parameter name="calendar">
-<parameter_description> a #GtkCalendar
+<parameter_description> a `GtkCalendar`
</parameter_description>
</parameter>
<parameter name="day">
@@ -23748,14 +26458,16 @@ Returns if the @day of the @calendar is already marked.
<function name="gtk_calendar_get_show_day_names">
<description>
Returns whether @self is currently showing the names
-of the week days above the day numbers, i.e. the value
-of the #GtkCalendar:show-day-names property.
+of the week days.
+
+This is the value of the [property@Gtk.Calendar:show-day-names]
+property.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCalendar
+<parameter_description> a `GtkCalendar`
</parameter_description>
</parameter>
</parameters>
@@ -23765,15 +26477,17 @@ of the #GtkCalendar:show-day-names property.
<function name="gtk_calendar_get_show_heading">
<description>
-Returns whether @self is currently showing the heading,
-i.e. the value of the #GtkCalendar:show-heading property.
+Returns whether @self is currently showing the heading.
+
+This is the value of the [property@Gtk.Calendar:show-heading]
+property.
Return: Whether the calendar is showing a heading.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCalendar
+<parameter_description> a `GtkCalendar`
</parameter_description>
</parameter>
</parameters>
@@ -23783,7 +26497,9 @@ Return: Whether the calendar is showing a heading.
<function name="gtk_calendar_get_show_week_numbers">
<description>
Returns whether @self is showing week numbers right
-now, i.e. the value of the #GtkCalendar:show-week-numbers
+now.
+
+This is the value of the [property@Gtk.Calendar:show-week-numbers]
property.
Return: Whether the calendar is showing week numbers.
@@ -23791,7 +26507,7 @@ Return: Whether the calendar is showing week numbers.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCalendar
+<parameter_description> a `GtkCalendar`
</parameter_description>
</parameter>
</parameters>
@@ -23805,7 +26521,7 @@ Places a visual marker on a particular day.
</description>
<parameters>
<parameter name="calendar">
-<parameter_description> a #GtkCalendar
+<parameter_description> a `GtkCalendar`
</parameter_description>
</parameter>
<parameter name="day">
@@ -23824,18 +26540,18 @@ Creates a new calendar, with the current date being selected.
</description>
<parameters>
</parameters>
-<return> a newly #GtkCalendar widget
+<return> a newly `GtkCalendar` widget
</return>
</function>
<function name="gtk_calendar_select_day">
<description>
-Will switch to @date's year and month and select its day.
+Switches to @date's year and month and select its day.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCalendar.
+<parameter_description> a `GtkCalendar`.
</parameter_description>
</parameter>
<parameter name="date">
@@ -23853,7 +26569,7 @@ Sets whether the calendar shows day names.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCalendar
+<parameter_description> a `GtkCalendar`
</parameter_description>
</parameter>
<parameter name="value">
@@ -23866,14 +26582,15 @@ Sets whether the calendar shows day names.
<function name="gtk_calendar_set_show_heading">
<description>
-Sets whether the calendar should show a heading
-containing the current year and month as well as
+Sets whether the calendar should show a heading.
+
+The heading contains the current year and month as well as
buttons for changing both.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCalendar
+<parameter_description> a `GtkCalendar`
</parameter_description>
</parameter>
<parameter name="value">
@@ -23891,7 +26608,7 @@ Sets whether week numbers are shown in the calendar.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCalendar
+<parameter_description> a `GtkCalendar`
</parameter_description>
</parameter>
<parameter name="value">
@@ -23909,7 +26626,7 @@ Removes the visual marker from a particular day.
</description>
<parameters>
<parameter name="calendar">
-<parameter_description> a #GtkCalendar.
+<parameter_description> a `GtkCalendar`.
</parameter_description>
</parameter>
<parameter name="day">
@@ -23948,9 +26665,9 @@ callback action is finalized
<function name="gtk_cclosure_expression_new">
<description>
-This function is a variant of gtk_closure_expression_new() that
-creates a #GClosure by calling g_cclosure_new() with the given
-@callback_func, @user_data and @user_destroy.
+This function is a variant of [ctor Gtk ClosureExpression new] that
+creates a `GClosure` by calling `g_cclosure_new()` with the given
+`callback_func`, `user_data` and `user_destroy`.
</description>
@@ -23984,7 +26701,7 @@ creates a #GClosure by calling g_cclosure_new() with the given
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkExpression
+<return> a new `GtkExpression`
</return>
</function>
@@ -27190,7 +29907,7 @@ Gets the value set by gtk_center_box_set_baseline_position().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterBox
+<parameter_description> a `GtkCenterBox`
</parameter_description>
</parameter>
</parameters>
@@ -27206,7 +29923,7 @@ Gets the center widget, or %NULL if there is none.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterBox
+<parameter_description> a `GtkCenterBox`
</parameter_description>
</parameter>
</parameters>
@@ -27222,7 +29939,7 @@ Gets the end widget, or %NULL if there is none.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterBox
+<parameter_description> a `GtkCenterBox`
</parameter_description>
</parameter>
</parameters>
@@ -27238,7 +29955,7 @@ Gets the start widget, or %NULL if there is none.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterBox
+<parameter_description> a `GtkCenterBox`
</parameter_description>
</parameter>
</parameters>
@@ -27248,13 +29965,13 @@ Gets the start widget, or %NULL if there is none.
<function name="gtk_center_box_new">
<description>
-Creates a new #GtkCenterBox.
+Creates a new `GtkCenterBox`.
</description>
<parameters>
</parameters>
-<return> the new #GtkCenterBox.
+<return> the new `GtkCenterBox`.
</return>
</function>
@@ -27271,11 +29988,11 @@ available.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterBox
+<parameter_description> a `GtkCenterBox`
</parameter_description>
</parameter>
<parameter name="position">
-<parameter_description> a #GtkBaselinePosition
+<parameter_description> a `GtkBaselinePosition`
</parameter_description>
</parameter>
</parameters>
@@ -27284,12 +30001,14 @@ available.
<function name="gtk_center_box_set_center_widget">
<description>
-Sets the center widget. To remove the existing center widget, pas %NULL.
+Sets the center widget.
+
+To remove the existing center widget, pas %NULL.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterBox
+<parameter_description> a `GtkCenterBox`
</parameter_description>
</parameter>
<parameter name="child">
@@ -27302,12 +30021,14 @@ Sets the center widget. To remove the existing center widget, pas %NULL.
<function name="gtk_center_box_set_end_widget">
<description>
-Sets the end widget. To remove the existing end widget, pass %NULL.
+Sets the end widget.
+
+To remove the existing end widget, pass %NULL.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterBox
+<parameter_description> a `GtkCenterBox`
</parameter_description>
</parameter>
<parameter name="child">
@@ -27320,12 +30041,14 @@ Sets the end widget. To remove the existing end widget, pass %NULL.
<function name="gtk_center_box_set_start_widget">
<description>
-Sets the start widget. To remove the existing start widget, pass %NULL.
+Sets the start widget.
+
+To remove the existing start widget, pass %NULL.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterBox
+<parameter_description> a `GtkCenterBox`
</parameter_description>
</parameter>
<parameter name="child">
@@ -27344,7 +30067,7 @@ Returns the baseline position of the layout.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterLayout
+<parameter_description> a `GtkCenterLayout`
</parameter_description>
</parameter>
</parameters>
@@ -27360,7 +30083,7 @@ Returns the center widget of the layout.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterLayout
+<parameter_description> a `GtkCenterLayout`
</parameter_description>
</parameter>
</parameters>
@@ -27376,7 +30099,7 @@ Returns the end widget of the layout.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterLayout
+<parameter_description> a `GtkCenterLayout`
</parameter_description>
</parameter>
</parameters>
@@ -27392,7 +30115,7 @@ Gets the current orienration of the layout manager.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterLayout
+<parameter_description> a `GtkCenterLayout`
</parameter_description>
</parameter>
</parameters>
@@ -27408,7 +30131,7 @@ Returns the start widget fo the layout.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterLayout
+<parameter_description> a `GtkCenterLayout`
</parameter_description>
</parameter>
</parameters>
@@ -27418,13 +30141,13 @@ Returns the start widget fo the layout.
<function name="gtk_center_layout_new">
<description>
-Creates a new #GtkCenterLayout.
+Creates a new `GtkCenterLayout`.
</description>
<parameters>
</parameters>
-<return> the newly created #GtkCenterLayout
+<return> the newly created `GtkCenterLayout`
</return>
</function>
@@ -27435,7 +30158,7 @@ Sets the new baseline position of @self
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterLayout
+<parameter_description> a `GtkCenterLayout`
</parameter_description>
</parameter>
<parameter name="baseline_position">
@@ -27455,7 +30178,7 @@ To remove the existing center widget, pass %NULL.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterLayout
+<parameter_description> a `GtkCenterLayout`
</parameter_description>
</parameter>
<parameter name="widget">
@@ -27475,7 +30198,7 @@ To remove the existing center widget, pass %NULL.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterLayout
+<parameter_description> a `GtkCenterLayout`
</parameter_description>
</parameter>
<parameter name="widget">
@@ -27493,7 +30216,7 @@ Sets the orientation of @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterLayout
+<parameter_description> a `GtkCenterLayout`
</parameter_description>
</parameter>
<parameter name="orientation">
@@ -27513,7 +30236,7 @@ To remove the existing start widget, pass %NULL.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCenterLayout
+<parameter_description> a `GtkCenterLayout`
</parameter_description>
</parameter>
<parameter name="widget">
@@ -27526,18 +30249,17 @@ To remove the existing start widget, pass %NULL.
<function name="gtk_check_button_get_active">
<description>
-Returns the current value of the #GtkCheckButton:active property.
+Returns whether the check button is active.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCheckButton
+<parameter_description> a `GtkCheckButton`
</parameter_description>
</parameter>
</parameters>
-<return> The value of the #GtkCheckButton:active property.
-See gtk_check_button_set_active() for details on how to set a new value.
+<return> whether the check button is active
</return>
</function>
@@ -27549,64 +30271,64 @@ Returns whether the check button is in an inconsistent state.
</description>
<parameters>
<parameter name="check_button">
-<parameter_description> a #GtkCheckButton
+<parameter_description> a `GtkCheckButton`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @check_button is currently in an 'in between' state, %FALSE otherwise.
+<return> %TRUE if @check_button is currently in an inconsistent state
</return>
</function>
<function name="gtk_check_button_get_label">
<description>
-Returns the label of the checkbutton.
+Returns the label of the check button.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCheckButton
+<parameter_description> a `GtkCheckButton`
</parameter_description>
</parameter>
</parameters>
-<return> The label @self shows next to the indicator.
-If no label is shown, %NULL will be returned.
+<return> The label @self shows next
+to the indicator. If no label is shown, %NULL will be returned.
</return>
</function>
<function name="gtk_check_button_get_use_underline">
<description>
-Returns the current value of the #GtkCheckButton:use-underline property.
+Returns whether underlines in the label indicate mnemonics.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCheckButton
+<parameter_description> a `GtkCheckButton`
</parameter_description>
</parameter>
</parameters>
-<return> The value of the #GtkCheckButton:use-underline property.
-See gtk_check_button_set_use_underline() for details on how to set a new value.
+<return> The value of the [property@Gtk.CheckButton:use-underline] property.
+See [method@Gtk.CheckButton.set_use_underline] for details on how to set
+a new value.
</return>
</function>
<function name="gtk_check_button_new">
<description>
-Creates a new #GtkCheckButton.
+Creates a new `GtkCheckButton`.
</description>
<parameters>
</parameters>
-<return> a #GtkWidget.
+<return> a new `GtkCheckButton`
</return>
</function>
<function name="gtk_check_button_new_with_label">
<description>
-Creates a new #GtkCheckButton with a #GtkLabel next to it, if
-@label is non-%NULL.
+Creates a new `GtkCheckButton` with the given text.
</description>
@@ -27616,40 +30338,35 @@ Creates a new #GtkCheckButton with a #GtkLabel next to it, if
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkCheckButton
+<return> a new `GtkCheckButton`
</return>
</function>
<function name="gtk_check_button_new_with_mnemonic">
<description>
-Creates a new #GtkCheckButton containing a label. Underscores
-in @label indicate the mnemonic for the check button.
+Creates a new `GtkCheckButton` with the given text and a mnemonic.
</description>
<parameters>
<parameter name="label">
-<parameter_description> The text of the button, with an underscore in front of the
-mnemonic character
+<parameter_description> The text of the button, with an underscore
+in front of the mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkCheckButton
+<return> a new `GtkCheckButton`
</return>
</function>
<function name="gtk_check_button_set_active">
<description>
-Sets the new value of the #GtkCheckButton:active property.
-See also gtk_check_button_get_active().
-
-Setting #GtkCheckButton:active to %TRUE will add the `:checked:` state to
-both the checkbutton and the indicator CSS node.
+Changes the check buttons active state.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCheckButton
+<parameter_description> a `GtkCheckButton`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -27662,28 +30379,30 @@ both the checkbutton and the indicator CSS node.
<function name="gtk_check_button_set_group">
<description>
-Adds @self to the group of @group. In a group of multiple check buttons,
-only one button can be active at a time.
+Adds @self to the group of @group.
+
+In a group of multiple check buttons, only one button can be active
+at a time. The behavior of a checkbutton in a group is also commonly
+known as a *radio button*.
Setting the group of a check button also changes the css name of the
indicator widget's CSS node to 'radio'.
-The behavior of a checkbutton in a group is also commonly known as
-a 'radio button'.
+Setting up groups in a cycle leads to undefined behavior.
-Note that the same effect can be achieved via the #GtkActionable
-api, by using the same action with parameter type and state type 's'
+Note that the same effect can be achieved via the [interface@Gtk.Actionable]
+API, by using the same action with parameter type and state type 's'
for all buttons in the group, and giving each button its own target
value.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCheckButton
+<parameter_description> a `GtkCheckButton`
</parameter_description>
</parameter>
<parameter name="group">
-<parameter_description> another #GtkCheckButton to
+<parameter_description> another `GtkCheckButton` to
form a group with
</parameter_description>
</parameter>
@@ -27693,19 +30412,15 @@ form a group with
<function name="gtk_check_button_set_inconsistent">
<description>
-If the user has selected a range of elements (such as some text or
-spreadsheet cells) that are affected by a check button, and the
-current values in that range are inconsistent, you may want to
-display the toggle in an "in between" state. Normally you would
-turn off the inconsistent state again if the user checks the
-check button. This has to be done manually,
-gtk_check_button_set_inconsistent only affects visual appearance,
-not the semantics of the button.
+Sets the `GtkCheckButton` to inconsistent state.
+
+You shoud turn off the inconsistent state again if the user checks
+the check button. This has to be done manually.
</description>
<parameters>
<parameter name="check_button">
-<parameter_description> a #GtkCheckButton
+<parameter_description> a `GtkCheckButton`
</parameter_description>
</parameter>
<parameter name="inconsistent">
@@ -27718,15 +30433,16 @@ not the semantics of the button.
<function name="gtk_check_button_set_label">
<description>
-Sets the text of @self. If #GtkCheckButton:use-underline is %TRUE,
-the underscore in @label is interpreted as mnemonic indicator,
-see gtk_check_button_set_use_underline() for details on this behavior.
+Sets the text of @self.
+If [property@Gtk.CheckButton:use-underline] is %TRUE, an underscore
+in @label is interpreted as mnemonic indicator, see
+[method@Gtk.CheckButton.set_use_underline] for details on this behavior.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCheckButton
+<parameter_description> a `GtkCheckButton`
</parameter_description>
</parameter>
<parameter name="label">
@@ -27740,16 +30456,16 @@ to show no text
<function name="gtk_check_button_set_use_underline">
<description>
-Sets the new value of the #GtkCheckButton:use-underline property.
-See also gtk_check_button_get_use_underline().
+Sets whether underlines in the label indicate mnemonics.
-If @setting is %TRUE, an underscore character in @self's label indicates
-a mnemonic accelerator key. This behavior is similar to #GtkLabel:use-underline.
+If @setting is %TRUE, an underscore character in @self's label
+indicates a mnemonic accelerator key. This behavior is similar
+to [property@Gtk.Label:use-underline].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCheckButton
+<parameter_description> a `GtkCheckButton`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -27763,12 +30479,13 @@ a mnemonic accelerator key. This behavior is similar to #GtkLabel:use-underline.
<function name="gtk_check_version">
<description>
Checks that the GTK library in use is compatible with the
-given version. Generally you would pass in the constants
-%GTK_MAJOR_VERSION, %GTK_MINOR_VERSION, %GTK_MICRO_VERSION
-as the three arguments to this function; that produces
-a check that the library in use is compatible with
-the version of GTK the application or module was compiled
-against.
+given version.
+
+Generally you would pass in the constants %GTK_MAJOR_VERSION,
+%GTK_MINOR_VERSION, %GTK_MICRO_VERSION as the three arguments
+to this function; that produces a check that the library in
+use is compatible with the version of GTK the application or
+module was compiled against.
Compatibility is defined by two things: first the version
of the running library is newer than the version
@@ -27810,9 +30527,9 @@ or freed.
<function name="gtk_closure_expression_new">
<description>
-Creates a GtkExpression that calls @closure when it is evaluated.
-@closure is called with the @this object and the results of evaluating
-the @params expressions.
+Creates a `GtkExpression` that calls `closure` when it is evaluated.
+`closure` is called with the `this` object and the results of evaluating
+the `params` expressions.
</description>
@@ -27826,7 +30543,7 @@ the @params expressions.
</parameter_description>
</parameter>
<parameter name="n_params">
-<parameter_description> the number of params needed for evaluating @closure
+<parameter_description> the number of params needed for evaluating `closure`
</parameter_description>
</parameter>
<parameter name="params">
@@ -27834,7 +30551,7 @@ the @params expressions.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkExpression
+<return> a new `GtkExpression`
</return>
</function>
@@ -27846,7 +30563,7 @@ Gets whether the dialog is modal.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkColorButton
+<parameter_description> a `GtkColorButton`
</parameter_description>
</parameter>
</parameters>
@@ -27856,13 +30573,13 @@ Gets whether the dialog is modal.
<function name="gtk_color_button_get_title">
<description>
-Gets the title of the color selection dialog.
+Gets the title of the color chooser dialog.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkColorButton
+<parameter_description> a `GtkColorButton`
</parameter_description>
</parameter>
</parameters>
@@ -27876,7 +30593,7 @@ Creates a new color button.
This returns a widget in the form of a small button containing
a swatch representing the current selected color. When the button
-is clicked, a color-selection dialog will open, allowing the user
+is clicked, a color chooser dialog will open, allowing the user
to select a color. The swatch will be updated to reflect the new
color when the user finishes.
@@ -27890,13 +30607,13 @@ color when the user finishes.
<function name="gtk_color_button_new_with_rgba">
<description>
-Creates a new color button.
+Creates a new color button showing the given color.
</description>
<parameters>
<parameter name="rgba">
-<parameter_description> A #GdkRGBA to set the current color with
+<parameter_description> A `GdkRGBA` to set the current color with
</parameter_description>
</parameter>
</parameters>
@@ -27911,7 +30628,7 @@ Sets whether the dialog should be modal.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkColorButton
+<parameter_description> a `GtkColorButton`
</parameter_description>
</parameter>
<parameter name="modal">
@@ -27924,12 +30641,12 @@ Sets whether the dialog should be modal.
<function name="gtk_color_button_set_title">
<description>
-Sets the title for the color selection dialog.
+Sets the title for the color chooser dialog.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkColorButton
+<parameter_description> a `GtkColorButton`
</parameter_description>
</parameter>
<parameter name="title">
@@ -27942,28 +30659,28 @@ Sets the title for the color selection dialog.
<function name="gtk_color_chooser_add_palette">
<description>
-Adds a palette to the color chooser. If @orientation is horizontal,
-the colors are grouped in rows, with @colors_per_line colors
-in each row. If @horizontal is %FALSE, the colors are grouped
-in columns instead.
+Adds a palette to the color chooser.
+
+If @orientation is horizontal, the colors are grouped in rows,
+with @colors_per_line colors in each row. If @horizontal is %FALSE,
+the colors are grouped in columns instead.
-The default color palette of #GtkColorChooserWidget has
-27 colors, organized in columns of 3 colors. The default gray
-palette has 9 grays in a single row.
+The default color palette of [class@Gtk.ColorChooserWidget] has
+45 colors, organized in columns of 5 colors (this includes some
+grays).
The layout of the color chooser widget works best when the
palettes have 9-10 columns.
-Calling this function for the first time has the
-side effect of removing the default color and gray palettes
-from the color chooser.
+Calling this function for the first time has the side effect
+of removing the default color palette from the color chooser.
If @colors is %NULL, removes all previously added palettes.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkColorChooser
+<parameter_description> a `GtkColorChooser`
</parameter_description>
</parameter>
<parameter name="orientation">
@@ -27989,7 +30706,7 @@ be displayed in rows, %GTK_ORIENTATION_VERTICAL for columns
<function name="gtk_color_chooser_dialog_new">
<description>
-Creates a new #GtkColorChooserDialog.
+Creates a new `GtkColorChooserDialog`.
</description>
@@ -28003,7 +30720,7 @@ Creates a new #GtkColorChooserDialog.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkColorChooserDialog
+<return> a new `GtkColorChooserDialog`
</return>
</function>
@@ -28014,11 +30731,11 @@ Gets the currently-selected color.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkColorChooser
+<parameter_description> a `GtkColorChooser`
</parameter_description>
</parameter>
<parameter name="color">
-<parameter_description> a #GdkRGBA to fill in with the current color
+<parameter_description> a `GdkRGBA` to fill in with the current color
</parameter_description>
</parameter>
</parameters>
@@ -28033,7 +30750,7 @@ Returns whether the color chooser shows the alpha channel.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkColorChooser
+<parameter_description> a `GtkColorChooser`
</parameter_description>
</parameter>
</parameters>
@@ -28049,7 +30766,7 @@ Sets the color.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkColorChooser
+<parameter_description> a `GtkColorChooser`
</parameter_description>
</parameter>
<parameter name="color">
@@ -28067,7 +30784,7 @@ Sets whether or not the color chooser should use the alpha channel.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkColorChooser
+<parameter_description> a `GtkColorChooser`
</parameter_description>
</parameter>
<parameter name="use_alpha">
@@ -28080,13 +30797,13 @@ Sets whether or not the color chooser should use the alpha channel.
<function name="gtk_color_chooser_widget_new">
<description>
-Creates a new #GtkColorChooserWidget.
+Creates a new `GtkColorChooserWidget`.
</description>
<parameters>
</parameters>
-<return> a new #GtkColorChooserWidget
+<return> a new `GtkColorChooserWidget`
</return>
</function>
@@ -28097,12 +30814,12 @@ Appends the @column to the end of the columns in @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
<parameter name="column">
-<parameter_description> a #GtkColumnViewColumn that hasn't been added to a
-#GtkColumnView yet
+<parameter_description> a `GtkColumnViewColumn` that hasn't been added to a
+`GtkColumnView` yet
</parameter_description>
</parameter>
</parameters>
@@ -28119,7 +30836,7 @@ If @self has not been added to a column view yet, %NULL is returned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnViewColumn
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
</parameters>
@@ -28135,7 +30852,7 @@ Returns whether this column should expand.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnViewColumn
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
</parameters>
@@ -28152,7 +30869,7 @@ this column.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnViewColumn
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
</parameters>
@@ -28168,7 +30885,7 @@ Gets the fixed width of the column.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnViewColumn
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
</parameters>
@@ -28185,7 +30902,7 @@ for the column header.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnViewColumn
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
</parameters>
@@ -28201,7 +30918,7 @@ Returns whether this column is resizable.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
</parameters>
@@ -28217,11 +30934,11 @@ Returns the sorter that is associated with the column.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnViewColumn
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkSorter of @self
+<return> the `GtkSorter` of @self
</return>
</function>
@@ -28233,7 +30950,7 @@ Returns the title set with gtk_column_view_column_set_title().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnViewColumn
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
</parameters>
@@ -28249,7 +30966,7 @@ Returns whether this column is visible.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnViewColumn
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
</parameters>
@@ -28259,14 +30976,14 @@ Returns whether this column is visible.
<function name="gtk_column_view_column_new">
<description>
-Creates a new #GtkColumnViewColumn that uses the given @factory for
+Creates a new `GtkColumnViewColumn` that uses the given @factory for
mapping items to widgets.
-You most likely want to call gtk_column_add_column() next.
+You most likely want to call [method@Gtk.ColumnView.append_column] next.
-The function takes ownership of the
-argument, so you can write code like
-```
+The function takes ownership of the argument, so you can write code like:
+
+```c
column = gtk_column_view_column_new (_("Name"),
gtk_builder_list_item_factory_new_from_resource ("/name.ui"));
```
@@ -28283,7 +31000,7 @@ gtk_builder_list_item_factory_new_from_resource ("/name.ui"));
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkColumnViewColumn using the given @factory
+<return> a new `GtkColumnViewColumn` using the given @factory
</return>
</function>
@@ -28297,7 +31014,7 @@ have the expand set to %TRUE.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnViewColumn
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
<parameter name="expand">
@@ -28310,13 +31027,13 @@ have the expand set to %TRUE.
<function name="gtk_column_view_column_set_factory">
<description>
-Sets the #GtkListItemFactory to use for populating list items for this
+Sets the `GtkListItemFactory` to use for populating list items for this
column.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnViewColumn
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
<parameter name="factory">
@@ -28338,7 +31055,7 @@ width. Interactive resizing also sets the “fixed-width” property.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnViewColumn
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
<parameter name="fixed_width">
@@ -28357,11 +31074,11 @@ for the column header.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnViewColumn
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
<parameter name="menu">
-<parameter_description> a #GMenuModel, or %NULL
+<parameter_description> a `GMenuModel`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -28375,7 +31092,7 @@ Sets whether this column should be resizable by dragging.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnViewColumn
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
<parameter name="resizable">
@@ -28394,19 +31111,19 @@ If @sorter is %NULL, the column will not let users change
the sorting by clicking on its header.
This sorter can be made active by clicking on the column
-header, or by calling gtk_column_view_sort_by_column().
+header, or by calling [method@Gtk.ColumnView.sort_by_column].
-See gtk_column_view_get_sorter() for the necessary steps
-for setting up customizable sorting for #GtkColumnView.
+See [method@Gtk.ColumnView.get_sorter] for the necessary steps
+for setting up customizable sorting for [class@Gtk.ColumnView].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnViewColumn
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
<parameter name="sorter">
-<parameter_description> the #GtkSorter to associate with @column
+<parameter_description> the `GtkSorter` to associate with @column
</parameter_description>
</parameter>
</parameters>
@@ -28415,14 +31132,16 @@ for setting up customizable sorting for #GtkColumnView.
<function name="gtk_column_view_column_set_title">
<description>
-Sets the title of this column. The title is displayed in the header of a
-#GtkColumnView for this column and is therefore user-facing text that should
+Sets the title of this column.
+
+The title is displayed in the header of a `GtkColumnView`
+for this column and is therefore user-facing text that should
be translated.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnViewColumn
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
<parameter name="title">
@@ -28440,7 +31159,7 @@ Sets whether this column should be visible in views.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnViewColumn
+<parameter_description> a `GtkColumnViewColumn`
</parameter_description>
</parameter>
<parameter name="visible">
@@ -28453,15 +31172,17 @@ Sets whether this column should be visible in views.
<function name="gtk_column_view_get_columns">
<description>
-Gets the list of columns in this column view. This list is constant over
-the lifetime of @self and can be used to monitor changes to the columns
-of @self by connecting to the #GListModel:items-changed signal.
+Gets the list of columns in this column view.
+
+This list is constant over the lifetime of @self and can be used to
+monitor changes to the columns of @self by connecting to the
+::items-changed signal.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
</parameters>
@@ -28477,7 +31198,7 @@ Returns whether rows can be selected by dragging with the mouse.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
</parameters>
@@ -28493,7 +31214,7 @@ Gets the model that's currently used to read the items displayed.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
</parameters>
@@ -28509,7 +31230,7 @@ Returns whether columns are reorderable.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
</parameters>
@@ -28526,7 +31247,7 @@ between columns.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
</parameters>
@@ -28543,7 +31264,7 @@ between rows.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
</parameters>
@@ -28560,7 +31281,7 @@ selected on hover.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
</parameters>
@@ -28577,28 +31298,28 @@ To allow users to customizable sorting by clicking on column
headers, this sorter needs to be set on the sort model underneath
the model that is displayed by the view.
-See gtk_column_view_column_set_sorter() for setting up
+See [method@Gtk.ColumnViewColumn.set_sorter] for setting up
per-column sorting.
Here is an example:
-|[
+```c
gtk_column_view_column_set_sorter (column, sorter);
gtk_column_view_append_column (view, column);
sorter = g_object_ref (gtk_column_view_get_sorter (view)));
model = gtk_sort_list_model_new (store, sorter);
selection = gtk_no_selection_new (model);
gtk_column_view_set_model (view, selection);
-]|
+```
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkSorter of @self
+<return> the `GtkSorter` of @self
</return>
</function>
@@ -28611,7 +31332,7 @@ If @column is already a column of @self, it will be repositioned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
<parameter name="position">
@@ -28619,7 +31340,7 @@ If @column is already a column of @self, it will be repositioned.
</parameter_description>
</parameter>
<parameter name="column">
-<parameter_description> the #GtkColumnViewColumn to insert
+<parameter_description> the `GtkColumnViewColumn` to insert
</parameter_description>
</parameter>
</parameters>
@@ -28628,10 +31349,10 @@ If @column is already a column of @self, it will be repositioned.
<function name="gtk_column_view_new">
<description>
-Creates a new #GtkColumnView.
+Creates a new `GtkColumnView`.
-You most likely want to call gtk_column_view_append_column() to
-add columns next.
+You most likely want to call [method@Gtk.ColumnView.append_column]
+to add columns next.
</description>
@@ -28641,7 +31362,7 @@ add columns next.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkColumnView
+<return> a new `GtkColumnView`
</return>
</function>
@@ -28652,11 +31373,11 @@ Removes the @column from the list of columns of @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
<parameter name="column">
-<parameter_description> a #GtkColumnViewColumn that's part of @self
+<parameter_description> a `GtkColumnViewColumn` that's part of @self
</parameter_description>
</parameter>
</parameters>
@@ -28670,7 +31391,7 @@ Sets whether selections can be changed by dragging with the mouse.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
<parameter name="enable_rubberband">
@@ -28683,7 +31404,9 @@ Sets whether selections can be changed by dragging with the mouse.
<function name="gtk_column_view_set_model">
<description>
-Sets the #GtkSelectionModel to use.
+Sets the model to use.
+
+This must be a [iface@Gtk.SelectionModel].
</description>
<parameters>
@@ -28706,7 +31429,7 @@ Sets whether columns should be reorderable by dragging.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
<parameter name="reorderable">
@@ -28725,7 +31448,7 @@ between columns.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
<parameter name="show_column_separators">
@@ -28744,7 +31467,7 @@ between rows.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
<parameter name="show_row_separators">
@@ -28763,7 +31486,7 @@ selected on hover.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
<parameter name="single_click_activate">
@@ -28778,11 +31501,13 @@ selected on hover.
<description>
Sets the sorting of the view.
-This function should be used to set up the initial sorting. At runtime,
-users can change the sorting of a column view by clicking on the list headers.
+This function should be used to set up the initial sorting.
+At runtime, users can change the sorting of a column view
+by clicking on the list headers.
-This call only has an effect if the sorter returned by gtk_column_view_get_sorter()
-is set on a sort model, and gtk_column_view_column_set_sorter() has been called
+This call only has an effect if the sorter returned by
+[method@Gtk.ColumnView.get_sorter] is set on a sort model,
+and [method@Gtk.ColumnViewColumn.set_sorter] has been called
on @column to associate a sorter with the column.
If @column is %NULL, the view will be unsorted.
@@ -28790,11 +31515,11 @@ If @column is %NULL, the view will be unsorted.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkColumnView
+<parameter_description> a `GtkColumnView`
</parameter_description>
</parameter>
<parameter name="column">
-<parameter_description> the #GtkColumnViewColumn to sort by, or %NULL
+<parameter_description> the `GtkColumnViewColumn` to sort by, or %NULL
</parameter_description>
</parameter>
<parameter name="direction">
@@ -28807,17 +31532,18 @@ If @column is %NULL, the view will be unsorted.
<function name="gtk_combo_box_get_active">
<description>
-Returns the index of the currently active item, or -1 if there’s no
-active item. If the model is a non-flat treemodel, and the active item
-is not an immediate child of the root of the tree, this function returns
-`gtk_tree_path_get_indices (path)[0]`, where
-`path` is the #GtkTreePath of the active item.
+Returns the index of the currently active item.
+
+If the model is a non-flat treemodel, and the active item is not
+an immediate child of the root of the tree, this function returns
+`gtk_tree_path_get_indices (path)[0]`, where `path` is the
+[struct@Gtk.TreePath] of the active item.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter_description> A `GtkComboBox`
</parameter_description>
</parameter>
</parameters>
@@ -28828,23 +31554,25 @@ or -1 if there’s no active item.
<function name="gtk_combo_box_get_active_id">
<description>
-Returns the ID of the active row of @combo_box. This value is taken
-from the active row and the column specified by the #GtkComboBox:id-column
-property of @combo_box (see gtk_combo_box_set_id_column()).
+Returns the ID of the active row of @combo_box.
+
+This value is taken from the active row and the column specified
+by the [property@Gtk.ComboBox:id-column] property of @combo_box
+(see [method@Gtk.ComboBox.set_id_column]).
The returned value is an interned string which means that you can
compare the pointer by value to other interned strings and that you
must not free it.
-If the #GtkComboBox:id-column property of @combo_box is not set, or if
-no row is active, or if the active row has a %NULL ID value, then %NULL
-is returned.
+If the [property@Gtk.ComboBox:id-column] property of @combo_box is
+not set, or if no row is active, or if the active row has a %NULL
+ID value, then %NULL is returned.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter_description> a `GtkComboBox`
</parameter_description>
</parameter>
</parameters>
@@ -28854,18 +31582,19 @@ is returned.
<function name="gtk_combo_box_get_active_iter">
<description>
-Sets @iter to point to the currently active item, if any item is active.
-Otherwise, @iter is left unchanged.
+Sets @iter to point to the currently active item.
+
+If no item is active, @iter is left unchanged.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter_description> A `GtkComboBox`
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> A #GtkTreeIter
+<parameter_description> A `GtkTreeIter`
</parameter_description>
</parameter>
</parameters>
@@ -28882,15 +31611,15 @@ sensitive or not when there are no items in the model.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter_description> a `GtkComboBox`
</parameter_description>
</parameter>
</parameters>
<return> %GTK_SENSITIVITY_ON if the dropdown button
is sensitive when the model is empty, %GTK_SENSITIVITY_OFF
-if the button is always insensitive or
-%GTK_SENSITIVITY_AUTO if it is only sensitive as long as
-the model has one item to be selected.
+if the button is always insensitive or %GTK_SENSITIVITY_AUTO
+if it is only sensitive as long as the model has one item to
+be selected.
</return>
</function>
@@ -28902,7 +31631,7 @@ Gets the child widget of @combo_box.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter_description> a `GtkComboBox`
</parameter_description>
</parameter>
</parameters>
@@ -28919,7 +31648,7 @@ from to display in the internal entry.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBox.
+<parameter_description> A `GtkComboBox`
</parameter_description>
</parameter>
</parameters>
@@ -28935,7 +31664,7 @@ Returns whether the combo box has an entry.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter_description> a `GtkComboBox`
</parameter_description>
</parameter>
</parameters>
@@ -28952,7 +31681,7 @@ for values from.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter_description> A `GtkComboBox`
</parameter_description>
</parameter>
</parameters>
@@ -28962,31 +31691,30 @@ for values from.
<function name="gtk_combo_box_get_model">
<description>
-Returns the #GtkTreeModel which is acting as data source for @combo_box.
+Returns the `GtkTreeModel` of @combo_box.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter_description> A `GtkComboBox`
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkTreeModel which was passed
+<return> A `GtkTreeModel` which was passed
during construction.
</return>
</function>
<function name="gtk_combo_box_get_popup_fixed_width">
<description>
-Gets whether the popup uses a fixed width matching
-the allocated width of the combo box.
+Gets whether the popup uses a fixed width.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter_description> a `GtkComboBox`
</parameter_description>
</parameter>
</parameters>
@@ -29002,7 +31730,7 @@ Returns the current row separator function.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter_description> a `GtkComboBox`
</parameter_description>
</parameter>
</parameters>
@@ -29012,58 +31740,57 @@ Returns the current row separator function.
<function name="gtk_combo_box_new">
<description>
-Creates a new empty #GtkComboBox.
+Creates a new empty `GtkComboBox`.
</description>
<parameters>
</parameters>
-<return> A new #GtkComboBox.
+<return> A new `GtkComboBox`
</return>
</function>
<function name="gtk_combo_box_new_with_entry">
<description>
-Creates a new empty #GtkComboBox with an entry.
+Creates a new empty `GtkComboBox` with an entry.
</description>
<parameters>
</parameters>
-<return> A new #GtkComboBox.
+<return> A new `GtkComboBox`
</return>
</function>
<function name="gtk_combo_box_new_with_model">
<description>
-Creates a new #GtkComboBox with the model initialized to @model.
+Creates a new `GtkComboBox` with a model.
</description>
<parameters>
<parameter name="model">
-<parameter_description> A #GtkTreeModel.
+<parameter_description> a `GtkTreeModel`
</parameter_description>
</parameter>
</parameters>
-<return> A new #GtkComboBox.
+<return> A new `GtkComboBox`
</return>
</function>
<function name="gtk_combo_box_new_with_model_and_entry">
<description>
-Creates a new empty #GtkComboBox with an entry
-and with the model initialized to @model.
+Creates a new empty `GtkComboBox` with an entry and a model.
</description>
<parameters>
<parameter name="model">
-<parameter_description> A #GtkTreeModel
+<parameter_description> A `GtkTreeModel`
</parameter_description>
</parameter>
</parameters>
-<return> A new #GtkComboBox
+<return> A new `GtkComboBox`
</return>
</function>
@@ -29077,7 +31804,7 @@ applications should have little use for it.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter_description> a `GtkComboBox`
</parameter_description>
</parameter>
</parameters>
@@ -29096,7 +31823,7 @@ Before calling this, @combo_box must be mapped, or nothing will happen.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter_description> a `GtkComboBox`
</parameter_description>
</parameter>
</parameters>
@@ -29105,19 +31832,21 @@ Before calling this, @combo_box must be mapped, or nothing will happen.
<function name="gtk_combo_box_popup_for_device">
<description>
-Pops up the menu of @combo_box. Note that currently this does not do anything
-with the device, as it was previously only used for list-mode combo boxes,
-and those were removed in GTK 4. However, it is retained in case similar
-functionality is added back later.
+Pops up the menu of @combo_box.
+
+Note that currently this does not do anything with the device, as it was
+previously only used for list-mode combo boxes, and those were removed
+in GTK 4. However, it is retained in case similar functionality is added
+back later.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter_description> a `GtkComboBox`
</parameter_description>
</parameter>
<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter_description> a `GdkDevice`
</parameter_description>
</parameter>
</parameters>
@@ -29131,12 +31860,12 @@ Sets the active item of @combo_box to be the item at @index.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter_description> a `GtkComboBox`
</parameter_description>
</parameter>
<parameter name="index_">
-<parameter_description> An index in the model passed during construction, or -1 to have
-no active item
+<parameter_description> An index in the model passed during construction,
+or -1 to have no active item
</parameter_description>
</parameter>
</parameters>
@@ -29146,17 +31875,20 @@ no active item
<function name="gtk_combo_box_set_active_id">
<description>
Changes the active row of @combo_box to the one that has an ID equal to
-@active_id, or unsets the active row if @active_id is %NULL. Rows having
+@active_id.
+
+If @active_id is %NULL, the active row is unset. Rows having
a %NULL ID string cannot be made active by this function.
-If the #GtkComboBox:id-column property of @combo_box is unset or if no
-row has the given ID then the function does nothing and returns %FALSE.
+If the [property@Gtk.ComboBox:id-column] property of @combo_box is
+unset or if no row has the given ID then the function does nothing
+and returns %FALSE.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter_description> a `GtkComboBox`
</parameter_description>
</parameter>
<parameter name="active_id">
@@ -29164,7 +31896,7 @@ row has the given ID then the function does nothing and returns %FALSE.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a row with a matching ID was found. If a %NULL
+<return> %TRUE if a row with a matching ID was found. If a %NULL
@active_id was given to unset the active row, the function
always returns %TRUE.
</return>
@@ -29172,17 +31904,18 @@ always returns %TRUE.
<function name="gtk_combo_box_set_active_iter">
<description>
-Sets the current active item to be the one referenced by @iter, or
-unsets the active item if @iter is %NULL.
+Sets the current active item to be the one referenced by @iter.
+
+If @iter is %NULL, the active item is unset.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter_description> A `GtkComboBox`
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> The #GtkTreeIter, or %NULL
+<parameter_description> The `GtkTreeIter`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -29191,14 +31924,13 @@ unsets the active item if @iter is %NULL.
<function name="gtk_combo_box_set_button_sensitivity">
<description>
-Sets whether the dropdown button of the combo box should be
-always sensitive (%GTK_SENSITIVITY_ON), never sensitive (%GTK_SENSITIVITY_OFF)
-or only if there is at least one item to display (%GTK_SENSITIVITY_AUTO).
+Sets whether the dropdown button of the combo box should update
+its sensitivity depending on the model contents.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter_description> a `GtkComboBox`
</parameter_description>
</parameter>
<parameter name="sensitivity">
@@ -29216,7 +31948,7 @@ Sets the child widget of @combo_box.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter_description> a `GtkComboBox`
</parameter_description>
</parameter>
<parameter name="child">
@@ -29229,17 +31961,19 @@ Sets the child widget of @combo_box.
<function name="gtk_combo_box_set_entry_text_column">
<description>
-Sets the model column which @combo_box should use to get strings from
-to be @text_column. The column @text_column in the model of @combo_box
-must be of type %G_TYPE_STRING.
+Sets the model column which @combo_box should use to get strings
+from to be @text_column.
+
+The column @text_column in the model of @combo_box must be of
+type %G_TYPE_STRING.
This is only relevant if @combo_box has been created with
-#GtkComboBox:has-entry as %TRUE.
+[property@Gtk.ComboBox:has-entry] as %TRUE.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter_description> A `GtkComboBox`
</parameter_description>
</parameter>
<parameter name="text_column">
@@ -29254,13 +31988,15 @@ the internal entry
<function name="gtk_combo_box_set_id_column">
<description>
Sets the model column which @combo_box should use to get string IDs
-for values from. The column @id_column in the model of @combo_box
-must be of type %G_TYPE_STRING.
+for values from.
+
+The column @id_column in the model of @combo_box must be of type
+%G_TYPE_STRING.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter_description> A `GtkComboBox`
</parameter_description>
</parameter>
<parameter name="id_column">
@@ -29273,21 +32009,23 @@ must be of type %G_TYPE_STRING.
<function name="gtk_combo_box_set_model">
<description>
-Sets the model used by @combo_box to be @model. Will unset a previously set
-model (if applicable). If model is %NULL, then it will unset the model.
+Sets the model used by @combo_box to be @model.
+
+Will unset a previously set model (if applicable). If model is %NULL,
+then it will unset the model.
Note that this function does not clear the cell renderers, you have to
-call gtk_cell_layout_clear() yourself if you need to set up different
+call [method@Gtk.CellLayout.clear] yourself if you need to set up different
cell renderers for the new model.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter_description> A `GtkComboBox`
</parameter_description>
</parameter>
<parameter name="model">
-<parameter_description> A #GtkTreeModel
+<parameter_description> A `GtkTreeModel`
</parameter_description>
</parameter>
</parameters>
@@ -29296,13 +32034,15 @@ cell renderers for the new model.
<function name="gtk_combo_box_set_popup_fixed_width">
<description>
-Specifies whether the popup’s width should be a fixed width
-matching the allocated width of the combo box.
+Specifies whether the popup’s width should be a fixed width.
+
+If @fixed is %TRUE, the popup's width is set to match the
+allocated width of the combo box.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter_description> a `GtkComboBox`
</parameter_description>
</parameter>
<parameter name="fixed">
@@ -29316,17 +32056,19 @@ matching the allocated width of the combo box.
<function name="gtk_combo_box_set_row_separator_func">
<description>
Sets the row separator function, which is used to determine
-whether a row should be drawn as a separator. If the row separator
-function is %NULL, no separators are drawn. This is the default value.
+whether a row should be drawn as a separator.
+
+If the row separator function is %NULL, no separators are drawn.
+This is the default value.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter_description> a `GtkComboBox`
</parameter_description>
</parameter>
<parameter name="func">
-<parameter_description> a #GtkTreeViewRowSeparatorFunc
+<parameter_description> a `GtkTreeViewRowSeparatorFunc`
</parameter_description>
</parameter>
<parameter name="data">
@@ -29344,15 +32086,16 @@ function is %NULL, no separators are drawn. This is the default value.
<function name="gtk_combo_box_text_append">
<description>
Appends @text to the list of strings stored in @combo_box.
+
If @id is non-%NULL then it is used as the ID of the row.
-This is the same as calling gtk_combo_box_text_insert() with a
-position of -1.
+This is the same as calling [method@Gtk.ComboBoxText.insert]
+with a position of -1.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBoxText
+<parameter_description> A `GtkComboBoxText`
</parameter_description>
</parameter>
<parameter name="id">
@@ -29371,13 +32114,13 @@ position of -1.
<description>
Appends @text to the list of strings stored in @combo_box.
-This is the same as calling gtk_combo_box_text_insert_text() with a
-position of -1.
+This is the same as calling [method@Gtk.ComboBoxText.insert_text]
+with a position of -1.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBoxText
+<parameter_description> A `GtkComboBoxText`
</parameter_description>
</parameter>
<parameter name="text">
@@ -29390,36 +32133,40 @@ position of -1.
<function name="gtk_combo_box_text_get_active_text">
<description>
-Returns the currently active string in @combo_box, or %NULL
-if none is selected. If @combo_box contains an entry, this
-function will return its contents (which will not necessarily
+Returns the currently active string in @combo_box.
+
+If no row is currently selected, %NULL is returned.
+If @combo_box contains an entry, this function will
+return its contents (which will not necessarily
be an item from the list).
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBoxText
+<parameter_description> A `GtkComboBoxText`
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string containing the
-currently active text. Must be freed with g_free().
+<return> a newly allocated
+string containing the currently active text.
+Must be freed with g_free().
</return>
</function>
<function name="gtk_combo_box_text_insert">
<description>
Inserts @text at @position in the list of strings stored in @combo_box.
-If @id is non-%NULL then it is used as the ID of the row. See
-#GtkComboBox:id-column.
+
+If @id is non-%NULL then it is used as the ID of the row.
+See [property@Gtk.ComboBox:id-column].
If @position is negative then @text is appended.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBoxText
+<parameter_description> A `GtkComboBoxText`
</parameter_description>
</parameter>
<parameter name="position">
@@ -29444,13 +32191,13 @@ Inserts @text at @position in the list of strings stored in @combo_box.
If @position is negative then @text is appended.
-This is the same as calling gtk_combo_box_text_insert() with a %NULL
-ID string.
+This is the same as calling [method@Gtk.ComboBoxText.insert]
+with a %NULL ID string.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBoxText
+<parameter_description> A `GtkComboBoxText`
</parameter_description>
</parameter>
<parameter name="position">
@@ -29467,42 +32214,41 @@ ID string.
<function name="gtk_combo_box_text_new">
<description>
-Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying
-strings.
+Creates a new `GtkComboBoxText`.
</description>
<parameters>
</parameters>
-<return> A new #GtkComboBoxText
+<return> A new `GtkComboBoxText`
</return>
</function>
<function name="gtk_combo_box_text_new_with_entry">
<description>
-Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying
-strings. The combo box created by this function has an entry.
+Creates a new `GtkComboBoxText` with an entry.
</description>
<parameters>
</parameters>
-<return> a new #GtkComboBoxText
+<return> a new `GtkComboBoxText`
</return>
</function>
<function name="gtk_combo_box_text_prepend">
<description>
Prepends @text to the list of strings stored in @combo_box.
+
If @id is non-%NULL then it is used as the ID of the row.
-This is the same as calling gtk_combo_box_text_insert() with a
-position of 0.
+This is the same as calling [method@Gtk.ComboBoxText.insert]
+with a position of 0.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter_description> A `GtkComboBox`
</parameter_description>
</parameter>
<parameter name="id">
@@ -29521,13 +32267,13 @@ position of 0.
<description>
Prepends @text to the list of strings stored in @combo_box.
-This is the same as calling gtk_combo_box_text_insert_text() with a
-position of 0.
+This is the same as calling [method@Gtk.ComboBoxText.insert_text]
+with a position of 0.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter_description> A `GtkComboBox`
</parameter_description>
</parameter>
<parameter name="text">
@@ -29545,7 +32291,7 @@ Removes the string at @position from @combo_box.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter_description> A `GtkComboBox`
</parameter_description>
</parameter>
<parameter name="position">
@@ -29563,7 +32309,7 @@ Removes all the text entries from the combo box.
</description>
<parameters>
<parameter name="combo_box">
-<parameter_description> A #GtkComboBoxText
+<parameter_description> A `GtkComboBoxText`
</parameter_description>
</parameter>
</parameters>
@@ -29578,7 +32324,7 @@ Gets the value that a constant expression evaluates to.
</description>
<parameters>
<parameter name="expression">
-<parameter_description> a constant #GtkExpression
+<parameter_description> a constant `GtkExpression`
</parameter_description>
</parameter>
</parameters>
@@ -29588,7 +32334,7 @@ Gets the value that a constant expression evaluates to.
<function name="gtk_constant_expression_new">
<description>
-Creates a GtkExpression that evaluates to the
+Creates a `GtkExpression` that evaluates to the
object given by the arguments.
@@ -29603,23 +32349,23 @@ object given by the arguments.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkExpression
+<return> a new `GtkExpression`
</return>
</function>
<function name="gtk_constant_expression_new_for_value">
<description>
-Creates an expression that always evaluates to the given @value.
+Creates an expression that always evaluates to the given `value`.
</description>
<parameters>
<parameter name="value">
-<parameter_description> a #GValue
+<parameter_description> a `GValue`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkExpression
+<return> a new `GtkExpression`
</return>
</function>
@@ -29631,7 +32377,7 @@ Retrieves the constant factor added to the source attributes' value.
</description>
<parameters>
<parameter name="constraint">
-<parameter_description> a #GtkConstraint
+<parameter_description> a `GtkConstraint`
</parameter_description>
</parameter>
</parameters>
@@ -29648,7 +32394,7 @@ attribute's value.
</description>
<parameters>
<parameter name="constraint">
-<parameter_description> a #GtkConstraint
+<parameter_description> a `GtkConstraint`
</parameter_description>
</parameter>
</parameters>
@@ -29658,26 +32404,27 @@ attribute's value.
<function name="gtk_constraint_get_relation">
<description>
-The order relation between the terms of the @constraint.
+The order relation between the terms of the constraint.
</description>
<parameters>
<parameter name="constraint">
-<parameter_description> a #GtkConstraint
+<parameter_description> a `GtkConstraint`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkConstraintRelation value
+<return> a relation type
</return>
</function>
<function name="gtk_constraint_get_source">
<description>
-Retrieves the #GtkConstraintTarget used as the source for @constraint.
+Retrieves the [iface@Gtk.ConstraintTarget] used as the source for the
+constraint.
-If the #GtkConstraint:source property is set to %NULL, the @constraint
-will use the #GtkConstraintLayout's widget.
+If the source is set to `NULL` at creation, the constraint will use
+the widget using the [class@Gtk.ConstraintLayout] as the source.
</description>
@@ -29687,23 +32434,23 @@ will use the #GtkConstraintLayout's widget.
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkConstraintTarget
+<return> the source of the constraint
</return>
</function>
<function name="gtk_constraint_get_source_attribute">
<description>
-Retrieves the attribute of the source to be read by the @constraint.
+Retrieves the attribute of the source to be read by the constraint.
</description>
<parameters>
<parameter name="constraint">
-<parameter_description> a #GtkConstraint
+<parameter_description> a `GtkConstraint`
</parameter_description>
</parameter>
</parameters>
-<return> the target's attribute
+<return> the source's attribute
</return>
</function>
@@ -29715,26 +32462,27 @@ Retrieves the strength of the constraint.
</description>
<parameters>
<parameter name="constraint">
-<parameter_description> a #GtkConstraint
+<parameter_description> a `GtkConstraint`
</parameter_description>
</parameter>
</parameters>
-<return> the strength of the constraint
+<return> the strength value
</return>
</function>
<function name="gtk_constraint_get_target">
<description>
-Retrieves the #GtkConstraintTarget used as the target for @constraint.
+Retrieves the [iface@Gtk.ConstraintTarget] used as the target for
+the constraint.
-If the #GtkConstraint:target property is set to %NULL, the @constraint
-will use the #GtkConstraintLayout's widget.
+If the targe is set to `NULL` at creation, the constraint will use
+the widget using the [class@Gtk.ConstraintLayout] as the target.
</description>
<parameters>
<parameter name="constraint">
-<parameter_description> a #GtkConstraint
+<parameter_description> a `GtkConstraint`
</parameter_description>
</parameter>
</parameters>
@@ -29744,13 +32492,13 @@ will use the #GtkConstraintLayout's widget.
<function name="gtk_constraint_get_target_attribute">
<description>
-Retrieves the attribute of the target to be set by the @constraint.
+Retrieves the attribute of the target to be set by the constraint.
</description>
<parameters>
<parameter name="constraint">
-<parameter_description> a #GtkConstraint
+<parameter_description> a `GtkConstraint`
</parameter_description>
</parameter>
</parameters>
@@ -29765,7 +32513,7 @@ Gets the maximum size of @guide.
</description>
<parameters>
<parameter name="guide">
-<parameter_description> a #GtkConstraintGuide object
+<parameter_description> a `GtkConstraintGuide` object
</parameter_description>
</parameter>
<parameter name="width">
@@ -29789,7 +32537,7 @@ Gets the minimum size of @guide.
</description>
<parameters>
<parameter name="guide">
-<parameter_description> a #GtkConstraintGuide object
+<parameter_description> a `GtkConstraintGuide` object
</parameter_description>
</parameter>
<parameter name="width">
@@ -29814,7 +32562,7 @@ Retrieves the name set using gtk_constraint_guide_set_name().
</description>
<parameters>
<parameter name="guide">
-<parameter_description> a #GtkConstraintGuide
+<parameter_description> a `GtkConstraintGuide`
</parameter_description>
</parameter>
</parameters>
@@ -29829,7 +32577,7 @@ Gets the natural size of @guide.
</description>
<parameters>
<parameter name="guide">
-<parameter_description> a #GtkConstraintGuide object
+<parameter_description> a `GtkConstraintGuide` object
</parameter_description>
</parameter>
<parameter name="width">
@@ -29854,7 +32602,7 @@ Retrieves the strength set using gtk_constraint_guide_set_strength().
</description>
<parameters>
<parameter name="guide">
-<parameter_description> a #GtkConstraintGuide
+<parameter_description> a `GtkConstraintGuide`
</parameter_description>
</parameter>
</parameters>
@@ -29864,9 +32612,9 @@ Retrieves the strength set using gtk_constraint_guide_set_strength().
<function name="gtk_constraint_guide_new">
<description>
-Creates a new #GtkConstraintGuide object.
+Creates a new `GtkConstraintGuide` object.
-Return: a new #GtkConstraintGuide object.
+Return: a new `GtkConstraintGuide` object.
</description>
<parameters>
@@ -29878,13 +32626,13 @@ Return: a new #GtkConstraintGuide object.
<description>
Sets the maximum size of @guide.
-If @guide is attached to a #GtkConstraintLayout,
+If @guide is attached to a `GtkConstraintLayout`,
the constraints will be updated to reflect the new size.
</description>
<parameters>
<parameter name="guide">
-<parameter_description> a #GtkConstraintGuide object
+<parameter_description> a `GtkConstraintGuide` object
</parameter_description>
</parameter>
<parameter name="width">
@@ -29903,13 +32651,13 @@ the constraints will be updated to reflect the new size.
<description>
Sets the minimum size of @guide.
-If @guide is attached to a #GtkConstraintLayout,
+If @guide is attached to a `GtkConstraintLayout`,
the constraints will be updated to reflect the new size.
</description>
<parameters>
<parameter name="guide">
-<parameter_description> a #GtkConstraintGuide object
+<parameter_description> a `GtkConstraintGuide` object
</parameter_description>
</parameter>
<parameter name="width">
@@ -29926,14 +32674,14 @@ the constraints will be updated to reflect the new size.
<function name="gtk_constraint_guide_set_name">
<description>
-Sets a name for the given #GtkConstraintGuide.
+Sets a name for the given `GtkConstraintGuide`.
The name is useful for debugging purposes.
</description>
<parameters>
<parameter name="guide">
-<parameter_description> a #GtkConstraintGuide
+<parameter_description> a `GtkConstraintGuide`
</parameter_description>
</parameter>
<parameter name="name">
@@ -29948,13 +32696,13 @@ The name is useful for debugging purposes.
<description>
Sets the natural size of @guide.
-If @guide is attached to a #GtkConstraintLayout,
+If @guide is attached to a `GtkConstraintLayout`,
the constraints will be updated to reflect the new size.
</description>
<parameters>
<parameter name="guide">
-<parameter_description> a #GtkConstraintGuide object
+<parameter_description> a `GtkConstraintGuide` object
</parameter_description>
</parameter>
<parameter name="width">
@@ -29972,12 +32720,12 @@ the constraints will be updated to reflect the new size.
<function name="gtk_constraint_guide_set_strength">
<description>
Sets the strength of the constraint on the natural size of the
-given #GtkConstraintGuide.
+given `GtkConstraintGuide`.
</description>
<parameters>
<parameter name="guide">
-<parameter_description> a #GtkConstraintGuide
+<parameter_description> a `GtkConstraintGuide`
</parameter_description>
</parameter>
<parameter name="strength">
@@ -29990,48 +32738,48 @@ given #GtkConstraintGuide.
<function name="gtk_constraint_is_attached">
<description>
-Checks whether the @constraint is attached to a #GtkConstraintLayout,
+Checks whether the constraint is attached to a [class@Gtk.ConstraintLayout],
and it is contributing to the layout.
</description>
<parameters>
<parameter name="constraint">
-<parameter_description> a #GtkConstraint
+<parameter_description> a `GtkConstraint`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the constraint is attached
+<return> `TRUE` if the constraint is attached
</return>
</function>
<function name="gtk_constraint_is_constant">
<description>
-Checks whether the @constraint describes a relation between an attribute
-on the #GtkConstraint:target and a constant value.
+Checks whether the constraint describes a relation between an attribute
+on the [property@Gtk.Constraint:target] and a constant value.
</description>
<parameters>
<parameter name="constraint">
-<parameter_description> a #GtkConstraint
+<parameter_description> a `GtkConstraint`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the constraint is a constant relation
+<return> `TRUE` if the constraint is a constant relation
</return>
</function>
<function name="gtk_constraint_is_required">
<description>
-Checks whether the @constraint is a required relation for solving the
+Checks whether the constraint is a required relation for solving the
constraint layout.
</description>
<parameters>
<parameter name="constraint">
-<parameter_description> a #GtkConstraint
+<parameter_description> a `GtkConstraint`
</parameter_description>
</parameter>
</parameters>
@@ -30041,16 +32789,16 @@ constraint layout.
<function name="gtk_constraint_layout_add_constraint">
<description>
-Adds a #GtkConstraint to the layout manager.
+Adds a constraint to the layout manager.
-The #GtkConstraint:source and #GtkConstraint:target
-properties of @constraint can be:
+The [property@Gtk.Constraint:source] and [property@Gtk.Constraint:target]
+properties of `constraint` can be:
-- set to %NULL to indicate that the constraint refers to the
-widget using @layout
-- set to the #GtkWidget using @layout
-- set to a child of the #GtkWidget using @layout
-- set to a guide that is part of @layout
+- set to `NULL` to indicate that the constraint refers to the
+widget using `layout`
+- set to the [class@Gtk.Widget] using `layout`
+- set to a child of the [class@Gtk.Widget] using `layout`
+- set to a [class@Gtk.ConstraintGuide] that is part of `layout`
The @layout acquires the ownership of @constraint after calling
this function.
@@ -30058,11 +32806,11 @@ this function.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GtkConstraintLayout
+<parameter_description> a `GtkConstraintLayout`
</parameter_description>
</parameter>
<parameter name="constraint">
-<parameter_description> a #GtkConstraint
+<parameter_description> a [class@Gtk.Constraint]
</parameter_description>
</parameter>
</parameters>
@@ -30071,18 +32819,17 @@ this function.
<function name="gtk_constraint_layout_add_constraints_from_description">
<description>
-Creates a list of constraints they formal description using a compact
-description syntax called VFL, or "Visual Format Language".
+Creates a list of constraints from a VFL description.
This function is a convenience wrapper around
-gtk_constraint_layout_add_constraints_from_descriptionv(), using
+[method@Gtk.ConstraintLayout.add_constraints_from_descriptionv], using
variadic arguments to populate the view/target map.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GtkConstraintLayout
+<parameter_description> a `GtkConstraintLayout`
</parameter_description>
</parameter>
<parameter name="lines">
@@ -30103,37 +32850,36 @@ defining a set of constraints
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter_description> return location for a `GError`
</parameter_description>
</parameter>
<parameter name="first_view">
<parameter_description> the name of a view in the VFL description, followed by the
-#GtkConstraintTarget to which it maps
+[iface@Gtk.ConstraintTarget] to which it maps
</parameter_description>
</parameter>
<parameter name="Varargs">
-<parameter_description> a %NULL-terminated list of view names and #GtkConstraintTargets
+<parameter_description> a `NULL`-terminated list of view names and [class@Gtk.ConstraintTarget]s
</parameter_description>
</parameter>
</parameters>
<return> the list of
-#GtkConstraints that were added to the layout
+[class@Gtk.Constraint]s that were added to the layout
</return>
</function>
<function name="gtk_constraint_layout_add_constraints_from_descriptionv">
<description>
-Creates a list of constraints from a formal description using a compact
-description syntax called VFL, or "Visual Format Language".
+Creates a list of constraints from a VFL description.
-The Visual Format Language is based on Apple's AutoLayout
[VFL](https://developer.apple.com/library/content/documentation/UserExperience/Conceptual/AutolayoutPG/VisualFormatLanguage.html).
+The Visual Format Language, VFL, is based on Apple's AutoLayout
[VFL](https://developer.apple.com/library/content/documentation/UserExperience/Conceptual/AutolayoutPG/VisualFormatLanguage.html).
-The @views dictionary is used to match #GtkConstraintTargets to the symbolic
-view name inside the VFL.
+The `views` dictionary is used to match [iface@Gtk.ConstraintTarget]
+instances to the symbolic view name inside the VFL.
The VFL grammar is:
-|[<!-- language="plain" -->
+```
<visualFormatString> = (<orientation>)?
(<superview><connection>)?
<view>(<connection><view>)*
@@ -30158,7 +32904,7 @@ The VFL grammar is:
'start' | 'end' | 'centerX' | 'centerY' | 'baseline'
<positiveNumber> // A positive real number parseable by g_ascii_strtod()
<number> // A real number parseable by g_ascii_strtod()
-]|
+```
**Note**: The VFL grammar used by GTK is slightly different than the one
defined by Apple, as it can use symbolic values for the constraint's
@@ -30167,7 +32913,7 @@ simple arithmetic operations inside predicates.
Examples of VFL descriptions are:
-|[<!-- language="plain" -->
+```
// Default spacing
[button]-[textField]
@@ -30200,13 +32946,13 @@ V:[topField]-10-[bottomField]
// Named attributes
[button1(==button2.height)]
-]|
+```
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GtkConstraintLayout
+<parameter_description> a `GtkConstraintLayout`
</parameter_description>
</parameter>
<parameter name="lines">
@@ -30227,38 +32973,40 @@ defining a set of constraints
</parameter_description>
</parameter>
<parameter name="views">
-<parameter_description> a dictionary of [ name, target ]
+<parameter_description> a dictionary of `[ name, target ]`
pairs; the `name` keys map to the view names in the VFL lines, while
-the `target` values map to children of the widget using a #GtkConstraintLayout, or guides
+the `target` values map to children of the widget using a `GtkConstraintLayout`,
+or guides
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter_description> return location for a `GError`
</parameter_description>
</parameter>
</parameters>
<return> the list of
-#GtkConstraints that were added to the layout
+[class@Gtk.Constraint] instances that were added to the layout
</return>
</function>
<function name="gtk_constraint_layout_add_guide">
<description>
-Adds a guide to @layout. A guide can be used as
-the source or target of constraints, like a widget,
-but it is not visible.
+Adds a guide to `layout`.
-The @layout acquires the ownership of @guide after calling
+A guide can be used as the source or target of constraints,
+like a widget, but it is not visible.
+
+The `layout` acquires the ownership of `guide` after calling
this function.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GtkConstraintLayout
+<parameter_description> a `GtkConstraintLayout`
</parameter_description>
</parameter>
<parameter name="guide">
-<parameter_description> a #GtkConstraintGuide object
+<parameter_description> a [class@Gtk.ConstraintGuide] object
</parameter_description>
</parameter>
</parameters>
@@ -30267,20 +33015,20 @@ this function.
<function name="gtk_constraint_layout_new">
<description>
-Creates a new #GtkConstraintLayout layout manager.
+Creates a new `GtkConstraintLayout` layout manager.
</description>
<parameters>
</parameters>
-<return> the newly created #GtkConstraintLayout
+<return> the newly created `GtkConstraintLayout`
</return>
</function>
<function name="gtk_constraint_layout_observe_constraints">
<description>
-Returns a #GListModel to track the constraints that are
-part of @layout.
+Returns a `GListModel` to track the constraints that are
+part of the layout.
Calling this function will enable extra internal bookkeeping
to track constraints and emit signals on the returned listmodel.
@@ -30293,19 +33041,19 @@ because of the slowdowns.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GtkConstraintLayout
+<parameter_description> a `GtkConstraintLayout`
</parameter_description>
</parameter>
</parameters>
<return> a
-#GListModel tracking @layout's constraints
+`GListModel` tracking the layout's constraints
</return>
</function>
<function name="gtk_constraint_layout_observe_guides">
<description>
-Returns a #GListModel to track the guides that are
-part of @layout.
+Returns a `GListModel` to track the guides that are
+part of the layout.
Calling this function will enable extra internal bookkeeping
to track guides and emit signals on the returned listmodel.
@@ -30318,12 +33066,12 @@ because of the slowdowns.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GtkConstraintLayout
+<parameter_description> a `GtkConstraintLayout`
</parameter_description>
</parameter>
</parameters>
<return> a
-#GListModel tracking @layout's guides
+`GListModel` tracking the layout's guides
</return>
</function>
@@ -30334,7 +33082,7 @@ Removes all constraints from the layout manager.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GtkConstraintLayout
+<parameter_description> a `GtkConstraintLayout`
</parameter_description>
</parameter>
</parameters>
@@ -30343,17 +33091,17 @@ Removes all constraints from the layout manager.
<function name="gtk_constraint_layout_remove_constraint">
<description>
-Removes @constraint from the layout manager,
+Removes `constraint` from the layout manager,
so that it no longer influences the layout.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GtkConstraintLayout
+<parameter_description> a `GtkConstraintLayout`
</parameter_description>
</parameter>
<parameter name="constraint">
-<parameter_description> a #GtkConstraint
+<parameter_description> a [class@Gtk.Constraint]
</parameter_description>
</parameter>
</parameters>
@@ -30362,17 +33110,17 @@ so that it no longer influences the layout.
<function name="gtk_constraint_layout_remove_guide">
<description>
-Removes @guide from the layout manager,
+Removes `guide` from the layout manager,
so that it no longer influences the layout.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #GtkConstraintLayout
+<parameter_description> a `GtkConstraintLayout`
</parameter_description>
</parameter>
<parameter name="guide">
-<parameter_description> a #GtkConstraintGuide object
+<parameter_description> a [class@Gtk.ConstraintGuide] object
</parameter_description>
</parameter>
</parameters>
@@ -30381,38 +33129,38 @@ so that it no longer influences the layout.
<function name="gtk_constraint_new">
<description>
-Creates a new #GtkConstraint representing a relation between a layout
+Creates a new constraint representing a relation between a layout
attribute on a source and a layout attribute on a target.
</description>
<parameters>
<parameter name="target">
-<parameter_description> a #GtkConstraintTarget
+<parameter_description> the target of the constraint
</parameter_description>
</parameter>
<parameter name="target_attribute">
-<parameter_description> the attribute of @target to be set
+<parameter_description> the attribute of `target` to be set
</parameter_description>
</parameter>
<parameter name="relation">
-<parameter_description> the relation equivalence between @target_attribute and @source_attribute
+<parameter_description> the relation equivalence between `target_attribute` and `source_attribute`
</parameter_description>
</parameter>
<parameter name="source">
-<parameter_description> a #GtkConstraintTarget
+<parameter_description> the source of the constraint
</parameter_description>
</parameter>
<parameter name="source_attribute">
-<parameter_description> the attribute of @source to be read
+<parameter_description> the attribute of `source` to be read
</parameter_description>
</parameter>
<parameter name="multiplier">
-<parameter_description> a multiplication factor to be applied to @source_attribute
+<parameter_description> a multiplication factor to be applied to `source_attribute`
</parameter_description>
</parameter>
<parameter name="constant">
-<parameter_description> a constant factor to be added to @source_attribute
+<parameter_description> a constant factor to be added to `source_attribute`
</parameter_description>
</parameter>
<parameter name="strength">
@@ -30420,32 +33168,32 @@ attribute on a source and a layout attribute on a target.
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GtkConstraint
+<return> the newly created constraint
</return>
</function>
<function name="gtk_constraint_new_constant">
<description>
-Creates a new #GtkConstraint representing a relation between a layout
+Creates a new constraint representing a relation between a layout
attribute on a target and a constant value.
</description>
<parameters>
<parameter name="target">
-<parameter_description> a #GtkConstraintTarget
+<parameter_description> a the target of the constraint
</parameter_description>
</parameter>
<parameter name="target_attribute">
-<parameter_description> the attribute of @target to be set
+<parameter_description> the attribute of `target` to be set
</parameter_description>
</parameter>
<parameter name="relation">
-<parameter_description> the relation equivalence between @target_attribute and @constant
+<parameter_description> the relation equivalence between `target_attribute` and `constant`
</parameter_description>
</parameter>
<parameter name="constant">
-<parameter_description> a constant factor to be set on @target_attribute
+<parameter_description> a constant factor to be set on `target_attribute`
</parameter_description>
</parameter>
<parameter name="strength">
@@ -30453,7 +33201,7 @@ attribute on a target and a constant value.
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GtkConstraint
+<return> the newly created constraint
</return>
</function>
@@ -30798,13 +33546,14 @@ do {
<function name="gtk_css_provider_load_from_data">
<description>
-Loads @data into @css_provider, and by doing so clears any previously loaded
-information.
+Loads @data into @css_provider.
+
+This clears any previously loaded information.
</description>
<parameters>
<parameter name="css_provider">
-<parameter_description> a #GtkCssProvider
+<parameter_description> a `GtkCssProvider`
</parameter_description>
</parameter>
<parameter name="data">
@@ -30823,17 +33572,18 @@ potentially do a copy.
<function name="gtk_css_provider_load_from_file">
<description>
-Loads the data contained in @file into @css_provider, making it
-clear any previously loaded information.
+Loads the data contained in @file into @css_provider.
+
+This clears any previously loaded information.
</description>
<parameters>
<parameter name="css_provider">
-<parameter_description> a #GtkCssProvider
+<parameter_description> a `GtkCssProvider`
</parameter_description>
</parameter>
<parameter name="file">
-<parameter_description> #GFile pointing to a file to load
+<parameter_description> `GFile` pointing to a file to load
</parameter_description>
</parameter>
</parameters>
@@ -30842,13 +33592,14 @@ clear any previously loaded information.
<function name="gtk_css_provider_load_from_path">
<description>
-Loads the data contained in @path into @css_provider, making it clear
-any previously loaded information.
+Loads the data contained in @path into @css_provider.
+
+This clears any previously loaded information.
</description>
<parameters>
<parameter name="css_provider">
-<parameter_description> a #GtkCssProvider
+<parameter_description> a `GtkCssProvider`
</parameter_description>
</parameter>
<parameter name="path">
@@ -30862,19 +33613,18 @@ any previously loaded information.
<function name="gtk_css_provider_load_from_resource">
<description>
Loads the data contained in the resource at @resource_path into
-the #GtkCssProvider, clearing any previously loaded information.
+the @css_provider.
-To track errors while loading CSS, connect to the
-#GtkCssProvider::parsing-error signal.
+This clears any previously loaded information.
</description>
<parameters>
<parameter name="css_provider">
-<parameter_description> a #GtkCssProvider
+<parameter_description> a `GtkCssProvider`
</parameter_description>
</parameter>
<parameter name="resource_path">
-<parameter_description> a #GResource resource path
+<parameter_description> a `GResource` resource path
</parameter_description>
</parameter>
</parameters>
@@ -30883,15 +33633,16 @@ To track errors while loading CSS, connect to the
<function name="gtk_css_provider_load_named">
<description>
-Loads a theme from the usual theme paths. The actual process of
-finding the theme might change between releases, but it is
-guaranteed that this function uses the same mechanism to load the
-theme that GTK uses for loading its own theme.
+Loads a theme from the usual theme paths.
+
+The actual process of finding the theme might change between
+releases, but it is guaranteed that this function uses the same
+mechanism to load the theme that GTK uses for loading its own theme.
</description>
<parameters>
<parameter name="provider">
-<parameter_description> a #GtkCssProvider
+<parameter_description> a `GtkCssProvider`
</parameter_description>
</parameter>
<parameter name="name">
@@ -30909,13 +33660,13 @@ theme that GTK uses for loading its own theme.
<function name="gtk_css_provider_new">
<description>
-Returns a newly created #GtkCssProvider.
+Returns a newly created `GtkCssProvider`.
</description>
<parameters>
</parameters>
-<return> A new #GtkCssProvider
+<return> A new `GtkCssProvider`
</return>
</function>
@@ -30924,10 +33675,10 @@ Returns a newly created #GtkCssProvider.
Converts the @provider into a string representation in CSS
format.
-Using gtk_css_provider_load_from_data() with the return value
-from this function on a new provider created with
-gtk_css_provider_new() will basically create a duplicate of
-this @provider.
+Using [method@Gtk.CssProvider.load_from_data] with the return
+value from this function on a new provider created with
+[ctor Gtk CssProvider new] will basically create a duplicate
+of this @provider.
</description>
@@ -30960,9 +33711,10 @@ this section
<function name="gtk_css_section_get_file">
<description>
-Gets the file that @section was parsed from. If no such file exists,
-for example because the CSS was loaded via
-@gtk_css_provider_load_from_data(), then %NULL is returned.
+Gets the file that @section was parsed from.
+
+If no such file exists, for example because the CSS was loaded via
+[method@Gtk.CssProvider.load_from_data], then `NULL` is returned.
</description>
@@ -30972,19 +33724,20 @@ for example because the CSS was loaded via
</parameter_description>
</parameter>
</parameters>
-<return> the #GFile that @section was parsed from
-or %NULL if @section was parsed from other data
+<return> the `GFile` from which the `section`
+was parsed
</return>
</function>
<function name="gtk_css_section_get_parent">
<description>
-Gets the parent section for the given @section. The parent section is
-the section that contains this @section. A special case are sections of
-type #GTK_CSS_SECTION_DOCUMENT. Their parent will either be %NULL
-if they are the original CSS document that was loaded by
-gtk_css_provider_load_from_file() or a section of type
-#GTK_CSS_SECTION_IMPORT if it was loaded with an import rule from
+Gets the parent section for the given `section`.
+
+The parent section is the section that contains this `section`. A special
+case are sections of type `GTK_CSS_SECTION_DOCUMEN`T. Their parent will
+either be `NULL` if they are the original CSS document that was loaded by
+[method@Gtk.CssProvider.load_from_file] or a section of type
+`GTK_CSS_SECTION_IMPORT` if it was loaded with an `@import` rule from
a different file.
@@ -30995,7 +33748,7 @@ a different file.
</parameter_description>
</parameter>
</parameters>
-<return> the parent section or %NULL if none
+<return> the parent section
</return>
</function>
@@ -31018,9 +33771,9 @@ this section
<function name="gtk_css_section_new">
<description>
-Creates a new #GtkCssSection referring to the section
-in the given @file from the @start location to the
-@end location.
+Creates a new `GtkCssSection` referring to the section
+in the given `file` from the `start` location to the
+`end` location.
</description>
@@ -31038,15 +33791,16 @@ in the given @file from the @start location to the
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkCssSection
+<return> a new `GtkCssSection`
</return>
</function>
<function name="gtk_css_section_print">
<description>
-Prints the @section into @string in a human-readable form. This
-is a form like `gtk.css:32:1-23` to denote line 32, characters
-1 to 23 in the file gtk.css.
+Prints the `section` into `string` in a human-readable form.
+
+This is a form like `gtk.css:32:1-23` to denote line 32, characters
+1 to 23 in the file `gtk.css`.
</description>
<parameters>
@@ -31064,24 +33818,24 @@ is a form like `gtk.css:32:1-23` to denote line 32, characters
<function name="gtk_css_section_ref">
<description>
-Increments the reference count on @section.
+Increments the reference count on `section`.
</description>
<parameters>
<parameter name="section">
-<parameter_description> a #GtkCssSection
+<parameter_description> a `GtkCssSection`
</parameter_description>
</parameter>
</parameters>
-<return> @section itself.
+<return> the CSS section itself.
</return>
</function>
<function name="gtk_css_section_to_string">
<description>
Prints the section into a human-readable text form using
-gtk_css_section_print().
+[method@Gtk.CssSection.print].
</description>
@@ -31097,13 +33851,13 @@ gtk_css_section_print().
<function name="gtk_css_section_unref">
<description>
-Decrements the reference count on @section, freeing the
+Decrements the reference count on `section`, freeing the
structure if the reference count reaches 0.
</description>
<parameters>
<parameter name="section">
-<parameter_description> a #GtkCssSection
+<parameter_description> a `GtkCssSection`
</parameter_description>
</parameter>
</parameters>
@@ -31201,13 +33955,13 @@ gtk_filter_changed() needs to be called.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkCustomFilter
+<return> a new `GtkCustomFilter`
</return>
</function>
<function name="gtk_custom_filter_set_filter_func">
<description>
-Sets (or unsets) the function used for filtering items.
+Sets the function used for filtering items.
If @match_func is %NULL, the filter matches all items.
@@ -31220,7 +33974,7 @@ called now.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCustomFilter
+<parameter_description> a `GtkCustomFilter`
</parameter_description>
</parameter>
<parameter name="match_func">
@@ -31243,7 +33997,7 @@ called now.
<description>
Creates a new legacy layout manager.
-Legacy layout managers map to the old #GtkWidget size negotiation
+Legacy layout managers map to the old `GtkWidget` size negotiation
virtual functions, and are meant to be used during the transition
from layout containers to layout manager delegates.
@@ -31252,7 +34006,7 @@ from layout containers to layout manager delegates.
<parameters>
<parameter name="request_mode">
<parameter_description> a function to retrieve
-the #GtkSizeRequestMode of the widget using the layout; the
+the `GtkSizeRequestMode` of the widget using the layout; the
default request mode is %GTK_SIZE_REQUEST_CONSTANT_SIZE
</parameter_description>
</parameter>
@@ -31266,7 +34020,7 @@ the layout manager
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GtkCustomLayout
+<return> the newly created `GtkCustomLayout`
</return>
</function>
@@ -31292,7 +34046,7 @@ Creates a new custom paper dialog.
<function name="gtk_custom_sorter_new">
<description>
-Creates a new #GtkSorter that works by calling
+Creates a new `GtkSorter` that works by calling
@sort_func to compare items.
If @sort_func is %NULL, all items are considered equal.
@@ -31301,7 +34055,7 @@ If @sort_func is %NULL, all items are considered equal.
</description>
<parameters>
<parameter name="sort_func">
-<parameter_description> the #GCompareDataFunc to use for sorting
+<parameter_description> the `GCompareDataFunc` to use for sorting
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -31313,7 +34067,7 @@ If @sort_func is %NULL, all items are considered equal.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkCustomSorter
+<return> a new `GtkCustomSorter`
</return>
</function>
@@ -31332,7 +34086,7 @@ called now.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkCustomSorter
+<parameter_description> a `GtkCustomSorter`
</parameter_description>
</parameter>
<parameter name="sort_func">
@@ -31353,17 +34107,20 @@ called now.
<function name="gtk_dialog_add_action_widget">
<description>
-Adds an activatable widget to the action area of a #GtkDialog,
-connecting a signal handler that will emit the #GtkDialog::response
-signal on the dialog when the widget is activated. The widget is
-appended to the end of the dialog’s action area. If you want to add a
-non-activatable widget, simply pack it into the @action_area field
-of the #GtkDialog struct.
+Adds an activatable widget to the action area of a `GtkDialog`.
+
+GTK connects a signal handler that will emit the
+[signal@Gtk.Dialog::response] signal on the dialog when the widget
+is activated. The widget is appended to the end of the dialog’s action
+area.
+
+If you want to add a non-activatable widget, simply pack it into
+the @action_area field of the `GtkDialog` struct.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter_description> a `GtkDialog`
</parameter_description>
</parameter>
<parameter name="child">
@@ -31380,17 +34137,18 @@ of the #GtkDialog struct.
<function name="gtk_dialog_add_button">
<description>
-Adds a button with the given text and sets things up so that
-clicking the button will emit the #GtkDialog::response signal with
-the given @response_id. The button is appended to the end of the
-dialog’s action area. The button widget is returned, but usually
-you don’t need it.
+Adds a button with the given text.
+
+GTK arranges things so that clicking the button will emit the
+[signal@Gtk.Dialog::response] signal with the given @response_id.
+The button is appended to the end of the dialog’s action area.
+The button widget is returned, but usually you don’t need it.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter_description> a `GtkDialog`
</parameter_description>
</parameter>
<parameter name="button_text">
@@ -31402,21 +34160,23 @@ you don’t need it.
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkButton widget that was added
+<return> the `GtkButton` widget that was added
</return>
</function>
<function name="gtk_dialog_add_buttons">
<description>
-Adds more buttons, same as calling gtk_dialog_add_button()
-repeatedly. The variable argument list should be %NULL-terminated
-as with gtk_dialog_new_with_buttons(). Each button must have both
+Adds multiple buttons.
+
+This is the same as calling [method@Gtk.Dialog.add_button]
+repeatedly. The variable argument list should be %NULL-terminated
+as with [new@Gtk.Dialog.new_with_buttons]. Each button must have both
text and response ID.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter_description> a `GtkDialog`
</parameter_description>
</parameter>
<parameter name="first_button_text">
@@ -31439,7 +34199,7 @@ Returns the content area of @dialog.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter_description> a `GtkDialog`
</parameter_description>
</parameter>
</parameters>
@@ -31449,15 +34209,16 @@ Returns the content area of @dialog.
<function name="gtk_dialog_get_header_bar">
<description>
-Returns the header bar of @dialog. Note that the
-headerbar is only used by the dialog if the
-#GtkDialog:use-header-bar property is %TRUE.
+Returns the header bar of @dialog.
+
+Note that the headerbar is only used by the dialog if the
+[property@Gtk.Dialog:use-header-bar] property is %TRUE.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter_description> a `GtkDialog`
</parameter_description>
</parameter>
</parameters>
@@ -31474,7 +34235,7 @@ of a dialog.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter_description> a `GtkDialog`
</parameter_description>
</parameter>
<parameter name="widget">
@@ -31496,7 +34257,7 @@ of a dialog.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter_description> a `GtkDialog`
</parameter_description>
</parameter>
<parameter name="response_id">
@@ -31513,39 +34274,41 @@ of a dialog.
<description>
Creates a new dialog box.
-Widgets should not be packed into this #GtkWindow
-directly, but into the @content_area and @action_area, as described above.
+Widgets should not be packed into the `GtkWindow`
+directly, but into the @content_area and @action_area,
+as described above.
</description>
<parameters>
</parameters>
-<return> the new dialog as a #GtkWidget
+<return> the new dialog as a `GtkWidget`
</return>
</function>
<function name="gtk_dialog_new_with_buttons">
<description>
-Creates a new #GtkDialog with title @title (or %NULL for the default
-title; see gtk_window_set_title()) and transient parent @parent (or
-%NULL for none; see gtk_window_set_transient_for()). The @flags
-argument can be used to make the dialog modal (#GTK_DIALOG_MODAL)
-and/or to have it destroyed along with its transient parent
-(#GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button
-text/response ID pairs should be listed, with a %NULL pointer ending
-the list. Button text can be arbitrary text. A response ID can be
-any positive number, or one of the values in the #GtkResponseType
-enumeration. If the user clicks one of these dialog buttons,
-#GtkDialog will emit the #GtkDialog::response signal with the corresponding
-response ID. If a #GtkDialog receives a delete event,
-it will emit ::response with a response ID of #GTK_RESPONSE_DELETE_EVENT.
+Creates a new `GtkDialog` with the given title and transient parent.
+
+The @flags argument can be used to make the dialog modal, have it
+destroyed along with its transient parent, or make it use a headerbar.
+
+Button text/response ID pairs should be listed in pairs, with a %NULL
+pointer ending the list. Button text can be arbitrary text. A response
+ID can be any positive number, or one of the values in the
+[enum@Gtk.ResponseType] enumeration. If the user clicks one of these
+buttons, `GtkDialog` will emit the [signal@Gtk.Dialog::response] signal
+with the corresponding response ID.
+
+If a `GtkDialog` receives a delete event, it will emit ::response with a
+response ID of %GTK_RESPONSE_DELETE_EVENT.
+
However, destroying a dialog does not emit the ::response signal;
so be careful relying on ::response when using the
-#GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right,
-so the first button in the list will be the leftmost button in the dialog.
+%GTK_DIALOG_DESTROY_WITH_PARENT flag.
Here’s a simple example:
-|[<!-- language="C" -->
+```c
GtkWindow *main_app_window; // Window the dialog should show up on
GtkWidget *dialog;
GtkDialogFlags flags = GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT;
@@ -31557,7 +34320,7 @@ GTK_RESPONSE_ACCEPT,
_("_Cancel"),
GTK_RESPONSE_REJECT,
NULL);
-]|
+```
</description>
@@ -31571,7 +34334,7 @@ NULL);
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> from #GtkDialogFlags
+<parameter_description> from `GtkDialogFlags`
</parameter_description>
</parameter>
<parameter name="first_button_text">
@@ -31583,20 +34346,20 @@ NULL);
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkDialog
+<return> a new `GtkDialog`
</return>
</function>
<function name="gtk_dialog_response">
<description>
-Emits the #GtkDialog::response signal with the given response ID.
+Emits the ::response signal with the given response ID.
Used to indicate that the user has responded to the dialog in some way.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter_description> a `GtkDialog`
</parameter_description>
</parameter>
<parameter name="response_id">
@@ -31609,14 +34372,14 @@ Used to indicate that the user has responded to the dialog in some way.
<function name="gtk_dialog_set_default_response">
<description>
-Sets the last widget in the dialog’s action area with the given @response_id
-as the default widget for the dialog. Pressing “Enter” normally activates
-the default widget.
+Sets the default widget for the dialog based on the response ID.
+
+Pressing “Enter” normally activates the default widget.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter_description> a `GtkDialog`
</parameter_description>
</parameter>
<parameter name="response_id">
@@ -31629,14 +34392,15 @@ the default widget.
<function name="gtk_dialog_set_response_sensitive">
<description>
+A convenient way to sensitize/desensitize dialog buttons.
+
Calls `gtk_widget_set_sensitive (widget, @setting)`
for each widget in the dialog’s action area with the given @response_id.
-A convenient way to sensitize/desensitize dialog buttons.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter_description> a `GtkDialog`
</parameter_description>
</parameter>
<parameter name="response_id">
@@ -31659,7 +34423,7 @@ Gets the attributes queried on the children.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDirectoryList
+<parameter_description> a `GtkDirectoryList`
</parameter_description>
</parameter>
</parameters>
@@ -31682,7 +34446,7 @@ successfully queried files will remain in the list.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDirectoryList
+<parameter_description> a `GtkDirectoryList`
</parameter_description>
</parameter>
</parameters>
@@ -31699,7 +34463,7 @@ Gets the file whose children are currently enumerated.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDirectoryList
+<parameter_description> a `GtkDirectoryList`
</parameter_description>
</parameter>
</parameters>
@@ -31715,7 +34479,7 @@ Gets the IO priority set via gtk_directory_list_set_io_priority().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDirectoryList
+<parameter_description> a `GtkDirectoryList`
</parameter_description>
</parameter>
</parameters>
@@ -31732,7 +34496,7 @@ the directory for changes.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDirectoryList
+<parameter_description> a `GtkDirectoryList`
</parameter_description>
</parameter>
</parameters>
@@ -31753,7 +34517,7 @@ in between runs.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDirectoryList
+<parameter_description> a `GtkDirectoryList`
</parameter_description>
</parameter>
</parameters>
@@ -31763,8 +34527,10 @@ in between runs.
<function name="gtk_directory_list_new">
<description>
-Creates a new #GtkDirectoryList querying the given @file with the given
-@attributes.
+Creates a new `GtkDirectoryList`.
+
+The `GtkDirectoryList` is querying the given @file
+with the given @attributes.
</description>
@@ -31778,7 +34544,7 @@ Creates a new #GtkDirectoryList querying the given @file with the given
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkDirectoryList
+<return> a new `GtkDirectoryList`
</return>
</function>
@@ -31787,12 +34553,12 @@ Creates a new #GtkDirectoryList querying the given @file with the given
Sets the @attributes to be enumerated and starts the enumeration.
If @attributes is %NULL, no attributes will be queried, but a list
-of #GFileInfos will still be created.
+of `GFileInfo`s will still be created.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDirectoryList
+<parameter_description> a `GtkDirectoryList`
</parameter_description>
</parameter>
<parameter name="attributes">
@@ -31812,7 +34578,7 @@ If @file is %NULL, the result will be an empty list.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDirectoryList
+<parameter_description> a `GtkDirectoryList`
</parameter_description>
</parameter>
<parameter name="file">
@@ -31838,7 +34604,7 @@ may increase responsiveness.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDirectoryList
+<parameter_description> a `GtkDirectoryList`
</parameter_description>
</parameter>
<parameter name="io_priority">
@@ -31852,9 +34618,8 @@ may increase responsiveness.
<function name="gtk_directory_list_set_monitored">
<description>
Sets whether the directory list will monitor the directory
-for changes. If monitoring is enabled, the
-#GListModel::items-changed signal will be emitted when the
-directory contents change.
+for changes. If monitoring is enabled, the ::items-changed
+signal will be emitted when the directory contents change.
When monitoring is turned on after the initial creation
of the directory list, the directory is reloaded to avoid
@@ -31864,7 +34629,7 @@ and when monitoring was turned on.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDirectoryList
+<parameter_description> a `GtkDirectoryList`
</parameter_description>
</parameter>
<parameter name="monitored">
@@ -31877,10 +34642,10 @@ and when monitoring was turned on.
<function name="gtk_disable_setlocale">
<description>
-Prevents gtk_init(), gtk_init_check() and
-gtk_parse_args() from automatically
-calling `setlocale (LC_ALL, "")`. You would
-want to use this function if you wanted to set the locale for
+Prevents [id@gtk_init] and [id@gtk_init_check] from automatically calling
+`setlocale (LC_ALL, "")`.
+
+You would want to use this function if you wanted to set the locale for
your program to something other than the user’s locale, or if
you wanted to set different values for different locale categories.
@@ -31898,7 +34663,7 @@ Distributes @extra_space to child @sizes by bringing smaller
children up to natural size first.
The remaining space will be added to the @minimum_size member of the
-GtkRequestedSize struct. If all sizes reach their natural size then
+`GtkRequestedSize` struct. If all sizes reach their natural size then
the remaining space is returned.
@@ -31926,9 +34691,7 @@ to @sizes.
<function name="gtk_drag_check_threshold">
<description>
-Checks to see if a mouse drag starting at (@start_x, @start_y) and ending
-at (@current_x, @current_y) has passed the GTK drag threshold, and thus
-should trigger the beginning of a drag-and-drop operation.
+Checks to see if a drag movement has passed the GTK drag threshold.
</description>
@@ -31963,23 +34726,23 @@ should trigger the beginning of a drag-and-drop operation.
Creates a widget that can be used as a drag icon for the given
@value.
-Supported types include strings, #GdkRGBA and #GtkTextBuffer.
+Supported types include strings, `GdkRGBA` and `GtkTextBuffer`.
If GTK does not know how to create a widget for a given value,
it will return %NULL.
This method is used to set the default drag icon on drag'n'drop
-operations started by #GtkDragSource, so you don't need to set
+operations started by `GtkDragSource`, so you don't need to set
a drag icon using this function there.
</description>
<parameters>
<parameter name="value">
-<parameter_description> a #GValue
+<parameter_description> a `GValue`
</parameter_description>
</parameter>
</parameters>
-<return> A new #GtkWidget
+<return> A new `GtkWidget`
for displaying @value as a drag icon.
</return>
</function>
@@ -31992,7 +34755,7 @@ Gets the widget currently used as drag icon.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDragIcon
+<parameter_description> a `GtkDragIcon`
</parameter_description>
</parameter>
</parameters>
@@ -32002,7 +34765,7 @@ Gets the widget currently used as drag icon.
<function name="gtk_drag_icon_get_for_drag">
<description>
-Gets the #GtkDragIcon in use with @drag.
+Gets the `GtkDragIcon` in use with @drag.
If no drag icon exists yet, a new one will be created
and shown.
@@ -32011,11 +34774,11 @@ and shown.
</description>
<parameters>
<parameter name="drag">
-<parameter_description> a #GdkDrag
+<parameter_description> a `GdkDrag`
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkDragIcon
+<return> the `GtkDragIcon`
</return>
</function>
@@ -32026,11 +34789,11 @@ Sets the widget to display as the drag icon.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDragIcon
+<parameter_description> a `GtkDragIcon`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> a #GtkWidget or %NULL
+<parameter_description> a `GtkWidget` or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -32039,18 +34802,20 @@ Sets the widget to display as the drag icon.
<function name="gtk_drag_icon_set_from_paintable">
<description>
-Creates a #GtkDragIcon that shows @paintable, and associates
-it with the drag operation. The hotspot position on the paintable
-is aligned with the hotspot of the cursor.
+Creates a `GtkDragIcon` that shows @paintable, and associates
+it with the drag operation.
+
+The hotspot position on the paintable is aligned with the
+hotspot of the cursor.
</description>
<parameters>
<parameter name="drag">
-<parameter_description> a #GdkDrag
+<parameter_description> a `GdkDrag`
</parameter_description>
</parameter>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable to display
+<parameter_description> a `GdkPaintable` to display
</parameter_description>
</parameter>
<parameter name="hot_x">
@@ -32072,7 +34837,7 @@ Cancels a currently ongoing drag operation.
</description>
<parameters>
<parameter name="source">
-<parameter_description> a #GtkDragSource
+<parameter_description> a `GtkDragSource`
</parameter_description>
</parameter>
</parameters>
@@ -32081,13 +34846,13 @@ Cancels a currently ongoing drag operation.
<function name="gtk_drag_source_get_actions">
<description>
-Gets the actions that are currently set on the #GtkDragSource.
+Gets the actions that are currently set on the `GtkDragSource`.
</description>
<parameters>
<parameter name="source">
-<parameter_description> a #GtkDragSource
+<parameter_description> a `GtkDragSource`
</parameter_description>
</parameter>
</parameters>
@@ -32097,65 +34862,65 @@ Gets the actions that are currently set on the #GtkDragSource.
<function name="gtk_drag_source_get_content">
<description>
-Gets the current content provider of a #GtkDragSource.
+Gets the current content provider of a `GtkDragSource`.
</description>
<parameters>
<parameter name="source">
-<parameter_description> a #GtkDragSource
+<parameter_description> a `GtkDragSource`
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkContentProvider of @source
+<return> the `GdkContentProvider` of @source
</return>
</function>
<function name="gtk_drag_source_get_drag">
<description>
-Returns the underlying #GdkDrag object for an ongoing drag.
+Returns the underlying `GdkDrag` object for an ongoing drag.
</description>
<parameters>
<parameter name="source">
-<parameter_description> a #GtkDragSource
+<parameter_description> a `GtkDragSource`
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkDrag of the current drag operation, or %NULL
+<return> the `GdkDrag` of the current
+drag operation, or %NULL
</return>
</function>
<function name="gtk_drag_source_new">
<description>
-Creates a new #GtkDragSource object.
+Creates a new `GtkDragSource` object.
</description>
<parameters>
</parameters>
-<return> the new #GtkDragSource
+<return> the new `GtkDragSource`
</return>
</function>
<function name="gtk_drag_source_set_actions">
<description>
-Sets the actions on the #GtkDragSource.
+Sets the actions on the `GtkDragSource`.
-During a DND operation, the actions are offered
-to potential drop targets. If @actions include
-%GDK_ACTION_MOVE, you need to listen to the
-#GtkDragSource::drag-end signal and handle
-@delete_data being %TRUE.
+During a DND operation, the actions are offered to potential
+drop targets. If @actions include %GDK_ACTION_MOVE, you need
+to listen to the [signal@Gtk.DragSource::drag-end] signal and
+handle @delete_data being %TRUE.
This function can be called before a drag is started,
-or in a handler for the #GtkDragSource::prepare signal.
+or in a handler for the [signal@Gtk.DragSource::prepare] signal.
</description>
<parameters>
<parameter name="source">
-<parameter_description> a #GtkDragSource
+<parameter_description> a `GtkDragSource`
</parameter_description>
</parameter>
<parameter name="actions">
@@ -32168,26 +34933,25 @@ or in a handler for the #GtkDragSource::prepare signal.
<function name="gtk_drag_source_set_content">
<description>
-Sets a content provider on a #GtkDragSource.
+Sets a content provider on a `GtkDragSource`.
-When the data is requested in the cause of a
-DND operation, it will be obtained from the
-content provider.
+When the data is requested in the cause of a DND operation,
+it will be obtained from the content provider.
This function can be called before a drag is started,
-or in a handler for the #GtkDragSource::prepare signal.
+or in a handler for the [signal@Gtk.DragSource::prepare] signal.
You may consider setting the content provider back to
-%NULL in a #GtkDragSource::drag-end signal handler.
+%NULL in a [signal@Gtk.DragSource::drag-end] signal handler.
</description>
<parameters>
<parameter name="source">
-<parameter_description> a #GtkDragSource
+<parameter_description> a `GtkDragSource`
</parameter_description>
</parameter>
<parameter name="content">
-<parameter_description> a #GdkContentProvider, or %NULL
+<parameter_description> a `GdkContentProvider`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -32204,12 +34968,13 @@ that gets aligned with the hotspot of the cursor.
If @paintable is %NULL, a default icon is used.
This function can be called before a drag is started, or in
-a #GtkDragSource::prepare or #GtkDragSource::drag-begin signal handler.
+a [signal@Gtk.DragSource::prepare] or
+[signal@Gtk.DragSource::drag-begin] signal handler.
</description>
<parameters>
<parameter name="source">
-<parameter_description> a #GtkDragSource
+<parameter_description> a `GtkDragSource`
</parameter_description>
</parameter>
<parameter name="paintable">
@@ -32230,13 +34995,13 @@ a #GtkDragSource::prepare or #GtkDragSource::drag-begin signal handler.
<function name="gtk_drawing_area_get_content_height">
<description>
-Retrieves the value previously set via gtk_drawing_area_set_content_height().
+Retrieves the content height of the `GtkDrawingArea`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDrawingArea
+<parameter_description> a `GtkDrawingArea`
</parameter_description>
</parameter>
</parameters>
@@ -32246,13 +35011,13 @@ Retrieves the value previously set via gtk_drawing_area_set_content_height().
<function name="gtk_drawing_area_get_content_width">
<description>
-Retrieves the value previously set via gtk_drawing_area_set_content_width().
+Retrieves the content width of the `GtkDrawingArea`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDrawingArea
+<parameter_description> a `GtkDrawingArea`
</parameter_description>
</parameter>
</parameters>
@@ -32268,24 +35033,25 @@ Creates a new drawing area.
</description>
<parameters>
</parameters>
-<return> a new #GtkDrawingArea
+<return> a new `GtkDrawingArea`
</return>
</function>
<function name="gtk_drawing_area_set_content_height">
<description>
-Sets the desired height of the contents of the drawing area. Note that
-because widgets may be allocated larger sizes than they requested, it is
-possible that the actual height passed to your draw function is larger
-than the height set here. You can use gtk_widget_set_valign() to avoid
-that.
+Sets the desired height of the contents of the drawing area.
+
+Note that because widgets may be allocated larger sizes than they
+requested, it is possible that the actual height passed to your draw
+function is larger than the height set here. You can use
+[method@Gtk.Widget.set_valign] to avoid that.
If the height is set to 0 (the default), the drawing area may disappear.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDrawingArea
+<parameter_description> a `GtkDrawingArea`
</parameter_description>
</parameter>
<parameter name="height">
@@ -32298,18 +35064,19 @@ If the height is set to 0 (the default), the drawing area may disappear.
<function name="gtk_drawing_area_set_content_width">
<description>
-Sets the desired width of the contents of the drawing area. Note that
-because widgets may be allocated larger sizes than they requested, it is
-possible that the actual width passed to your draw function is larger
-than the width set here. You can use gtk_widget_set_halign() to avoid
-that.
+Sets the desired width of the contents of the drawing area.
+
+Note that because widgets may be allocated larger sizes than they
+requested, it is possible that the actual width passed to your draw
+function is larger than the width set here. You can use
+[method@Gtk.Widget.set_halign] to avoid that.
If the width is set to 0 (the default), the drawing area may disappear.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDrawingArea
+<parameter_description> a `GtkDrawingArea`
</parameter_description>
</parameter>
<parameter name="width">
@@ -32322,23 +35089,25 @@ If the width is set to 0 (the default), the drawing area may disappear.
<function name="gtk_drawing_area_set_draw_func">
<description>
-Setting a draw function is the main thing you want to do when using a drawing
-area. It is called whenever GTK needs to draw the contents of the drawing area
-to the screen.
+Setting a draw function is the main thing you want to do when using
+a drawing area.
-The draw function will be called during the drawing stage of GTK. In the
-drawing stage it is not allowed to change properties of any GTK widgets or call
-any functions that would cause any properties to be changed.
-You should restrict yourself exclusively to drawing your contents in the draw
-function.
+The draw function is called whenever GTK needs to draw the contents
+of the drawing area to the screen.
+
+The draw function will be called during the drawing stage of GTK.
+In the drawing stage it is not allowed to change properties of any
+GTK widgets or call any functions that would cause any properties
+to be changed. You should restrict yourself exclusively to drawing
+your contents in the draw function.
-If what you are drawing does change, call gtk_widget_queue_draw() on the
-drawing area. This will cause a redraw and will call @draw_func again.
+If what you are drawing does change, call [method@Gtk.Widget.queue_draw]
+on the drawing area. This will cause a redraw and will call @draw_func again.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDrawingArea
+<parameter_description> a `GtkDrawingArea`
</parameter_description>
</parameter>
<parameter name="draw_func">
@@ -32360,13 +35129,14 @@ the drawing area's contents
<function name="gtk_drop_controller_motion_contains_pointer">
<description>
-Returns the value of the GtkDropControllerMotion:contains-pointer property.
+Returns if a Drag-and-Drop operation is within the widget
+@self or one of its children.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropControllerMotion
+<parameter_description> a `GtkDropControllerMotion`
</parameter_description>
</parameter>
</parameters>
@@ -32376,34 +35146,37 @@ Returns the value of the GtkDropControllerMotion:contains-pointer property.
<function name="gtk_drop_controller_motion_get_drop">
<description>
-Returns the value of the GtkDropControllerMotion:drop property.
+Returns the `GdkDrop` of a current Drag-and-Drop operation
+over the widget of @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropControllerMotion
+<parameter_description> a `GtkDropControllerMotion`
</parameter_description>
</parameter>
</parameters>
-<return> The #GdkDrop currently happening
-within @self or %NULL if none
+<return> The `GdkDrop` currently
+happening within @self or %NULL if none
</return>
</function>
<function name="gtk_drop_controller_motion_is_pointer">
<description>
-Returns the value of the GtkDropControllerMotion:is-pointer property.
+Returns if a Drag-and-Drop operation is within the widget
+@self, not one of its children.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkEventControllerKey
+<parameter_description> a `GtkDropControllerMotion`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a dragging pointer is within @self but not one of its children
+<return> %TRUE if a dragging pointer is within @self but
+not one of its children
</return>
</function>
@@ -32416,7 +35189,7 @@ events during drag and drop.
</description>
<parameters>
</parameters>
-<return> a new #GtkDropControllerMotion
+<return> a new `GtkDropControllerMotion`
</return>
</function>
@@ -32428,7 +35201,7 @@ Returns whether search is enabled.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropDown
+<parameter_description> a `GtkDropDown`
</parameter_description>
</parameter>
</parameters>
@@ -32438,17 +35211,19 @@ Returns whether search is enabled.
<function name="gtk_drop_down_get_expression">
<description>
-Gets the expression set with gtk_drop_down_set_expression().
+Gets the expression set that is used to obtain strings from items.
+
+See [method@Gtk.DropDown.set_expression].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropDown
+<parameter_description> a `GtkDropDown`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkExpression or %NULL
+<return> a `GtkExpression` or %NULL
</return>
</function>
@@ -32458,13 +35233,13 @@ Gets the factory that's currently used to populate list items.
The factory returned by this function is always used for the
item in the button. It is also used for items in the popup
-if #GtkDropDown:list-factory is not set.
+if [property@Gtk.DropDown:list-factory] is not set.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropDown
+<parameter_description> a `GtkDropDown`
</parameter_description>
</parameter>
</parameters>
@@ -32480,7 +35255,7 @@ Gets the factory that's currently used to populate list items in the popup.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropDown
+<parameter_description> a `GtkDropDown`
</parameter_description>
</parameter>
</parameters>
@@ -32496,7 +35271,7 @@ Gets the model that provides the displayed items.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropDown
+<parameter_description> a `GtkDropDown`
</parameter_description>
</parameter>
</parameters>
@@ -32512,11 +35287,11 @@ Gets the position of the selected item.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropDown
+<parameter_description> a `GtkDropDown`
</parameter_description>
</parameter>
</parameters>
-<return> the position of the selected item, or #GTK_INVALID_LIST_POSITION
+<return> the position of the selected item, or %GTK_INVALID_LIST_POSITION
if not item is selected
</return>
</function>
@@ -32529,7 +35304,7 @@ Gets the selected item. If no item is selected, %NULL is returned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropDown
+<parameter_description> a `GtkDropDown`
</parameter_description>
</parameter>
</parameters>
@@ -32539,9 +35314,9 @@ Gets the selected item. If no item is selected, %NULL is returned.
<function name="gtk_drop_down_new">
<description>
-Creates a new #GtkDropDown.
+Creates a new `GtkDropDown`.
-You may want to call gtk_drop_down_set_factory()
+You may want to call [method@Gtk.DropDown.set_factory]
to set up a way to map its items to widgets.
@@ -32556,14 +35331,14 @@ to set up a way to map its items to widgets.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkDropDown
+<return> a new `GtkDropDown`
</return>
</function>
<function name="gtk_drop_down_new_from_strings">
<description>
-Creates a new #GtkDropDown that is populated with
-the strings in @strings.
+Creates a new `GtkDropDown` that is populated with
+the strings.
</description>
@@ -32573,7 +35348,7 @@ the strings in @strings.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkDropDown
+<return> a new `GtkDropDown`
</return>
</function>
@@ -32582,12 +35357,13 @@ the strings in @strings.
Sets whether a search entry will be shown in the popup that
allows to search for items in the list.
-Note that #GtkDropDown:expression must be set for search to work.
+Note that [property@Gtk.DropDown:expression] must be set for
+search to work.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropDown
+<parameter_description> a `GtkDropDown`
</parameter_description>
</parameter>
<parameter name="enable_search">
@@ -32600,18 +35376,19 @@ Note that #GtkDropDown:expression must be set for search to work.
<function name="gtk_drop_down_set_expression">
<description>
-Sets the expression that gets evaluated to obtain strings from items
-when searching in the popup. The expression must have a value type of
-#G_TYPE_STRING.
+Sets the expression that gets evaluated to obtain strings from items.
+
+This is used for search in the popup. The expression must have
+a value type of %G_TYPE_STRING.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropDown
+<parameter_description> a `GtkDropDown`
</parameter_description>
</parameter>
<parameter name="expression">
-<parameter_description> a #GtkExpression, or %NULL
+<parameter_description> a `GtkExpression`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -32620,12 +35397,12 @@ when searching in the popup. The expression must have a value type of
<function name="gtk_drop_down_set_factory">
<description>
-Sets the #GtkListItemFactory to use for populating list items.
+Sets the `GtkListItemFactory` to use for populating list items.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropDown
+<parameter_description> a `GtkDropDown`
</parameter_description>
</parameter>
<parameter name="factory">
@@ -32638,12 +35415,12 @@ Sets the #GtkListItemFactory to use for populating list items.
<function name="gtk_drop_down_set_list_factory">
<description>
-Sets the #GtkListItemFactory to use for populating list items in the popup.
+Sets the `GtkListItemFactory` to use for populating list items in the popup.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropDown
+<parameter_description> a `GtkDropDown`
</parameter_description>
</parameter>
<parameter name="factory">
@@ -32656,12 +35433,12 @@ Sets the #GtkListItemFactory to use for populating list items in the popup.
<function name="gtk_drop_down_set_model">
<description>
-Sets the #GListModel to use.
+Sets the `GListModel` to use.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropDown
+<parameter_description> a `GtkDropDown`
</parameter_description>
</parameter>
<parameter name="model">
@@ -32679,11 +35456,11 @@ Selects the item at the given position.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropDown
+<parameter_description> a `GtkDropDown`
</parameter_description>
</parameter>
<parameter name="position">
-<parameter_description> the position of the item to select, or #GTK_INVALID_LIST_POSITION
+<parameter_description> the position of the item to select, or %GTK_INVALID_LIST_POSITION
</parameter_description>
</parameter>
</parameters>
@@ -32698,7 +35475,7 @@ Gets the actions that this drop target supports.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropTargetAsync
+<parameter_description> a `GtkDropTargetAsync`
</parameter_description>
</parameter>
</parameters>
@@ -32716,7 +35493,7 @@ If the result is %NULL, all formats are expected to be supported.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropTargetAsync
+<parameter_description> a `GtkDropTargetAsync`
</parameter_description>
</parameter>
</parameters>
@@ -32726,7 +35503,7 @@ If the result is %NULL, all formats are expected to be supported.
<function name="gtk_drop_target_async_new">
<description>
-Creates a new #GtkDropTargetAsync object.
+Creates a new `GtkDropTargetAsync` object.
</description>
@@ -32740,7 +35517,7 @@ Creates a new #GtkDropTargetAsync object.
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkDropTargetAsync
+<return> the new `GtkDropTargetAsync`
</return>
</function>
@@ -32755,7 +35532,7 @@ the data.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropTargetAsync
+<parameter_description> a `GtkDropTargetAsync`
</parameter_description>
</parameter>
<parameter name="drop">
@@ -32773,7 +35550,7 @@ Sets the actions that this drop target supports.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropTargetAsync
+<parameter_description> a `GtkDropTargetAsync`
</parameter_description>
</parameter>
<parameter name="actions">
@@ -32791,7 +35568,7 @@ Sets the data formats that this drop target will accept.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropTargetAsync
+<parameter_description> a `GtkDropTargetAsync`
</parameter_description>
</parameter>
<parameter name="formats">
@@ -32811,7 +35588,7 @@ Gets the actions that this drop target supports.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropTarget
+<parameter_description> a `GtkDropTarget`
</parameter_description>
</parameter>
</parameters>
@@ -32829,7 +35606,7 @@ If no drop operation is going on, %NULL is returned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropTarget
+<parameter_description> a `GtkDropTarget`
</parameter_description>
</parameter>
</parameters>
@@ -32847,7 +35624,7 @@ If the result is %NULL, all formats are expected to be supported.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropTarget
+<parameter_description> a `GtkDropTarget`
</parameter_description>
</parameter>
</parameters>
@@ -32857,14 +35634,15 @@ If the result is %NULL, all formats are expected to be supported.
<function name="gtk_drop_target_get_gtypes">
<description>
-Gets the list of supported #GTypes for @self. If no type have been set,
-%NULL will be returned.
+Gets the list of supported `GTypes` for @self.
+
+If no type have been set, %NULL will be returned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropTarget
+<parameter_description> a `GtkDropTarget`
</parameter_description>
</parameter>
<parameter name="n_types">
@@ -32874,20 +35652,20 @@ number of #GTypes contained in the return value
</parameter>
</parameters>
<return>
-%G_TYPE_INVALID-terminated array of types included in @formats or
-%NULL if none.
+%G_TYPE_INVALID-terminated array of types included in
+@formats or %NULL if none.
</return>
</function>
<function name="gtk_drop_target_get_preload">
<description>
-Gets the value of the GtkDropTarget:preload property.
+Gets whether data should be preloaded on hover.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropTarget
+<parameter_description> a `GtkDropTarget`
</parameter_description>
</parameter>
</parameters>
@@ -32897,13 +35675,13 @@ Gets the value of the GtkDropTarget:preload property.
<function name="gtk_drop_target_get_value">
<description>
-Gets the value of the GtkDropTarget:value property.
+Gets the current drop data, as a `GValue`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropTarget
+<parameter_description> a `GtkDropTarget`
</parameter_description>
</parameter>
</parameters>
@@ -32913,11 +35691,11 @@ Gets the value of the GtkDropTarget:value property.
<function name="gtk_drop_target_new">
<description>
-Creates a new #GtkDropTarget object.
+Creates a new `GtkDropTarget` object.
If the drop target should support more than 1 type, pass
%G_TYPE_INVALID for @type and then call
-gtk_drop_target_set_gtypes().
+[method@Gtk.DropTarget.set_gtypes].
</description>
@@ -32931,7 +35709,7 @@ gtk_drop_target_set_gtypes().
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkDropTarget
+<return> the new `GtkDropTarget`
</return>
</function>
@@ -32939,8 +35717,8 @@ gtk_drop_target_set_gtypes().
<description>
Rejects the ongoing drop operation.
-If no drop operation is ongoing - when GdkDropTarget:drop
-returns %NULL - this function does nothing.
+If no drop operation is ongoing, i.e when [property@Gtk.DropTarget:drop]
+is %NULL, this function does nothing.
This function should be used when delaying the decision
on whether to accept a drag or not until after reading
@@ -32949,7 +35727,7 @@ the data.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropTarget
+<parameter_description> a `GtkDropTarget`
</parameter_description>
</parameter>
</parameters>
@@ -32963,7 +35741,7 @@ Sets the actions that this drop target supports.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropTarget
+<parameter_description> a `GtkDropTarget`
</parameter_description>
</parameter>
<parameter name="actions">
@@ -32976,14 +35754,12 @@ Sets the actions that this drop target supports.
<function name="gtk_drop_target_set_gtypes">
<description>
-Sets the supported #GTypes for this drop target.
-
-The GtkDropTarget::drop signal will
+Sets the supported `GTypes` for this drop target.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropTarget
+<parameter_description> a `GtkDropTarget`
</parameter_description>
</parameter>
<parameter name="types">
@@ -33001,12 +35777,12 @@ all supported #GTypes that can be dropped
<function name="gtk_drop_target_set_preload">
<description>
-Sets the GtkDropTarget:preload property.
+Sets whether data should be preloaded on hover.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkDropTarget
+<parameter_description> a `GtkDropTarget`
</parameter_description>
</parameter>
<parameter name="preload">
@@ -33019,16 +35795,17 @@ Sets the GtkDropTarget:preload property.
<function name="gtk_editable_delegate_get_property">
<description>
-Gets a property of the #GtkEditable delegate for @object.
+Gets a property of the `GtkEditable` delegate for @object.
-This is helper function that should be called in get_property,
-before handling your own properties.
+This is helper function that should be called in the `get_property`
+function of your `GtkEditable` implementation, before handling your
+own properties.
</description>
<parameters>
<parameter name="object">
-<parameter_description> a #GObject
+<parameter_description> a `GObject`
</parameter_description>
</parameter>
<parameter name="prop_id">
@@ -33040,7 +35817,7 @@ before handling your own properties.
</parameter_description>
</parameter>
<parameter name="pspec">
-<parameter_description> the #GParamSpec for the property
+<parameter_description> the `GParamSpec` for the property
</parameter_description>
</parameter>
</parameters>
@@ -33050,16 +35827,17 @@ before handling your own properties.
<function name="gtk_editable_delegate_set_property">
<description>
-Sets a property on the #GtkEditable delegate for @object.
+Sets a property on the `GtkEditable` delegate for @object.
-This is a helper function that should be called in set_property,
-before handling your own properties.
+This is a helper function that should be called in the `set_property`
+function of your `GtkEditable` implementation, before handling your
+own properties.
</description>
<parameters>
<parameter name="object">
-<parameter_description> a #GObject
+<parameter_description> a `GObject`
</parameter_description>
</parameter>
<parameter name="prop_id">
@@ -33071,7 +35849,7 @@ before handling your own properties.
</parameter_description>
</parameter>
<parameter name="pspec">
-<parameter_description> the #GParamSpec for the property
+<parameter_description> the `GParamSpec` for the property
</parameter_description>
</parameter>
</parameters>
@@ -33082,12 +35860,13 @@ before handling your own properties.
<function name="gtk_editable_delete_selection">
<description>
Deletes the currently selected text of the editable.
+
This call doesn’t do anything if there is no selected text.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
</parameters>
@@ -33096,17 +35875,19 @@ This call doesn’t do anything if there is no selected text.
<function name="gtk_editable_delete_text">
<description>
-Deletes a sequence of characters. The characters that are deleted are
-those characters at positions from @start_pos up to, but not including
-@end_pos. If @end_pos is negative, then the characters deleted
-are those from @start_pos to the end of the text.
+Deletes a sequence of characters.
+
+The characters that are deleted are those characters at positions
+from @start_pos up to, but not including @end_pos. If @end_pos is
+negative, then the characters deleted are those from @start_pos to
+the end of the text.
Note that the positions are specified in characters, not bytes.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
<parameter name="start_pos">
@@ -33123,7 +35904,7 @@ Note that the positions are specified in characters, not bytes.
<function name="gtk_editable_finish_delegate">
<description>
-Undoes the setup done by gtk_editable_init_delegate().
+Undoes the setup done by [method@Gtk.Editable.init_delegate].
This is a helper function that should be called from dispose,
before removing the delegate object.
@@ -33131,7 +35912,7 @@ before removing the delegate object.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
</parameters>
@@ -33140,13 +35921,13 @@ before removing the delegate object.
<function name="gtk_editable_get_alignment">
<description>
-Gets the value set by gtk_editable_set_alignment().
+Gets the alignment of the editable.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
</parameters>
@@ -33156,10 +35937,12 @@ Gets the value set by gtk_editable_set_alignment().
<function name="gtk_editable_get_chars">
<description>
-Retrieves a sequence of characters. The characters that are retrieved
-are those characters at positions from @start_pos up to, but not
-including @end_pos. If @end_pos is negative, then the characters
-retrieved are those characters from @start_pos to the end of the text.
+Retrieves a sequence of characters.
+
+The characters that are retrieved are those characters at positions
+from @start_pos up to, but not including @end_pos. If @end_pos is negative,
+then the characters retrieved are those characters from @start_pos to
+the end of the text.
Note that positions are specified in characters, not bytes.
@@ -33167,7 +35950,7 @@ Note that positions are specified in characters, not bytes.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
<parameter name="start_pos">
@@ -33180,38 +35963,39 @@ Note that positions are specified in characters, not bytes.
</parameter>
</parameters>
<return> a pointer to the contents of the widget as a
-string. This string is allocated by the #GtkEditable
-implementation and should be freed by the caller.
+string. This string is allocated by the `GtkEditable` implementation
+and should be freed by the caller.
</return>
</function>
<function name="gtk_editable_get_delegate">
<description>
-Gets the #GtkEditable that @editable is delegating its
-implementation to. Typically, the delegate is a #GtkText widget.
+Gets the `GtkEditable` that @editable is delegating its
+implementation to.
+
+Typically, the delegate is a [class Gtk Text] widget.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
</parameters>
-<return> the delegate #GtkEditable
+<return> the delegate `GtkEditable`
</return>
</function>
<function name="gtk_editable_get_editable">
<description>
Retrieves whether @editable is editable.
-See gtk_editable_set_editable().
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
</parameters>
@@ -33227,7 +36011,7 @@ Gets if undo/redo actions are enabled for @editable
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
</parameters>
@@ -33238,13 +36022,12 @@ Gets if undo/redo actions are enabled for @editable
<function name="gtk_editable_get_max_width_chars">
<description>
Retrieves the desired maximum width of @editable, in characters.
-See gtk_editable_set_max_width_chars().
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
</parameters>
@@ -33254,8 +36037,8 @@ See gtk_editable_set_max_width_chars().
<function name="gtk_editable_get_position">
<description>
-Retrieves the current position of the cursor relative to the start
-of the content of the editable.
+Retrieves the current position of the cursor relative
+to the start of the content of the editable.
Note that this position is in characters, not in bytes.
@@ -33263,7 +36046,7 @@ Note that this position is in characters, not in bytes.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
</parameters>
@@ -33285,7 +36068,7 @@ Note that positions are specified in characters, not bytes.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
<parameter name="start_pos">
@@ -33303,30 +36086,32 @@ Note that positions are specified in characters, not bytes.
<function name="gtk_editable_get_text">
<description>
-Retrieves the contents of @editable. The returned string is
-owned by GTK and must not be modified or freed.
+Retrieves the contents of @editable.
+
+The returned string is owned by GTK and must not be modified or freed.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the contents of the editable.
+<return> a pointer to the contents of the editable
</return>
</function>
<function name="gtk_editable_get_width_chars">
<description>
-Gets the value set by gtk_editable_set_width_chars().
+Gets the number of characters of space reserved
+for the contents of the editable.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
</parameters>
@@ -33336,9 +36121,10 @@ Gets the value set by gtk_editable_set_width_chars().
<function name="gtk_editable_init_delegate">
<description>
-Sets up a delegate for #GtkEditable, assuming that the
-get_delegate vfunc in the #GtkEditable interface has been
-set up for the @editable's type.
+Sets up a delegate for `GtkEditable`.
+
+This is assuming that the get_delegate vfunc in the `GtkEditable`
+interface has been set up for the @editable's type.
This is a helper function that should be called in instance init,
after creating the delegate object.
@@ -33346,7 +36132,7 @@ after creating the delegate object.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
</parameters>
@@ -33358,13 +36144,14 @@ after creating the delegate object.
Inserts @length bytes of @text into the contents of the
widget, at position @position.
-Note that the position is in characters, not in bytes.
-The function updates @position to point after the newly inserted text.
+Note that the position is in characters, not in bytes.
+The function updates @position to point after the newly
+inserted text.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
<parameter name="text">
@@ -33385,23 +36172,23 @@ The function updates @position to point after the newly inserted text.
<function name="gtk_editable_install_properties">
<description>
-Installs the GtkEditable properties for @class.
+Installs the `GtkEditable` properties for @class.
This is a helper function that should be called in class_init,
after installing your own properties.
To handle the properties in your set_property and get_property
-functions, you can either use gtk_editable_delegate_set_property()
-and gtk_editable_delegate_get_property() (if you are using a delegate),
-or remember the @first_prop offset and add it to the values in the
-#GtkEditableProperties enumeration to get the property IDs for these
-properties.
+functions, you can either use [func@Gtk.Editable.delegate_set_property]
+and [func@Gtk.Editable.delegate_get_property] (if you are using
+a delegate), or remember the @first_prop offset and add it to the
+values in the [enum@Gtk.EditableProperties] enumeration to get the
+property IDs for these properties.
</description>
<parameters>
<parameter name="object_class">
-<parameter_description> a #GObjectClass
+<parameter_description> a `GObjectClass`
</parameter_description>
</parameter>
<parameter name="first_prop">
@@ -33421,7 +36208,7 @@ Returns whether the label is currently in “editing mode”.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkEditableLabel
+<parameter_description> a `GtkEditableLabel`
</parameter_description>
</parameter>
</parameters>
@@ -33431,7 +36218,7 @@ Returns whether the label is currently in “editing mode”.
<function name="gtk_editable_label_new">
<description>
-Creates a new #GtkEditableLabel widget.
+Creates a new `GtkEditableLabel` widget.
</description>
@@ -33441,7 +36228,7 @@ Creates a new #GtkEditableLabel widget.
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkEditableLabel
+<return> the new `GtkEditableLabel`
</return>
</function>
@@ -33452,7 +36239,7 @@ Switches the label into “editing mode”.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkEditableLabel
+<parameter_description> a `GtkEditableLabel`
</parameter_description>
</parameter>
</parameters>
@@ -33461,15 +36248,17 @@ Switches the label into “editing mode”.
<function name="gtk_editable_label_stop_editing">
<description>
-Switches the label out of “editing mode”. If @commit is %TRUE,
-the resulting text is kept as the #GtkEditable:text property
-value, otherwise the resulting text is discarded and the label
-will keep its previous #GtkEditable:text property value.
+Switches the label out of “editing mode”.
+
+If @commit is %TRUE, the resulting text is kept as the
+[property@Gtk.Editable:text] property value, otherwise the
+resulting text is discarded and the label will keep its
+previous [property@Gtk.Editable:text] property value.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkEditableLabel
+<parameter_description> a `GtkEditableLabel`
</parameter_description>
</parameter>
<parameter name="commit">
@@ -33494,7 +36283,7 @@ Note that positions are specified in characters, not bytes.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
<parameter name="start_pos">
@@ -33519,7 +36308,7 @@ the displayed text is shorter than the width of the editable.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
<parameter name="xalign">
@@ -33533,13 +36322,12 @@ Reversed for RTL layouts
<function name="gtk_editable_set_editable">
<description>
-Determines if the user can edit the text
-in the editable widget or not.
+Determines if the user can edit the text in the editable widget.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
<parameter name="is_editable">
@@ -33553,16 +36341,17 @@ in the widget
<function name="gtk_editable_set_enable_undo">
<description>
-If enabled, changes to @editable will be saved for undo/redo actions.
+If enabled, changes to @editable will be saved for undo/redo
+actions.
-This results in an additional copy of text changes and are not stored in
-secure memory. As such, undo is forcefully disabled when #GtkText:visibility
-is set to %FALSE.
+This results in an additional copy of text changes and are not
+stored in secure memory. As such, undo is forcefully disabled
+when [property Gtk Text:visibility] is set to %FALSE.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
<parameter name="enable_undo">
@@ -33580,7 +36369,7 @@ Sets the desired maximum width in characters of @editable.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
<parameter name="n_chars">
@@ -33595,20 +36384,20 @@ Sets the desired maximum width in characters of @editable.
<description>
Sets the cursor position in the editable to the given value.
-The cursor is displayed before the character with the given (base 0)
-index in the contents of the editable. The value must be less than or
-equal to the number of characters in the editable. A value of -1
-indicates that the position should be set after the last character
+The cursor is displayed before the character with the given (base 0)
+index in the contents of the editable. The value must be less than
+or equal to the number of characters in the editable. A value of -1
+indicates that the position should be set after the last character
of the editable. Note that @position is in characters, not in bytes.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
<parameter name="position">
-<parameter_description> the position of the cursor
+<parameter_description> the position of the cursor
</parameter_description>
</parameter>
</parameters>
@@ -33617,13 +36406,14 @@ of the editable. Note that @position is in characters, not in bytes.
<function name="gtk_editable_set_text">
<description>
-Sets the text in the editable to the given value,
-replacing the current contents.
+Sets the text in the editable to the given value.
+
+This is replacing the current contents.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
<parameter name="text">
@@ -33646,7 +36436,7 @@ If @n_chars is -1, the size reverts to the default size.
</description>
<parameters>
<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
<parameter name="n_chars">
@@ -33659,32 +36449,35 @@ If @n_chars is -1, the size reverts to the default size.
<function name="gtk_emoji_chooser_new">
<description>
-Creates a new #GtkEmojiChooser.
+Creates a new `GtkEmojiChooser`.
</description>
<parameters>
</parameters>
-<return> a new #GtkEmojiChooser
+<return> a new `GtkEmojiChooser`
</return>
</function>
<function name="gtk_entry_buffer_delete_text">
<description>
-Deletes a sequence of characters from the buffer. @n_chars characters are
-deleted starting at @position. If @n_chars is negative, then all characters
-until the end of the text are deleted.
+Deletes a sequence of characters from the buffer.
-If @position or @n_chars are out of bounds, then they are coerced to sane
-values.
+@n_chars characters are deleted starting at @position.
+If @n_chars is negative, then all characters until the
+end of the text are deleted.
-Note that the positions are specified in characters, not bytes.
+If @position or @n_chars are out of bounds, then they
+are coerced to sane values.
+
+Note that the positions are specified in characters,
+not bytes.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter_description> a `GtkEntryBuffer`
</parameter_description>
</parameter>
<parameter name="position">
@@ -33702,12 +36495,12 @@ Note that the positions are specified in characters, not bytes.
<function name="gtk_entry_buffer_emit_deleted_text">
<description>
-Used when subclassing #GtkEntryBuffer
+Used when subclassing `GtkEntryBuffer`.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter_description> a `GtkEntryBuffer`
</parameter_description>
</parameter>
<parameter name="position">
@@ -33724,12 +36517,12 @@ Used when subclassing #GtkEntryBuffer
<function name="gtk_entry_buffer_emit_inserted_text">
<description>
-Used when subclassing #GtkEntryBuffer
+Used when subclassing `GtkEntryBuffer`.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter_description> a `GtkEntryBuffer`
</parameter_description>
</parameter>
<parameter name="position">
@@ -33751,7 +36544,8 @@ Used when subclassing #GtkEntryBuffer
<function name="gtk_entry_buffer_get_bytes">
<description>
Retrieves the length in bytes of the buffer.
-See gtk_entry_buffer_get_length().
+
+See [method@Gtk.EntryBuffer.get_length].
</description>
@@ -33773,7 +36567,7 @@ Retrieves the length in characters of the buffer.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter_description> a `GtkEntryBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -33783,14 +36577,13 @@ Retrieves the length in characters of the buffer.
<function name="gtk_entry_buffer_get_max_length">
<description>
-Retrieves the maximum allowed length of the text in
-@buffer. See gtk_entry_buffer_set_max_length().
+Retrieves the maximum allowed length of the text in @buffer.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter_description> a `GtkEntryBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -33810,14 +36603,13 @@ unless this object emits a signal, or is finalized.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter_description> a `GtkEntryBuffer`
</parameter_description>
</parameter>
</parameters>
<return> a pointer to the contents of the widget as a
-string. This string points to internally allocated
-storage in the buffer and must not be freed, modified or
-stored.
+string. This string points to internally allocated storage
+in the buffer and must not be freed, modified or stored.
</return>
</function>
@@ -33837,7 +36629,7 @@ Note that the position and length are in characters, not in bytes.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter_description> a `GtkEntryBuffer`
</parameter_description>
</parameter>
<parameter name="position">
@@ -33859,7 +36651,7 @@ Note that the position and length are in characters, not in bytes.
<function name="gtk_entry_buffer_new">
<description>
-Create a new GtkEntryBuffer object.
+Create a new `GtkEntryBuffer` object.
Optionally, specify initial text to set in the buffer.
@@ -33875,20 +36667,21 @@ Optionally, specify initial text to set in the buffer.
</parameter_description>
</parameter>
</parameters>
-<return> A new GtkEntryBuffer object.
+<return> A new `GtkEntryBuffer` object.
</return>
</function>
<function name="gtk_entry_buffer_set_max_length">
<description>
-Sets the maximum allowed length of the contents of the buffer. If
-the current contents are longer than the given length, then they
-will be truncated to fit.
+Sets the maximum allowed length of the contents of the buffer.
+
+If the current contents are longer than the given length, then
+they will be truncated to fit.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter_description> a `GtkEntryBuffer`
</parameter_description>
</parameter>
<parameter name="max_length">
@@ -33905,15 +36698,16 @@ be clamped to the range 0-65536.
<description>
Sets the text in the buffer.
-This is roughly equivalent to calling gtk_entry_buffer_delete_text()
-and gtk_entry_buffer_insert_text().
+This is roughly equivalent to calling
+[method@Gtk.EntryBuffer.delete_text] and
+[method@Gtk.EntryBuffer.insert_text].
Note that @n_chars is in characters, not in bytes.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter_description> a `GtkEntryBuffer`
</parameter_description>
</parameter>
<parameter name="chars">
@@ -33931,13 +36725,14 @@ Note that @n_chars is in characters, not in bytes.
<function name="gtk_entry_completion_complete">
<description>
Requests a completion operation, or in other words a refiltering of the
-current list with completions, using the current key. The completion list
-view will be updated accordingly.
+current list with completions, using the current key.
+
+The completion list view will be updated accordingly.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
</parameters>
@@ -33947,9 +36742,11 @@ view will be updated accordingly.
<function name="gtk_entry_completion_compute_prefix">
<description>
Computes the common prefix that is shared by all rows in @completion
-that start with @key. If no row matches @key, %NULL will be returned.
+that start with @key.
+
+If no row matches @key, %NULL will be returned.
Note that a text column must have been set for this function to work,
-see gtk_entry_completion_set_text_column() for details.
+see [method@Gtk.EntryCompletion.set_text_column] for details.
</description>
@@ -33963,8 +36760,8 @@ see gtk_entry_completion_set_text_column() for details.
</parameter_description>
</parameter>
</parameters>
-<return> The common prefix all rows starting with
-@key or %NULL if no row matches @key.
+<return> The common prefix all rows
+starting with @key or %NULL if no row matches @key.
</return>
</function>
@@ -33977,7 +36774,7 @@ the completion or %NULL if there’s no completion ongoing.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
</parameters>
@@ -33993,7 +36790,7 @@ Gets the entry @completion has been attached to.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
</parameters>
@@ -34010,7 +36807,7 @@ be automatically inserted in the entry.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
</parameters>
@@ -34026,7 +36823,7 @@ Returns %TRUE if inline-selection mode is turned on.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
</parameters>
@@ -34042,7 +36839,7 @@ Returns the minimum key length as set for @completion.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
</parameters>
@@ -34052,14 +36849,13 @@ Returns the minimum key length as set for @completion.
<function name="gtk_entry_completion_get_model">
<description>
-Returns the model the #GtkEntryCompletion is using as data source.
-Returns %NULL if the model is unset.
+Returns the model the `GtkEntryCompletion` is using as data source.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
</parameters>
@@ -34076,7 +36872,7 @@ Returns whether the completions should be presented in a popup window.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
</parameters>
@@ -34086,14 +36882,14 @@ Returns whether the completions should be presented in a popup window.
<function name="gtk_entry_completion_get_popup_set_width">
<description>
-Returns whether the completion popup window will be resized to the
+Returns whether the completion popup window will be resized to the
width of the entry.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
</parameters>
@@ -34111,7 +36907,7 @@ only a single match.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
</parameters>
@@ -34128,7 +36924,7 @@ Returns the column in the model of @completion to get strings from.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
</parameters>
@@ -34143,7 +36939,7 @@ Requests a prefix insertion.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
</parameters>
@@ -34152,21 +36948,23 @@ Requests a prefix insertion.
<function name="gtk_entry_completion_new">
<description>
-Creates a new #GtkEntryCompletion object.
+Creates a new `GtkEntryCompletion` object.
</description>
<parameters>
</parameters>
-<return> A newly created #GtkEntryCompletion object
+<return> A newly created `GtkEntryCompletion` object
</return>
</function>
<function name="gtk_entry_completion_new_with_area">
<description>
-Creates a new #GtkEntryCompletion object using the
-specified @area to layout cells in the underlying
-#GtkTreeViewColumn for the drop-down menu.
+Creates a new `GtkEntryCompletion` object using the
+specified @area.
+
+The `GtkCellArea` is used to layout cells in the underlying
+`GtkTreeViewColumn` for the drop-down menu.
</description>
@@ -34176,7 +36974,7 @@ specified @area to layout cells in the underlying
</parameter_description>
</parameter>
</parameters>
-<return> A newly created #GtkEntryCompletion object
+<return> A newly created `GtkEntryCompletion` object
</return>
</function>
@@ -34188,7 +36986,7 @@ be automatically inserted in the entry.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
<parameter name="inline_completion">
@@ -34207,7 +37005,7 @@ inside the entry.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
<parameter name="inline_selection">
@@ -34220,18 +37018,19 @@ inside the entry.
<function name="gtk_entry_completion_set_match_func">
<description>
-Sets the match function for @completion to be @func. The match function
-is used to determine if a row should or should not be in the completion
-list.
+Sets the match function for @completion to be @func.
+
+The match function is used to determine if a row should or
+should not be in the completion list.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
<parameter name="func">
-<parameter_description> the #GtkEntryCompletionMatchFunc to use
+<parameter_description> the `GtkEntryCompletion`MatchFunc to use
</parameter_description>
</parameter>
<parameter name="func_data">
@@ -34249,14 +37048,16 @@ list.
<function name="gtk_entry_completion_set_minimum_key_length">
<description>
Requires the length of the search key for @completion to be at least
-@length. This is useful for long lists, where completing using a small
+@length.
+
+This is useful for long lists, where completing using a small
key takes a lot of time and will come up with meaningless results anyway
(ie, a too large dataset).
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
<parameter name="length">
@@ -34269,18 +37070,20 @@ key takes a lot of time and will come up with meaningless results anyway
<function name="gtk_entry_completion_set_model">
<description>
-Sets the model for a #GtkEntryCompletion. If @completion already has
-a model set, it will remove it before setting the new model.
-If model is %NULL, then it will unset the model.
+Sets the model for a `GtkEntryCompletion`.
+
+If @completion already has a model set, it will remove it
+before setting the new model. If model is %NULL, then it
+will unset the model.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
<parameter name="model">
-<parameter_description> the #GtkTreeModel
+<parameter_description> the `GtkTreeModel`
</parameter_description>
</parameter>
</parameters>
@@ -34294,7 +37097,7 @@ Sets whether the completions should be presented in a popup window.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
<parameter name="popup_completion">
@@ -34313,7 +37116,7 @@ width as the entry.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
<parameter name="popup_set_width">
@@ -34327,13 +37130,15 @@ width as the entry.
<function name="gtk_entry_completion_set_popup_single_match">
<description>
Sets whether the completion popup window will appear even if there is
-only a single match. You may want to set this to %FALSE if you
-are using [inline completion][GtkEntryCompletion--inline-completion].
+only a single match.
+
+You may want to set this to %FALSE if you
+are using [property@Gtk.EntryCompletion:inline-completion].
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
<parameter name="popup_single_match">
@@ -34348,19 +37153,21 @@ match
<function name="gtk_entry_completion_set_text_column">
<description>
Convenience function for setting up the most used case of this code: a
-completion list with just strings. This function will set up @completion
+completion list with just strings.
+
+This function will set up @completion
to have a list displaying all (and just) strings in the completion list,
and to get those strings from @column in the model of @completion.
-This functions creates and adds a #GtkCellRendererText for the selected
+This functions creates and adds a `GtkCellRendererText` for the selected
column. If you need to set the text column, but don't want the cell
-renderer, use g_object_set() to set the #GtkEntryCompletion:text-column
-property directly.
+renderer, use g_object_set() to set the
+[property@Gtk.EntryCompletion:text-column] property directly.
</description>
<parameters>
<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter_description> a `GtkEntryCompletion`
</parameter_description>
</parameter>
<parameter name="column">
@@ -34379,7 +37186,7 @@ Retrieves the value set by gtk_entry_set_activates_default().
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
@@ -34391,11 +37198,13 @@ Retrieves the value set by gtk_entry_set_activates_default().
<description>
Gets the value set by gtk_entry_set_alignment().
+See also: [property@Gtk.Editable:xalign]
+
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
@@ -34405,71 +37214,73 @@ Gets the value set by gtk_entry_set_alignment().
<function name="gtk_entry_get_attributes">
<description>
-Gets the attribute list that was set on the entry using
-gtk_entry_set_attributes(), if any.
+Gets the attribute list of the `GtkEntry`.
+
+See [method@Gtk.Entry.set_attributes].
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
-<return> the attribute list, or %NULL
-if none was set.
+<return> the attribute list,
+or %NULL if none was set.
</return>
</function>
<function name="gtk_entry_get_buffer">
<description>
-Get the #GtkEntryBuffer object which holds the text for
+Get the `GtkEntryBuffer` object which holds the text for
this widget.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkEntryBuffer object.
+<return> A `GtkEntryBuffer` object.
</return>
</function>
<function name="gtk_entry_get_completion">
<description>
-Returns the auxiliary completion object currently in use by @entry.
+Returns the auxiliary completion object currently
+in use by @entry.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> A #GtkEntry
+<parameter_description> A `GtkEntry`
</parameter_description>
</parameter>
</parameters>
-<return> The auxiliary completion object currently
-in use by @entry.
+<return> The auxiliary
+completion object currently in use by @entry
</return>
</function>
<function name="gtk_entry_get_current_icon_drag_source">
<description>
-Returns the index of the icon which is the source of the current
-DND operation, or -1.
+Returns the index of the icon which is the source of the
+current DND operation, or -1.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
-<return> index of the icon which is the source of the current
-DND operation, or -1.
+<return> index of the icon which is the source of the
+current DND operation, or -1.
</return>
</function>
@@ -34481,7 +37292,7 @@ Gets the menu model set with gtk_entry_set_extra_menu().
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
@@ -34497,7 +37308,7 @@ Gets the value set by gtk_entry_set_has_frame().
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
@@ -34513,7 +37324,7 @@ Returns whether the icon is activatable.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -34528,17 +37339,19 @@ Returns whether the icon is activatable.
<function name="gtk_entry_get_icon_area">
<description>
Gets the area where entry’s icon at @icon_pos is drawn.
+
This function is useful when drawing something to the
entry in a draw callback.
-If the entry is not realized or has no icon at the given position,
-@icon_area is filled with zeros. Otherwise, @icon_area will be filled
-with the icon's allocation, relative to @entry's allocation.
+If the entry is not realized or has no icon at the given
+position, @icon_area is filled with zeros. Otherwise,
+@icon_area will be filled with the icon's allocation,
+relative to @entry's allocation.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> A #GtkEntry
+<parameter_description> A `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -34555,17 +37368,18 @@ with the icon's allocation, relative to @entry's allocation.
<function name="gtk_entry_get_icon_at_pos">
<description>
-Finds the icon at the given position and return its index. The
-position’s coordinates are relative to the @entry’s top left corner.
-If @x, @y doesn’t lie inside an icon, -1 is returned.
-This function is intended for use in a #GtkWidget::query-tooltip
-signal handler.
+Finds the icon at the given position and return its index.
+
+The position’s coordinates are relative to the @entry’s
+top left corner. If @x, @y doesn’t lie inside an icon,
+-1 is returned. This function is intended for use in a
+[signal@Gtk.Widget::query-tooltip] signal handler.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="x">
@@ -34583,15 +37397,16 @@ signal handler.
<function name="gtk_entry_get_icon_gicon">
<description>
-Retrieves the #GIcon used for the icon, or %NULL if there is
-no icon or if the icon was set by some other method (e.g., by
-paintable or icon name).
+Retrieves the `GIcon` used for the icon.
+
+%NULL will be returned if there is no icon or if the icon was
+set by some other method (e.g., by `GdkPaintable` or icon name).
</description>
<parameters>
<parameter name="entry">
-<parameter_description> A #GtkEntry
+<parameter_description> A `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -34599,22 +37414,23 @@ paintable or icon name).
</parameter_description>
</parameter>
</parameters>
-<return> A #GIcon, or %NULL if no icon is set
-or if the icon is not a #GIcon
+<return> A `GIcon`, or %NULL if no
+icon is set or if the icon is not a `GIcon`
</return>
</function>
<function name="gtk_entry_get_icon_name">
<description>
-Retrieves the icon name used for the icon, or %NULL if there is
-no icon or if the icon was set by some other method (e.g., by
-paintable or gicon).
+Retrieves the icon name used for the icon.
+
+%NULL is returned if there is no icon or if the icon was set
+by some other method (e.g., by `GdkPaintable` or gicon).
</description>
<parameters>
<parameter name="entry">
-<parameter_description> A #GtkEntry
+<parameter_description> A `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -34622,22 +37438,22 @@ paintable or gicon).
</parameter_description>
</parameter>
</parameters>
-<return> An icon name, or %NULL if no icon is set or if the icon
-wasn’t set from an icon name
+<return> An icon name, or %NULL if no icon is set
+or if the icon wasn’t set from an icon name
</return>
</function>
<function name="gtk_entry_get_icon_paintable">
<description>
-Retrieves the #GdkPaintable used for the icon.
+Retrieves the `GdkPaintable` used for the icon.
-If no #GdkPaintable was used for the icon, %NULL is returned.
+If no `GdkPaintable` was used for the icon, %NULL is returned.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> A #GtkEntry
+<parameter_description> A `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -34645,8 +37461,9 @@ If no #GdkPaintable was used for the icon, %NULL is returned.
</parameter_description>
</parameter>
</parameters>
-<return> A #GdkPaintable, or %NULL if no icon is
-set for this position or the icon set is not a #GdkPaintable.
+<return> A `GdkPaintable`, or %NULL
+if no icon is set for this position or the icon set is not
+a `GdkPaintable`.
</return>
</function>
@@ -34658,7 +37475,7 @@ Returns whether the icon appears sensitive or insensitive.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -34673,14 +37490,16 @@ Returns whether the icon appears sensitive or insensitive.
<function name="gtk_entry_get_icon_storage_type">
<description>
Gets the type of representation being used by the icon
-to store image data. If the icon has no image data,
-the return value will be %GTK_IMAGE_EMPTY.
+to store image data.
+
+If the icon has no image data, the return value will
+be %GTK_IMAGE_EMPTY.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -34694,14 +37513,14 @@ the return value will be %GTK_IMAGE_EMPTY.
<function name="gtk_entry_get_icon_tooltip_markup">
<description>
-Gets the contents of the tooltip on the icon at the specified
+Gets the contents of the tooltip on the icon at the specified
position in @entry.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -34709,21 +37528,21 @@ position in @entry.
</parameter_description>
</parameter>
</parameters>
-<return> the tooltip text, or %NULL. Free the returned
-string with g_free() when done.
+<return> the tooltip text, or %NULL. Free the
+returned string with g_free() when done.
</return>
</function>
<function name="gtk_entry_get_icon_tooltip_text">
<description>
-Gets the contents of the tooltip on the icon at the specified
+Gets the contents of the tooltip on the icon at the specified
position in @entry.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -34738,80 +37557,82 @@ string with g_free() when done.
<function name="gtk_entry_get_input_hints">
<description>
-Gets the value of the #GtkEntry:input-hints property.
+Gets the input hints of this `GtkEntry`.
+
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the input hints
+</return>
</function>
<function name="gtk_entry_get_input_purpose">
<description>
-Gets the value of the #GtkEntry:input-purpose property.
+Gets the input purpose of the `GtkEntry`.
+
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the input purpose
+</return>
</function>
<function name="gtk_entry_get_invisible_char">
<description>
-Retrieves the character displayed in place of the real characters
-for entries with visibility set to false. See gtk_entry_set_invisible_char().
+Retrieves the character displayed in place of the actual text
+in “password mode”.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
<return> the current invisible char, or 0, if the entry does not
-show invisible text at all.
+show invisible text at all.
</return>
</function>
<function name="gtk_entry_get_max_length">
<description>
-Retrieves the maximum allowed length of the text in
-@entry. See gtk_entry_set_max_length().
+Retrieves the maximum allowed length of the text in @entry.
-This is equivalent to getting @entry's #GtkEntryBuffer and
-calling gtk_entry_buffer_get_max_length() on it.
+See [method@Gtk.Entry.set_max_length].
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
<return> the maximum allowed number of characters
-in #GtkEntry, or 0 if there is no maximum.
+in `GtkEntry`, or 0 if there is no maximum.
</return>
</function>
<function name="gtk_entry_get_overwrite_mode">
<description>
-Gets the value set by gtk_entry_set_overwrite_mode().
+Gets whether the `GtkEntry` is in overwrite mode.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
@@ -34821,33 +37642,36 @@ Gets the value set by gtk_entry_set_overwrite_mode().
<function name="gtk_entry_get_placeholder_text">
<description>
-Retrieves the text that will be displayed when @entry is empty and unfocused
+Retrieves the text that will be displayed when @entry
+is empty and unfocused
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
-<return>a pointer to the placeholder text as a string.
-This string points to internally allocated storage in the widget and must
-not be freed, modified or stored. If no placeholder text has been set,
-%NULL will be returned.
+<return>a pointer to the
+placeholder text as a string. This string points to
+internally allocated storage in the widget and must
+not be freed, modified or stored. If no placeholder
+text has been set, %NULL will be returned.
</return>
</function>
<function name="gtk_entry_get_progress_fraction">
<description>
Returns the current fraction of the task that’s been completed.
-See gtk_entry_set_progress_fraction().
+
+See [method@Gtk.Entry.set_progress_fraction].
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
@@ -34857,13 +37681,14 @@ See gtk_entry_set_progress_fraction().
<function name="gtk_entry_get_progress_pulse_step">
<description>
-Retrieves the pulse step set with gtk_entry_set_progress_pulse_step().
+Retrieves the pulse step set with
+gtk_entry_set_progress_pulse_step().
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
@@ -34873,53 +37698,54 @@ Retrieves the pulse step set with gtk_entry_set_progress_pulse_step().
<function name="gtk_entry_get_tabs">
<description>
-Gets the tabstops that were set on the entry using gtk_entry_set_tabs(), if
-any.
+Gets the tabstops of the `GtkEntry.
+
+See [method@Gtk.Entry.set_tabs].
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
-<return> the tabstops, or %NULL if none was set.
+<return> the tabstops,
+or %NULL if none was set.
</return>
</function>
<function name="gtk_entry_get_text_length">
<description>
-Retrieves the current length of the text in
-@entry.
-
-This is equivalent to getting @entry's #GtkEntryBuffer and
-calling gtk_entry_buffer_get_length() on it.
+Retrieves the current length of the text in @entry.
+This is equivalent to getting @entry's `GtkEntryBuffer`
+and calling [method@Gtk.EntryBuffer.get_length] on it.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
<return> the current number of characters
-in #GtkEntry, or 0 if there are none.
+in `GtkEntry`, or 0 if there are none.
</return>
</function>
<function name="gtk_entry_get_visibility">
<description>
-Retrieves whether the text in @entry is visible. See
-gtk_entry_set_visibility().
+Retrieves whether the text in @entry is visible.
+
+See [method@Gtk.Entry.set_visibility].
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
@@ -34931,17 +37757,16 @@ gtk_entry_set_visibility().
<description>
Causes @entry to have keyboard focus.
-It behaves like gtk_widget_grab_focus(),
-except that it doesn't select the contents of the entry.
-You only want to call this on some special entries
-which the user usually doesn't want to replace all text in,
-such as search-as-you-type entries.
+It behaves like [method@Gtk.Widget.grab_focus], except that it doesn't
+select the contents of the entry. You only want to call this on some
+special entries which the user usually doesn't want to replace all text
+in, such as search-as-you-type entries.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
@@ -34957,7 +37782,7 @@ Creates a new entry.
</description>
<parameters>
</parameters>
-<return> a new #GtkEntry.
+<return> a new `GtkEntry`.
</return>
</function>
@@ -34969,27 +37794,29 @@ Creates a new entry with the specified text buffer.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> The buffer to use for the new #GtkEntry.
+<parameter_description> The buffer to use for the new `GtkEntry`.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkEntry
+<return> a new `GtkEntry`
</return>
</function>
<function name="gtk_entry_progress_pulse">
<description>
-Indicates that some progress is made, but you don’t know how much.
-Causes the entry’s progress indicator to enter “activity mode,”
-where a block bounces back and forth. Each call to
-gtk_entry_progress_pulse() causes the block to move by a little bit
-(the amount of movement per pulse is determined by
-gtk_entry_set_progress_pulse_step()).
+Indicates that some progress is made, but you don’t
+know how much.
+
+Causes the entry’s progress indicator to enter “activity
+mode”, where a block bounces back and forth. Each call to
+gtk_entry_progress_pulse() causes the block to move by a
+little bit (the amount of movement per pulse is determined
+by [method@Gtk.Entry.set_progress_pulse_step]).
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
@@ -35006,7 +37833,7 @@ would confuse on-going input method behavior.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
@@ -35015,15 +37842,16 @@ would confuse on-going input method behavior.
<function name="gtk_entry_set_activates_default">
<description>
-If @setting is %TRUE, pressing Enter in the @entry will activate the default
-widget for the window containing the entry. This usually means that
-the dialog box containing the entry will be closed, since the default
-widget is usually one of the dialog buttons.
+Sets whether pressing Enter in the @entry will activate the default
+widget for the window containing the entry.
+
+This usually means that the dialog containing the entry will be closed,
+since the default widget is usually one of the dialog buttons.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -35036,14 +37864,17 @@ widget is usually one of the dialog buttons.
<function name="gtk_entry_set_alignment">
<description>
-Sets the alignment for the contents of the entry. This controls
-the horizontal positioning of the contents when the displayed
-text is shorter than the width of the entry.
+Sets the alignment for the contents of the entry.
+
+This controls the horizontal positioning of the contents when
+the displayed text is shorter than the width of the entry.
+
+See also: [property@Gtk.Editable:xalign]
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="xalign">
@@ -35057,17 +37888,22 @@ Reversed for RTL layouts
<function name="gtk_entry_set_attributes">
<description>
-Sets a #PangoAttrList; the attributes in the list are applied to the
-entry text.
+Sets a `PangoAttrList`.
+
+The attributes in the list are applied to the entry text.
+
+Since the attributes will be applies to text that changes
+as the user types, it makes most sense to use attributes
+with unlimited extent.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="attrs">
-<parameter_description> a #PangoAttrList
+<parameter_description> a `PangoAttrList`
</parameter_description>
</parameter>
</parameters>
@@ -35076,17 +37912,17 @@ entry text.
<function name="gtk_entry_set_buffer">
<description>
-Set the #GtkEntryBuffer object which holds the text for
+Set the `GtkEntryBuffer` object which holds the text for
this widget.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter_description> a `GtkEntryBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -35095,19 +37931,21 @@ this widget.
<function name="gtk_entry_set_completion">
<description>
-Sets @completion to be the auxiliary completion object to use with @entry.
-All further configuration of the completion mechanism is done on
-@completion using the #GtkEntryCompletion API. Completion is disabled if
-@completion is set to %NULL.
+Sets @completion to be the auxiliary completion object
+to use with @entry.
+
+All further configuration of the completion mechanism is
+done on @completion using the `GtkEntryCompletion` API.
+Completion is disabled if @completion is set to %NULL.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> A #GtkEntry
+<parameter_description> A `GtkEntry`
</parameter_description>
</parameter>
<parameter name="completion">
-<parameter_description> The #GtkEntryCompletion or %NULL
+<parameter_description> The `GtkEntryCompletion` or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -35122,11 +37960,11 @@ the context menu for @entry.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="model">
-<parameter_description> a #GMenuModel
+<parameter_description> a `GMenuModel`
</parameter_description>
</parameter>
</parameters>
@@ -35140,7 +37978,7 @@ Sets whether the entry has a beveled frame around it.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -35158,7 +37996,7 @@ Sets whether the icon is activatable.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> A #GtkEntry
+<parameter_description> A `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -35175,13 +38013,15 @@ Sets whether the icon is activatable.
<function name="gtk_entry_set_icon_drag_source">
<description>
-Sets up the icon at the given position so that GTK will start a drag
+Sets up the icon at the given position as drag source.
+
+This makes it so that GTK will start a drag
operation when the user clicks and drags the icon.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -35204,15 +38044,17 @@ operation when the user clicks and drags the icon.
<description>
Sets the icon shown in the entry at the specified position
from the current icon theme.
-If the icon isn’t known, a “broken image” icon will be displayed
-instead.
-If @icon is %NULL, no icon will be shown in the specified position.
+If the icon isn’t known, a “broken image” icon will be
+displayed instead.
+
+If @icon is %NULL, no icon will be shown in the
+specified position.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> A #GtkEntry
+<parameter_description> A `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -35232,15 +38074,16 @@ If @icon is %NULL, no icon will be shown in the specified position.
Sets the icon shown in the entry at the specified position
from the current icon theme.
-If the icon name isn’t known, a “broken image” icon will be displayed
-instead.
+If the icon name isn’t known, a “broken image” icon will be
+displayed instead.
-If @icon_name is %NULL, no icon will be shown in the specified position.
+If @icon_name is %NULL, no icon will be shown in the
+specified position.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> A #GtkEntry
+<parameter_description> A `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -35257,14 +38100,14 @@ If @icon_name is %NULL, no icon will be shown in the specified position.
<function name="gtk_entry_set_icon_from_paintable">
<description>
-Sets the icon shown in the specified position using a #GdkPaintable
+Sets the icon shown in the specified position using a `GdkPaintable`.
If @paintable is %NULL, no icon will be shown in the specified position.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -35272,7 +38115,7 @@ If @paintable is %NULL, no icon will be shown in the specified position.
</parameter_description>
</parameter>
<parameter name="paintable">
-<parameter_description> A #GdkPaintable, or %NULL
+<parameter_description> A `GdkPaintable`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -35286,7 +38129,7 @@ Sets the sensitivity for the specified icon.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> A #GtkEntry
+<parameter_description> A `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -35305,18 +38148,19 @@ sensitive or insensitive
<function name="gtk_entry_set_icon_tooltip_markup">
<description>
Sets @tooltip as the contents of the tooltip for the icon at
-the specified position. @tooltip is assumed to be marked up with
-the [Pango text markup language][PangoMarkupFormat].
+the specified position.
+
+@tooltip is assumed to be marked up with Pango Markup.
Use %NULL for @tooltip to remove an existing tooltip.
-See also gtk_widget_set_tooltip_markup() and
-gtk_entry_set_icon_tooltip_text().
+See also [method@Gtk.Widget.set_tooltip_markup] and
+[method@Gtk.Entry.set_icon_tooltip_text].
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -35324,7 +38168,8 @@ gtk_entry_set_icon_tooltip_text().
</parameter_description>
</parameter>
<parameter name="tooltip">
-<parameter_description> the contents of the tooltip for the icon, or %NULL
+<parameter_description> the contents of the tooltip for the
+icon, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -35338,19 +38183,23 @@ at the specified position.
Use %NULL for @tooltip to remove an existing tooltip.
-See also gtk_widget_set_tooltip_text() and
-gtk_entry_set_icon_tooltip_markup().
+See also [method@Gtk.Widget.set_tooltip_text] and
+[method@Gtk.Entry.set_icon_tooltip_markup].
-If you unset the widget tooltip via gtk_widget_set_tooltip_text() or
-gtk_widget_set_tooltip_markup(), this sets GtkWidget:has-tooltip to %FALSE,
-which suppresses icon tooltips too. You can resolve this by then calling
-gtk_widget_set_has_tooltip() to set GtkWidget:has-tooltip back to %TRUE, or
-setting at least one non-empty tooltip on any icon achieves the same result.
+If you unset the widget tooltip via
+[method@Gtk.Widget.set_tooltip_text] or
+[method@Gtk.Widget.set_tooltip_markup], this sets
+[property@Gtk.Widget:has-tooltip] to %FALSE, which suppresses
+icon tooltips too. You can resolve this by then calling
+[method@Gtk.Widget.set_has_tooltip] to set
+[property@Gtk.Widget:has-tooltip] back to %TRUE, or
+setting at least one non-empty tooltip on any icon
+achieves the same result.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="icon_pos">
@@ -35358,7 +38207,8 @@ setting at least one non-empty tooltip on any icon achieves the same result.
</parameter_description>
</parameter>
<parameter name="tooltip">
-<parameter_description> the contents of the tooltip for the icon, or %NULL
+<parameter_description> the contents of the tooltip for the
+icon, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -35367,13 +38217,13 @@ setting at least one non-empty tooltip on any icon achieves the same result.
<function name="gtk_entry_set_input_hints">
<description>
-Sets the #GtkEntry:input-hints property, which
-allows input methods to fine-tune their behaviour.
+Set additional hints which allow input methods to
+fine-tune their behavior.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="hints">
@@ -35386,14 +38236,13 @@ allows input methods to fine-tune their behaviour.
<function name="gtk_entry_set_input_purpose">
<description>
-Sets the #GtkEntry:input-purpose property which
-can be used by on-screen keyboards and other input
-methods to adjust their behaviour.
+Sets the input purpose which can be used by input methods
+to adjust their behavior.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="purpose">
@@ -35406,18 +38255,21 @@ methods to adjust their behaviour.
<function name="gtk_entry_set_invisible_char">
<description>
-Sets the character to use in place of the actual text when
-gtk_entry_set_visibility() has been called to set text visibility
-to %FALSE. i.e. this is the character used in “password mode” to
-show the user how many characters have been typed. By default, GTK
-picks the best invisible char available in the current font. If you
-set the invisible char to 0, then the user will get no feedback
-at all; there will be no text on the screen as they type.
+Sets the character to use in place of the actual text
+in “password mode”.
+
+See [method@Gtk.Entry.set_visibility] for how to enable
+“password mode”.
+
+By default, GTK picks the best invisible char available in
+the current font. If you set the invisible char to 0, then
+the user will get no feedback at all; there will be no text
+on the screen as they type.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="ch">
@@ -35430,18 +38282,18 @@ at all; there will be no text on the screen as they type.
<function name="gtk_entry_set_max_length">
<description>
-Sets the maximum allowed length of the contents of the widget. If
-the current contents are longer than the given length, then they
-will be truncated to fit.
+Sets the maximum allowed length of the contents of the widget.
-This is equivalent to getting @entry's #GtkEntryBuffer and
-calling gtk_entry_buffer_set_max_length() on it.
-]|
+If the current contents are longer than the given length, then
+they will be truncated to fit.
+
+This is equivalent to getting @entry's `GtkEntryBuffer` and
+calling [method@Gtk.EntryBuffer.set_max_length] on it.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="max">
@@ -35456,12 +38308,12 @@ be clamped to the range 0-65536.
<function name="gtk_entry_set_overwrite_mode">
<description>
-Sets whether the text is overwritten when typing in the #GtkEntry.
+Sets whether the text is overwritten when typing in the `GtkEntry`.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="overwrite">
@@ -35475,17 +38327,19 @@ Sets whether the text is overwritten when typing in the #GtkEntry.
<function name="gtk_entry_set_placeholder_text">
<description>
Sets text to be displayed in @entry when it is empty.
-This can be used to give a visual hint of the expected contents of
-the #GtkEntry.
+
+This can be used to give a visual hint of the expected
+contents of the `GtkEntry`.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="text">
-<parameter_description> a string to be displayed when @entry is empty and unfocused, or %NULL
+<parameter_description> a string to be displayed when @entry is
+empty and unfocused, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -35495,13 +38349,14 @@ the #GtkEntry.
<function name="gtk_entry_set_progress_fraction">
<description>
Causes the entry’s progress indicator to “fill in” the given
-fraction of the bar. The fraction should be between 0.0 and 1.0,
-inclusive.
+fraction of the bar.
+
+The fraction should be between 0.0 and 1.0, inclusive.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="fraction">
@@ -35515,12 +38370,15 @@ inclusive.
<function name="gtk_entry_set_progress_pulse_step">
<description>
Sets the fraction of total entry width to move the progress
-bouncing block for each call to gtk_entry_progress_pulse().
+bouncing block for each pulse.
+
+Use [method@Gtk.Entry.progress_pulse] to pulse
+the progress.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="fraction">
@@ -35533,17 +38391,18 @@ bouncing block for each call to gtk_entry_progress_pulse().
<function name="gtk_entry_set_tabs">
<description>
-Sets a #PangoTabArray; the tabstops in the array are applied to the entry
-text.
+Sets a `PangoTabArray`.
+
+The tabstops in the array are applied to the entry text.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="tabs">
-<parameter_description> a #PangoTabArray
+<parameter_description> a `PangoTabArray`
</parameter_description>
</parameter>
</parameters>
@@ -35553,15 +38412,16 @@ text.
<function name="gtk_entry_set_visibility">
<description>
Sets whether the contents of the entry are visible or not.
+
When visibility is set to %FALSE, characters are displayed
as the invisible char, and will also appear that way when
the text in the entry widget is copied elsewhere.
By default, GTK picks the best invisible character available
in the current font, but it can be changed with
-gtk_entry_set_invisible_char().
+[method@Gtk.Entry.set_invisible_char].
-Note that you probably want to set #GtkEntry:input-purpose
+Note that you probably want to set [property@Gtk.Entry:input-purpose]
to %GTK_INPUT_PURPOSE_PASSWORD or %GTK_INPUT_PURPOSE_PIN to
inform input methods about the purpose of this entry,
in addition to setting visibility to %FALSE.
@@ -35569,7 +38429,7 @@ in addition to setting visibility to %FALSE.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
<parameter name="visible">
@@ -35583,14 +38443,13 @@ as plaintext
<function name="gtk_entry_unset_invisible_char">
<description>
-Unsets the invisible char previously set with
-gtk_entry_set_invisible_char(). So that the
-default invisible char is used again.
+Unsets the invisible char, so that the default invisible char
+is used again. See [method@Gtk.Entry.set_invisible_char].
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter_description> a `GtkEntry`
</parameter_description>
</parameter>
</parameters>
@@ -35599,7 +38458,8 @@ default invisible char is used again.
<function name="gtk_enumerate_printers">
<description>
-Calls a function for all #GtkPrinters.
+Calls a function for all `GtkPrinter`s.
+
If @func returns %TRUE, the enumeration is stopped.
</description>
@@ -35627,13 +38487,13 @@ all printers are enumerated; otherwise return early
<function name="gtk_event_controller_focus_contains_focus">
<description>
-Returns the value of the GtkEventControllerFocus:contains-focus property.
+Returns %TRUE if focus is within @self or one of its children.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkEventControllerFocus
+<parameter_description> a `GtkEventControllerFocus`
</parameter_description>
</parameter>
</parameters>
@@ -35643,17 +38503,17 @@ Returns the value of the GtkEventControllerFocus:contains-focus property.
<function name="gtk_event_controller_focus_is_focus">
<description>
-Returns the value of the GtkEventControllerFocus:is-focus property.
+Returns %TRUE if focus is within @self, but not one of its children.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkEventControllerFocus
+<parameter_description> a `GtkEventControllerFocus`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if focus is within @self but not one of its children
+<return> %TRUE if focus is within @self, but not one of its children
</return>
</function>
@@ -35665,7 +38525,7 @@ Creates a new event controller that will handle focus events.
</description>
<parameters>
</parameters>
-<return> a new #GtkEventControllerFocus
+<return> a new `GtkEventControllerFocus`
</return>
</function>
@@ -35678,11 +38538,12 @@ controller, and %NULL at other times.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkEventController
+<parameter_description> a `GtkEventController`
</parameter_description>
</parameter>
</parameters>
-<return> the event is current handled by @controller
+<return> the event that is currently
+handled by @controller
</return>
</function>
@@ -35695,11 +38556,12 @@ handled by the controller, and %NULL otherwise.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkEventController
+<parameter_description> a `GtkEventController`
</parameter_description>
</parameter>
</parameters>
-<return> device of the event is current handled by @controller
+<return> device of the event is
+currently handled by @controller
</return>
</function>
@@ -35712,11 +38574,11 @@ handled by the controller, and 0 otherwise.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkEventController
+<parameter_description> a `GtkEventController`
</parameter_description>
</parameter>
</parameters>
-<return> modifier state of the event is current handled by @controller
+<return> modifier state of the event is currently handled by @controller
</return>
</function>
@@ -35729,11 +38591,11 @@ handled by the controller, and 0 otherwise.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkEventController
+<parameter_description> a `GtkEventController`
</parameter_description>
</parameter>
</parameters>
-<return> timestamp of the event is current handled by @controller
+<return> timestamp of the event is currently handled by @controller
</return>
</function>
@@ -35744,7 +38606,7 @@ Gets the name of @controller.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkEventController
+<parameter_description> a `GtkEventController`
</parameter_description>
</parameter>
</parameters>
@@ -35759,7 +38621,7 @@ Gets the propagation limit of the event controller.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkEventController
+<parameter_description> a `GtkEventController`
</parameter_description>
</parameter>
</parameters>
@@ -35775,7 +38637,7 @@ Gets the propagation phase at which @controller handles events.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkEventController
+<parameter_description> a `GtkEventController`
</parameter_description>
</parameter>
</parameters>
@@ -35791,11 +38653,11 @@ Returns the #GtkWidget this controller relates to.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkEventController
+<parameter_description> a `GtkEventController`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkWidget
+<return> a `GtkWidget`
</return>
</function>
@@ -35804,21 +38666,19 @@ Returns the #GtkWidget this controller relates to.
Forwards the current event of this @controller to a @widget.
This function can only be used in handlers for the
-#GtkEventControllerKey::key-pressed,
-#GtkEventControllerKey::key-released
-or
-#GtkEventControllerKey::modifiers
-signals.
+[signal@Gtk.EventControllerKey::key-pressed],
+[signal@Gtk.EventControllerKey::key-released]
+or [signal@Gtk.EventControllerKey::modifiers] signals.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkEventControllerKey
+<parameter_description> a `GtkEventControllerKey`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -35829,13 +38689,14 @@ signals.
<function name="gtk_event_controller_key_get_group">
<description>
Gets the key group of the current event of this @controller.
-See gdk_key_event_get_group().
+
+See [method@Gdk.KeyEvent.get_layout].
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkEventControllerKey
+<parameter_description> a `GtkEventControllerKey`
</parameter_description>
</parameter>
</parameters>
@@ -35851,11 +38712,11 @@ Gets the input method context of the key @controller.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkEventControllerKey
+<parameter_description> a `GtkEventControllerKey`
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkIMContext
+<return> the `GtkIMContext`
</return>
</function>
@@ -35867,7 +38728,7 @@ Creates a new event controller that will handle key events.
</description>
<parameters>
</parameters>
-<return> a new #GtkEventControllerKey
+<return> a new `GtkEventControllerKey`
</return>
</function>
@@ -35878,11 +38739,11 @@ Sets the input method context of the key @controller.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkEventControllerKey
+<parameter_description> a `GtkEventControllerKey`
</parameter_description>
</parameter>
<parameter name="im_context">
-<parameter_description> a #GtkIMContext
+<parameter_description> a `GtkIMContext`
</parameter_description>
</parameter>
</parameters>
@@ -35903,13 +38764,13 @@ Creates a new legacy event controller.
<function name="gtk_event_controller_motion_contains_pointer">
<description>
-Returns the value of the GtkEventControllerMotion:contains-pointer property.
+Returns if a pointer is within @self or one of its children.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkEventControllerMotion
+<parameter_description> a `GtkEventControllerMotion`
</parameter_description>
</parameter>
</parameters>
@@ -35919,13 +38780,13 @@ Returns the value of the GtkEventControllerMotion:contains-pointer property.
<function name="gtk_event_controller_motion_is_pointer">
<description>
-Returns the value of the GtkEventControllerMotion:is-pointer property.
+Returns if a pointer is within @self, but not one of its children.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkEventControllerMotion
+<parameter_description> a `GtkEventControllerMotion`
</parameter_description>
</parameter>
</parameters>
@@ -35941,20 +38802,18 @@ Creates a new event controller that will handle motion events.
</description>
<parameters>
</parameters>
-<return> a new #GtkEventControllerMotion
+<return> a new `GtkEventControllerMotion`
</return>
</function>
<function name="gtk_event_controller_reset">
<description>
-Resets the @controller to a clean state. Every interaction
-the controller did through gtk_event_controller_handle_event()
-will be dropped at this point.
+Resets the @controller to a clean state.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkEventController
+<parameter_description> a `GtkEventController`
</parameter_description>
</parameter>
</parameters>
@@ -35969,7 +38828,7 @@ Gets the flags conditioning the scroll controller behavior.
</description>
<parameters>
<parameter name="scroll">
-<parameter_description> a #GtkEventControllerScroll
+<parameter_description> a `GtkEventControllerScroll`
</parameter_description>
</parameter>
</parameters>
@@ -35985,11 +38844,11 @@ Creates a new event controller that will handle scroll events.
</description>
<parameters>
<parameter name="flags">
-<parameter_description> behavior flags
+<parameter_description> flags affecting the controller behavior
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkEventControllerScroll
+<return> a new `GtkEventControllerScroll`
</return>
</function>
@@ -36000,11 +38859,11 @@ Sets the flags conditioning scroll controller behavior.
</description>
<parameters>
<parameter name="scroll">
-<parameter_description> a #GtkEventControllerScroll
+<parameter_description> a `GtkEventControllerScroll`
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> behavior flags
+<parameter_description> flags affecting the controller behavior
</parameter_description>
</parameter>
</parameters>
@@ -36013,13 +38872,12 @@ Sets the flags conditioning scroll controller behavior.
<function name="gtk_event_controller_set_name">
<description>
-Sets a name on the controller that can be used for
-debugging.
+Sets a name on the controller that can be used for debugging.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkEventController
+<parameter_description> a `GtkEventController`
</parameter_description>
</parameter>
<parameter name="name">
@@ -36041,7 +38899,7 @@ surface, such as popovers.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkEventController
+<parameter_description> a `GtkEventController`
</parameter_description>
</parameter>
<parameter name="limit">
@@ -36057,13 +38915,12 @@ surface, such as popovers.
Sets the propagation phase at which a controller handles events.
If @phase is %GTK_PHASE_NONE, no automatic event handling will be
-performed, but other additional gesture maintenance will. In that phase,
-the events can be managed by calling gtk_event_controller_handle_event().
+performed, but other additional gesture maintenance will.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkEventController
+<parameter_description> a `GtkEventController`
</parameter_description>
</parameter>
<parameter name="phase">
@@ -36077,18 +38934,18 @@ the events can be managed by calling gtk_event_controller_handle_event().
<function name="gtk_every_filter_new">
<description>
Creates a new empty "every" filter.
-Use gtk_multi_filter_append() to add filters to it.
+
+Use [method@Gtk.MultiFilter.append] to add filters to it.
This filter matches an item if each of the filters added to it
-matches the item.
-In particular, this means that if no filter has been added to
-it, the filter matches every item.
+matches the item. In particular, this means that if no filter
+has been added to it, the filter matches every item.
</description>
<parameters>
</parameters>
-<return> a new #GtkEveryFilter
+<return> a new `GtkEveryFilter`
</return>
</function>
@@ -36100,7 +38957,7 @@ Gets the child widget of @expander.
</description>
<parameters>
<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter_description> a `GtkExpander`
</parameter_description>
</parameter>
</parameters>
@@ -36110,16 +38967,13 @@ Gets the child widget of @expander.
<function name="gtk_expander_get_expanded">
<description>
-Queries a #GtkExpander and returns its current state. Returns %TRUE
-if the child widget is revealed.
-
-See gtk_expander_set_expanded().
+Queries a #GtkExpander and returns its current state.
</description>
<parameters>
<parameter name="expander">
-<parameter_description>a #GtkExpander
+<parameter_description>a `GtkExpander`
</parameter_description>
</parameter>
</parameters>
@@ -36129,23 +38983,19 @@ See gtk_expander_set_expanded().
<function name="gtk_expander_get_label">
<description>
-Fetches the text from a label widget including any embedded
-underlines indicating mnemonics and Pango markup, as set by
-gtk_expander_set_label(). If the label text has not been set the
-return value will be %NULL. This will be the case if you create an
-empty button with gtk_button_new() to use as a container.
+Fetches the text from a label widget.
-Note that this function behaved differently in versions prior to
-2.14 and used to return the label text stripped of embedded
-underlines indicating mnemonics and Pango markup. This problem can
-be avoided by fetching the label text directly from the label
-widget.
+This is including any embedded underlines indicating mnemonics and
+Pango markup, as set by [method@Gtk.Expander.set_label]. If the label
+text has not been set the return value will be %NULL. This will be the
+case if you create an empty button with gtk_button_new() to use as a
+container.
</description>
<parameters>
<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter_description> a `GtkExpander`
</parameter_description>
</parameter>
</parameters>
@@ -36156,14 +39006,13 @@ by the widget and must not be modified or freed.
<function name="gtk_expander_get_label_widget">
<description>
-Retrieves the label widget for the frame. See
-gtk_expander_set_label_widget().
+Retrieves the label widget for the frame.
</description>
<parameters>
<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter_description> a `GtkExpander`
</parameter_description>
</parameter>
</parameters>
@@ -36181,7 +39030,7 @@ containing the expander upon resizing and collpasing.
</description>
<parameters>
<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter_description> a `GtkExpander`
</parameter_description>
</parameter>
</parameters>
@@ -36191,15 +39040,13 @@ containing the expander upon resizing and collpasing.
<function name="gtk_expander_get_use_markup">
<description>
-Returns whether the label’s text is interpreted as marked up with
-the [Pango text markup language][PangoMarkupFormat].
-See gtk_expander_set_use_markup().
+Returns whether the label’s text is interpreted as Pango markup.
</description>
<parameters>
<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter_description> a `GtkExpander`
</parameter_description>
</parameter>
</parameters>
@@ -36209,14 +39056,13 @@ See gtk_expander_set_use_markup().
<function name="gtk_expander_get_use_underline">
<description>
-Returns whether an embedded underline in the expander label
-indicates a mnemonic. See gtk_expander_set_use_underline().
+Returns whether an underline in the text indicates a mnemonic.
</description>
<parameters>
<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter_description> a `GtkExpander`
</parameter_description>
</parameter>
</parameters>
@@ -36237,17 +39083,19 @@ Creates a new expander using @label as the text of the label.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkExpander widget.
+<return> a new `GtkExpander` widget.
</return>
</function>
<function name="gtk_expander_new_with_mnemonic">
<description>
Creates a new expander using @label as the text of the label.
-If characters in @label are preceded by an underscore, they are underlined.
-If you need a literal underscore character in a label, use “__” (two
-underscores). The first underlined character represents a keyboard
-accelerator called a mnemonic.
+
+If characters in @label are preceded by an underscore, they are
+underlined. If you need a literal underscore character in a label,
+use “__” (two underscores). The first underlined character represents
+a keyboard accelerator called a mnemonic.
+
Pressing Alt and that key activates the button.
@@ -36259,7 +39107,7 @@ in front of the mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkExpander widget.
+<return> a new `GtkExpander` widget.
</return>
</function>
@@ -36270,7 +39118,7 @@ Sets the child widget of @expander.
</description>
<parameters>
<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter_description> a `GtkExpander`
</parameter_description>
</parameter>
<parameter name="child">
@@ -36283,14 +39131,15 @@ Sets the child widget of @expander.
<function name="gtk_expander_set_expanded">
<description>
-Sets the state of the expander. Set to %TRUE, if you want
-the child widget to be revealed, and %FALSE if you want the
-child widget to be hidden.
+Sets the state of the expander.
+
+Set to %TRUE, if you want the child widget to be revealed,
+and %FALSE if you want the child widget to be hidden.
</description>
<parameters>
<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter_description> a `GtkExpander`
</parameter_description>
</parameter>
<parameter name="expanded">
@@ -36310,7 +39159,7 @@ This will also clear any previously set labels.
</description>
<parameters>
<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter_description> a `GtkExpander`
</parameter_description>
</parameter>
<parameter name="label">
@@ -36323,13 +39172,15 @@ This will also clear any previously set labels.
<function name="gtk_expander_set_label_widget">
<description>
-Set the label widget for the expander. This is the widget
-that will appear embedded alongside the expander arrow.
+Set the label widget for the expander.
+
+This is the widget that will appear embedded alongside
+the expander arrow.
</description>
<parameters>
<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter_description> a `GtkExpander`
</parameter_description>
</parameter>
<parameter name="label_widget">
@@ -36348,7 +39199,7 @@ containing the expander upon resizing and collpasing.
</description>
<parameters>
<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter_description> a `GtkExpander`
</parameter_description>
</parameter>
<parameter name="resize_toplevel">
@@ -36361,14 +39212,12 @@ containing the expander upon resizing and collpasing.
<function name="gtk_expander_set_use_markup">
<description>
-Sets whether the text of the label contains markup in
-[Pango’s text markup language][PangoMarkupFormat].
-See gtk_label_set_markup().
+Sets whether the text of the label contains Pango markup.
</description>
<parameters>
<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter_description> a `GtkExpander`
</parameter_description>
</parameter>
<parameter name="use_markup">
@@ -36381,13 +39230,12 @@ See gtk_label_set_markup().
<function name="gtk_expander_set_use_underline">
<description>
-If true, an underline in the text of the expander label indicates
-the next character should be used for the mnemonic accelerator key.
+If true, an underline in the text indicates a mnemonic.
</description>
<parameters>
<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter_description> a `GtkExpander`
</parameter_description>
</parameter>
<parameter name="use_underline">
@@ -36400,24 +39248,24 @@ the next character should be used for the mnemonic accelerator key.
<function name="gtk_expression_bind">
<description>
-Bind @target's property named @property to @self.
+Bind `target`'s property named `property` to `self`.
-The value that @self evaluates to is set via g_object_set() on
-@target. This is repeated whenever @self changes to ensure that
-the object's property stays synchronized with @self.
+The value that `self` evaluates to is set via `g_object_set()` on
+`target`. This is repeated whenever `self` changes to ensure that
+the object's property stays synchronized with `self`.
-If @self's evaluation fails, @target's @property is not updated.
+If `self`'s evaluation fails, `target`'s `property` is not updated.
You can ensure that this doesn't happen by using a fallback
expression.
-Note that this function takes ownership of @self. If you want
-to keep it around, you should gtk_expression_ref() it beforehand.
+Note that this function takes ownership of `self`. If you want
+to keep it around, you should [method Gtk Expression ref] it beforehand.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkExpression
+<parameter_description> a `GtkExpression`
</parameter_description>
</parameter>
<parameter name="target">
@@ -36425,35 +39273,37 @@ to keep it around, you should gtk_expression_ref() it beforehand.
</parameter_description>
</parameter>
<parameter name="property">
-<parameter_description> name of the property on @target to bind to
+<parameter_description> name of the property on `target` to bind to
</parameter_description>
</parameter>
<parameter name="this_">
<parameter_description> the this argument for
-the evaluation of @self
+the evaluation of `self`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkExpressionWatch
+<return> a `GtkExpressionWatch`
</return>
</function>
<function name="gtk_expression_evaluate">
<description>
Evaluates the given expression and on success stores the result
-in @value. The #GType of @value will be the type given by
-gtk_expression_get_value_type().
+in @value.
+
+The `GType` of `value` will be the type given by
+[method@Gtk.Expression.get_value_type].
It is possible that expressions cannot be evaluated - for example
when the expression references objects that have been destroyed or
-set to %NULL. In that case @value will remain empty and %FALSE
+set to `NULL`. In that case `value` will remain empty and `FALSE`
will be returned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkExpression
+<parameter_description> a `GtkExpression`
</parameter_description>
</parameter>
<parameter name="this_">
@@ -36461,28 +39311,30 @@ will be returned.
</parameter_description>
</parameter>
<parameter name="value">
-<parameter_description> an empty #GValue
+<parameter_description> an empty `GValue`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the expression could be evaluated
+<return> `TRUE` if the expression could be evaluated
</return>
</function>
<function name="gtk_expression_get_value_type">
<description>
-Gets the #GType that this expression evaluates to. This type
-is constant and will not change over the lifetime of this expression.
+Gets the `GType` that this expression evaluates to.
+
+This type is constant and will not change over the lifetime
+of this expression.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkExpression
+<parameter_description> a `GtkExpression`
</parameter_description>
</parameter>
</parameters>
-<return> The type returned from gtk_expression_evaluate()
+<return> The type returned from [method@Gtk.Expression.evaluate]
</return>
</function>
@@ -36490,51 +39342,51 @@ is constant and will not change over the lifetime of this expression.
<description>
Checks if the expression is static.
-A static expression will never change its result when
-gtk_expression_evaluate() is called on it with the same arguments.
+A static expression will never change its result when
+[method@Gtk.Expression.evaluate] is called on it with the same arguments.
-That means a call to gtk_expression_watch() is not necessary because
+That means a call to [method@Gtk.Expression.watch] is not necessary because
it will never trigger a notify.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkExpression
+<parameter_description> a `GtkExpression`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the expression is static
+<return> `TRUE` if the expression is static
</return>
</function>
<function name="gtk_expression_ref">
<description>
-Acquires a reference on the given #GtkExpression.
+Acquires a reference on the given `GtkExpression`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkExpression
+<parameter_description> a `GtkExpression`
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkExpression with an additional reference
+<return> the `GtkExpression` with an additional reference
</return>
</function>
<function name="gtk_expression_unref">
<description>
-Releases a reference on the given #GtkExpression.
+Releases a reference on the given `GtkExpression`.
-If the reference was the last, the resources associated to the @self are
+If the reference was the last, the resources associated to the `self` are
freed.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkExpression
+<parameter_description> a `GtkExpression`
</parameter_description>
</parameter>
</parameters>
@@ -36543,18 +39395,18 @@ freed.
<function name="gtk_expression_watch">
<description>
-Installs a watch for the given @expression that calls the @notify function
-whenever the evaluation of @self may have changed.
+Installs a watch for the given `expression` that calls the `notify` function
+whenever the evaluation of `self` may have changed.
GTK cannot guarantee that the evaluation did indeed change when the @notify
gets invoked, but it guarantees the opposite: When it did in fact change,
-the @notify will be invoked.
+the `notify` will be invoked.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkExpression
+<parameter_description> a `GtkExpression`
</parameter_description>
</parameter>
<parameter name="this_">
@@ -36568,18 +39420,18 @@ expression changes
</parameter_description>
</parameter>
<parameter name="user_data">
-<parameter_description> user data to pass to @notify callback
+<parameter_description> user data to pass to the `notify` callback
</parameter_description>
</parameter>
<parameter name="user_destroy">
-<parameter_description> destroy notify for @user_data
+<parameter_description> destroy notify for `user_data`
</parameter_description>
</parameter>
</parameters>
<return> The newly installed watch. Note that the only
reference held to the watch will be released when the watch is unwatched
which can happen automatically, and not just via
-gtk_expression_watch_unwatch(). You should call gtk_expression_watch_ref()
+[method@Gtk.ExpressionWatch.unwatch]. You should call [method Gtk ExpressionWatch ref]
if you want to keep the watch around.
</return>
</function>
@@ -36587,54 +39439,54 @@ if you want to keep the watch around.
<function name="gtk_expression_watch_evaluate">
<description>
Evaluates the watched expression and on success stores the result
-in @value.
+in `value`.
-This is equivalent to calling gtk_expression_evaluate() with the
-expression and this pointer originally used to create @watch.
+This is equivalent to calling [method@Gtk.Expression.evaluate] with the
+expression and this pointer originally used to create `watch`.
</description>
<parameters>
<parameter name="watch">
-<parameter_description> a #GtkExpressionWatch
+<parameter_description> a `GtkExpressionWatch`
</parameter_description>
</parameter>
<parameter name="value">
-<parameter_description> an empty #GValue to be set
+<parameter_description> an empty `GValue` to be set
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the expression could be evaluated and @value was set
+<return> `TRUE` if the expression could be evaluated and `value` was set
</return>
</function>
<function name="gtk_expression_watch_ref">
<description>
-Acquires a reference on the given #GtkExpressionWatch.
+Acquires a reference on the given `GtkExpressionWatch`.
</description>
<parameters>
<parameter name="watch">
-<parameter_description> a #GtkExpressionWatch
+<parameter_description> a `GtkExpressionWatch`
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkExpression with an additional reference
+<return> the `GtkExpressionWatch` with an additional reference
</return>
</function>
<function name="gtk_expression_watch_unref">
<description>
-Releases a reference on the given #GtkExpressionWatch.
+Releases a reference on the given `GtkExpressionWatch`.
-If the reference was the last, the resources associated to @self are
+If the reference was the last, the resources associated to `self` are
freed.
</description>
<parameters>
<parameter name="watch">
-<parameter_description> a #GtkExpressionWatch
+<parameter_description> a `GtkExpressionWatch`
</parameter_description>
</parameter>
</parameters>
@@ -36643,7 +39495,10 @@ freed.
<function name="gtk_expression_watch_unwatch">
<description>
-Stops watching an expression that was established via gtk_expression_watch().
+Stops watching an expression.
+
+See [method@Gtk.Expression.watch] for how the watch
+was established.
</description>
<parameters>
@@ -36657,16 +39512,19 @@ Stops watching an expression that was established via gtk_expression_watch().
<function name="gtk_file_chooser_add_choice">
<description>
-Adds a 'choice' to the file chooser. This is typically implemented
-as a combobox or, for boolean choices, as a checkbutton. You can select
-a value using gtk_file_chooser_set_choice() before the dialog is shown,
-and you can obtain the user-selected value in the ::response signal handler
-using gtk_file_chooser_get_choice().
+Adds a 'choice' to the file chooser.
+
+This is typically implemented as a combobox or, for boolean choices,
+as a checkbutton. You can select a value using
+[method@Gtk.FileChooser.set_choice] before the dialog is shown,
+and you can obtain the user-selected value in the
+[signal@Gtk.Dialog::response] signal handler using
+[method@Gtk.FileChooser.get_choice].
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
<parameter name="id">
@@ -36692,8 +39550,9 @@ using gtk_file_chooser_get_choice().
<function name="gtk_file_chooser_add_filter">
<description>
Adds @filter to the list of filters that the user can select between.
+
When a filter is selected, only files that are passed by that
-filter are displayed.
+filter are displayed.
Note that the @chooser takes ownership of the filter if it is floating,
so you have to ref and sink it if you want to keep a reference.
@@ -36701,11 +39560,11 @@ so you have to ref and sink it if you want to keep a reference.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
<parameter name="filter">
-<parameter_description> a #GtkFileFilter
+<parameter_description> a `GtkFileFilter`
</parameter_description>
</parameter>
</parameters>
@@ -36714,17 +39573,18 @@ so you have to ref and sink it if you want to keep a reference.
<function name="gtk_file_chooser_add_shortcut_folder">
<description>
-Adds a folder to be displayed with the shortcut folders in a file chooser.
+Adds a folder to be displayed with the shortcut folders
+in a file chooser.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
<parameter name="folder">
-<parameter_description> a #GFile for the folder to add
+<parameter_description> a `GFile` for the folder to add
</parameter_description>
</parameter>
<parameter name="error">
@@ -36732,15 +39592,16 @@ Adds a folder to be displayed with the shortcut folders in a file chooser.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the folder could be added successfully, %FALSE
-otherwise.
+<return> %TRUE if the folder could be added successfully,
+%FALSE otherwise.
</return>
</function>
<function name="gtk_file_chooser_dialog_new">
<description>
-Creates a new #GtkFileChooserDialog. This function is analogous to
-gtk_dialog_new_with_buttons().
+Creates a new `GtkFileChooserDialog`.
+
+This function is analogous to [ctor@Gtk.Dialog.new_with_buttons].
</description>
@@ -36766,32 +39627,31 @@ gtk_dialog_new_with_buttons().
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkFileChooserDialog
+<return> a new `GtkFileChooserDialog`
</return>
</function>
<function name="gtk_file_chooser_error_quark">
<description>
-Registers an error quark for #GtkFileChooser if necessary.
+Registers an error quark for `GtkFileChooser` errors.
</description>
<parameters>
</parameters>
-<return> The error quark used for #GtkFileChooser errors.
+<return> The error quark used for `GtkFileChooser` errors.
</return>
</function>
<function name="gtk_file_chooser_get_action">
<description>
-Gets the type of operation that the file chooser is performing; see
-gtk_file_chooser_set_action().
+Gets the type of operation that the file chooser is performing.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
</parameters>
@@ -36807,7 +39667,7 @@ Gets the currently selected option in the 'choice' with the given ID.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
<parameter name="id">
@@ -36822,13 +39682,12 @@ Gets the currently selected option in the 'choice' with the given ID.
<function name="gtk_file_chooser_get_create_folders">
<description>
Gets whether file chooser will offer to create new folders.
-See gtk_file_chooser_set_create_folders().
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
</parameters>
@@ -36844,56 +39703,58 @@ Gets the current folder of @chooser as #GFile.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
</parameters>
-<return> the #GFile for the current folder.
+<return> the `GFile` for the current folder.
</return>
</function>
<function name="gtk_file_chooser_get_current_name">
<description>
-Gets the current name in the file selector, as entered by the user in the
-text entry for “Name”.
+Gets the current name in the file selector, as entered by the user.
-This is meant to be used in save dialogs, to get the currently typed filename
-when the file itself does not exist yet.
+This is meant to be used in save dialogs, to get the currently typed
+filename when the file itself does not exist yet.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
</parameters>
-<return> The raw text from the file chooser’s “Name” entry. Free this with
-g_free(). Note that this string is not a full pathname or URI; it is
-whatever the contents of the entry are. Note also that this string is in
-UTF-8 encoding, which is not necessarily the system’s encoding for filenames.
+<return> The raw text from the file chooser’s “Name” entry. Free with
+g_free(). Note that this string is not a full pathname or URI; it is
+whatever the contents of the entry are. Note also that this string is
+in UTF-8 encoding, which is not necessarily the system’s encoding for
+filenames.
</return>
</function>
<function name="gtk_file_chooser_get_file">
<description>
-Gets the #GFile for the currently selected file in
-the file selector. If multiple files are selected,
-one of the files will be returned at random.
+Gets the `GFile` for the currently selected file in
+the file selector.
-If the file chooser is in folder mode, this function returns the selected
-folder.
+If multiple files are selected, one of the files will be
+returned at random.
+
+If the file chooser is in folder mode, this function returns
+the selected folder.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
</parameters>
-<return> a selected #GFile. You own the returned file;
-use g_object_unref() to release it.
+<return> a selected `GFile`. You own the
+returned file; use g_object_unref() to release it.
</return>
</function>
@@ -36906,11 +39767,11 @@ of @chooser as #GFile.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
</parameters>
-<return> a list model containing a #GFile for each
+<return> a list model containing a `GFile` for each
selected file and subfolder in the current folder. Free the returned
list with g_object_unref().
</return>
@@ -36918,13 +39779,13 @@ list with g_object_unref().
<function name="gtk_file_chooser_get_filter">
<description>
-Gets the current filter; see gtk_file_chooser_set_filter().
+Gets the current filter.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
</parameters>
@@ -36934,8 +39795,10 @@ Gets the current filter; see gtk_file_chooser_set_filter().
<function name="gtk_file_chooser_get_filters">
<description>
-Gets the current set of user-selectable filters, as a list model; see
-gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter().
+Gets the current set of user-selectable filters, as a list model.
+
+See [method@Gtk.FileChooser.add_filter] and
+[method@Gtk.FileChooser.remove_filter] for changing individual filters.
You should not modify the returned list model. Future changes to
@chooser may or may not affect the returned model.
@@ -36944,11 +39807,11 @@ You should not modify the returned list model. Future changes to
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
</parameters>
-<return> a #GListModel containing the current set
+<return> a `GListModel` containing the current set
of user-selectable filters.
</return>
</function>
@@ -36956,13 +39819,13 @@ of user-selectable filters.
<function name="gtk_file_chooser_get_select_multiple">
<description>
Gets whether multiple files can be selected in the file
-selector. See gtk_file_chooser_set_select_multiple().
+chooser.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
</parameters>
@@ -36972,8 +39835,7 @@ selector. See gtk_file_chooser_set_select_multiple().
<function name="gtk_file_chooser_get_shortcut_folders">
<description>
-Queries the list of shortcut folders in the file chooser, as set by
-gtk_file_chooser_add_shortcut_folder().
+Queries the list of shortcut folders in the file chooser.
You should not modify the returned list model. Future changes to
@chooser may or may not affect the returned model.
@@ -36982,11 +39844,11 @@ You should not modify the returned list model. Future changes to
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
</parameters>
-<return> A list model of #GFiles
+<return> A list model of `GFile`s
</return>
</function>
@@ -36998,12 +39860,12 @@ Retrieves the custom label text for the accept button.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFileChooserNative
+<parameter_description> a `GtkFileChooserNative`
</parameter_description>
</parameter>
</parameters>
-<return> The custom label, or %NULL for the default. This string
-is owned by GTK+ and should not be modified or freed
+<return> The custom label, or %NULL for the default.
+This string is owned by GTK and should not be modified or freed
</return>
</function>
@@ -37015,18 +39877,18 @@ Retrieves the custom label text for the cancel button.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFileChooserNative
+<parameter_description> a `GtkFileChooserNative`
</parameter_description>
</parameter>
</parameters>
-<return> The custom label, or %NULL for the default. This string
-is owned by GTK+ and should not be modified or freed
+<return> The custom label, or %NULL for the default.
+This string is owned by GTK and should not be modified or freed
</return>
</function>
<function name="gtk_file_chooser_native_new">
<description>
-Creates a new #GtkFileChooserNative.
+Creates a new `GtkFileChooserNative`.
</description>
@@ -37052,7 +39914,7 @@ Creates a new #GtkFileChooserNative.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkFileChooserNative
+<return> a new `GtkFileChooserNative`
</return>
</function>
@@ -37060,16 +39922,17 @@ Creates a new #GtkFileChooserNative.
<description>
Sets the custom label text for the accept button.
-If characters in @label are preceded by an underscore, they are underlined.
-If you need a literal underscore character in a label, use “__” (two
-underscores). The first underlined character represents a keyboard
-accelerator called a mnemonic.
-Pressing Alt and that key activates the button.
+If characters in @label are preceded by an underscore, they are
+underlined. If you need a literal underscore character in a label,
+use “__” (two underscores). The first underlined character represents
+a keyboard accelerator called a mnemonic.
+
+Pressing Alt and that key should activate the button.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFileChooserNative
+<parameter_description> a `GtkFileChooserNative`
</parameter_description>
</parameter>
<parameter name="accept_label">
@@ -37084,16 +39947,17 @@ Pressing Alt and that key activates the button.
<description>
Sets the custom label text for the cancel button.
-If characters in @label are preceded by an underscore, they are underlined.
-If you need a literal underscore character in a label, use “__” (two
-underscores). The first underlined character represents a keyboard
-accelerator called a mnemonic.
-Pressing Alt and that key activates the button.
+If characters in @label are preceded by an underscore, they are
+underlined. If you need a literal underscore character in a label,
+use “__” (two underscores). The first underlined character represents
+a keyboard accelerator called a mnemonic.
+
+Pressing Alt and that key should activate the button.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFileChooserNative
+<parameter_description> a `GtkFileChooserNative`
</parameter_description>
</parameter>
<parameter name="cancel_label">
@@ -37111,7 +39975,7 @@ Removes a 'choice' that has been added with gtk_file_chooser_add_choice().
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
<parameter name="id">
@@ -37129,11 +39993,11 @@ Removes @filter from the list of filters that the user can select between.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
<parameter name="filter">
-<parameter_description> a #GtkFileFilter
+<parameter_description> a `GtkFileFilter`
</parameter_description>
</parameter>
</parameters>
@@ -37148,11 +40012,11 @@ Removes a folder from the shortcut folders in a file chooser.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
<parameter name="folder">
-<parameter_description> a #GFile for the folder to remove
+<parameter_description> a `GFile` for the folder to remove
</parameter_description>
</parameter>
<parameter name="error">
@@ -37160,23 +40024,25 @@ Removes a folder from the shortcut folders in a file chooser.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the folder could be removed successfully, %FALSE
-otherwise.
+<return> %TRUE if the folder could be removed successfully,
+%FALSE otherwise.
</return>
</function>
<function name="gtk_file_chooser_set_action">
<description>
-Sets the type of operation that the chooser is performing; the
-user interface is adapted to suit the selected action. For example,
-an option to create a new folder might be shown if the action is
-%GTK_FILE_CHOOSER_ACTION_SAVE but not if the action is
-%GTK_FILE_CHOOSER_ACTION_OPEN.
+Sets the type of operation that the chooser is performing.
+
+The user interface is adapted to suit the selected action.
+
+For example, an option to create a new folder might be shown
+if the action is %GTK_FILE_CHOOSER_ACTION_SAVE but not if the
+action is %GTK_FILE_CHOOSER_ACTION_OPEN.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
<parameter name="action">
@@ -37190,13 +40056,14 @@ an option to create a new folder might be shown if the action is
<function name="gtk_file_chooser_set_choice">
<description>
Selects an option in a 'choice' that has been added with
-gtk_file_chooser_add_choice(). For a boolean choice, the
-possible options are "true" and "false".
+gtk_file_chooser_add_choice().
+
+For a boolean choice, the possible options are "true" and "false".
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
<parameter name="id">
@@ -37214,13 +40081,14 @@ possible options are "true" and "false".
<function name="gtk_file_chooser_set_create_folders">
<description>
Sets whether file chooser will offer to create new folders.
-This is only relevant if the action is not set to be
+
+This is only relevant if the action is not set to be
%GTK_FILE_CHOOSER_ACTION_OPEN.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
<parameter name="create_folders">
@@ -37239,11 +40107,11 @@ Sets the current folder for @chooser from a #GFile.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
<parameter name="file">
-<parameter_description> the #GFile for the new folder
+<parameter_description> the `GFile` for the new folder
</parameter_description>
</parameter>
<parameter name="error">
@@ -37259,21 +40127,23 @@ otherwise.
<function name="gtk_file_chooser_set_current_name">
<description>
Sets the current name in the file selector, as if entered
-by the user. Note that the name passed in here is a UTF-8
-string rather than a filename. This function is meant for
-such uses as a suggested name in a “Save As...” dialog. You can
-pass “Untitled.doc” or a similarly suitable suggestion for the @name.
+by the user.
+
+Note that the name passed in here is a UTF-8 string rather
+than a filename. This function is meant for such uses as a
+suggested name in a “Save As...” dialog. You can pass
+“Untitled.doc” or a similarly suitable suggestion for the @name.
-If you want to preselect a particular existing file, you should use
-gtk_file_chooser_set_file() instead.
+If you want to preselect a particular existing file, you should
+use [method@Gtk.FileChooser.set_file] instead.
-Please see the documentation for those functions for an example of using
-gtk_file_chooser_set_current_name() as well.
+Please see the documentation for those functions for an example
+of using [method@Gtk.FileChooser.set_current_name] as well.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
<parameter name="name">
@@ -37286,10 +40156,11 @@ gtk_file_chooser_set_current_name() as well.
<function name="gtk_file_chooser_set_file">
<description>
-Sets @file as the current filename for the file chooser, by changing
-to the file’s parent folder and actually selecting the file in list. If
-the @chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode, the file’s base name
-will also appear in the dialog’s file name entry.
+Sets @file as the current filename for the file chooser.
+
+This includes changing to the file’s parent folder and actually selecting
+the file in list. If the @chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode,
+the file’s base name will also appear in the dialog’s file name entry.
If the file name isn’t in the current folder of @chooser, then the current
folder of @chooser will be changed to the folder containing @filename.
@@ -37297,14 +40168,15 @@ folder of @chooser will be changed to the folder containing @filename.
Note that the file must exist, or nothing will be done except
for the directory change.
-If you are implementing a save dialog,
-you should use this function if you already have a file name to which the
-user may save; for example, when the user opens an existing file and then
-does Save As... If you don’t have
-a file name already — for example, if the user just created a new
-file and is saving it for the first time, do not call this function.
+If you are implementing a save dialog, you should use this function if
+you already have a file name to which the user may save; for example,
+when the user opens an existing file and then does “Save As…”. If you
+don’t have a file name already — for example, if the user just created
+a new file and is saving it for the first time, do not call this function.
+
Instead, use something similar to this:
-|[<!-- language="C" -->
+
+```c
static void
prepare_file_chooser (GtkFileChooser *chooser,
GFile *existing_file)
@@ -37325,17 +40197,17 @@ else
gtk_file_chooser_set_file (chooser, existing_file, NULL);
}
}
-]|
+```
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
<parameter name="file">
-<parameter_description> the #GFile to set as current
+<parameter_description> the `GFile` to set as current
</parameter_description>
</parameter>
<parameter name="error">
@@ -37343,27 +40215,30 @@ gtk_file_chooser_set_file (chooser, existing_file, NULL);
</parameter_description>
</parameter>
</parameters>
-<return> Not useful.
+<return> Not useful
</return>
</function>
<function name="gtk_file_chooser_set_filter">
<description>
-Sets the current filter; only the files that pass the
-filter will be displayed. If the user-selectable list of filters
-is non-empty, then the filter should be one of the filters
-in that list. Setting the current filter when the list of
-filters is empty is useful if you want to restrict the displayed
+Sets the current filter.
+
+Only the files that pass the filter will be displayed.
+If the user-selectable list of filters is non-empty, then
+the filter should be one of the filters in that list.
+
+Setting the current filter when the list of filters is
+empty is useful if you want to restrict the displayed
set of files without letting the user change it.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
<parameter name="filter">
-<parameter_description> a #GtkFileFilter
+<parameter_description> a `GtkFileFilter`
</parameter_description>
</parameter>
</parameters>
@@ -37372,14 +40247,16 @@ set of files without letting the user change it.
<function name="gtk_file_chooser_set_select_multiple">
<description>
-Sets whether multiple files can be selected in the file selector. This is
-only relevant if the action is set to be %GTK_FILE_CHOOSER_ACTION_OPEN or
+Sets whether multiple files can be selected in the file chooser.
+
+This is only relevant if the action is set to be
+%GTK_FILE_CHOOSER_ACTION_OPEN or
%GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter_description> a `GtkFileChooser`
</parameter_description>
</parameter>
<parameter name="select_multiple">
@@ -37392,9 +40269,11 @@ only relevant if the action is set to be %GTK_FILE_CHOOSER_ACTION_OPEN or
<function name="gtk_file_chooser_widget_new">
<description>
-Creates a new #GtkFileChooserWidget. This is a file chooser widget that can
-be embedded in custom windows, and it is the same widget that is used by
-#GtkFileChooserDialog.
+Creates a new `GtkFileChooserWidget`.
+
+This is a file chooser widget that can be embedded in custom
+windows, and it is the same widget that is used by
+`GtkFileChooserDialog`.
</description>
@@ -37404,7 +40283,7 @@ be embedded in custom windows, and it is the same widget that is used by
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkFileChooserWidget
+<return> a new `GtkFileChooserWidget`
</return>
</function>
@@ -37415,7 +40294,7 @@ Adds a rule allowing a given mime type to @filter.
</description>
<parameters>
<parameter name="filter">
-<parameter_description> A #GtkFileFilter
+<parameter_description> A `GtkFileFilter`
</parameter_description>
</parameter>
<parameter name="mime_type">
@@ -37433,7 +40312,7 @@ Adds a rule allowing a shell style glob to a filter.
</description>
<parameters>
<parameter name="filter">
-<parameter_description> a #GtkFileFilter
+<parameter_description> a `GtkFileFilter`
</parameter_description>
</parameter>
<parameter name="pattern">
@@ -37449,13 +40328,13 @@ Adds a rule allowing a shell style glob to a filter.
Adds a rule allowing image files in the formats supported
by GdkPixbuf.
-This is equivalent to calling gtk_file_filter_add_mime_type()
+This is equivalent to calling [method@Gtk.FileFilter.add_mime_type]
for all the supported mime types.
</description>
<parameters>
<parameter name="filter">
-<parameter_description> a #GtkFileFilter
+<parameter_description> a `GtkFileFilter`
</parameter_description>
</parameter>
</parameters>
@@ -37464,18 +40343,18 @@ for all the supported mime types.
<function name="gtk_file_filter_get_attributes">
<description>
-Gets the attributes that need to be filled in for the #GFileInfo
+Gets the attributes that need to be filled in for the `GFileInfo`
passed to this filter.
This function will not typically be used by applications;
it is intended principally for use in the implementation
-of #GtkFileChooser.
+of `GtkFileChooser`.
</description>
<parameters>
<parameter name="filter">
-<parameter_description> a #GtkFileFilter
+<parameter_description> a `GtkFileFilter`
</parameter_description>
</parameter>
</parameters>
@@ -37485,13 +40364,15 @@ of #GtkFileChooser.
<function name="gtk_file_filter_get_name">
<description>
-Gets the human-readable name for the filter. See gtk_file_filter_set_name().
+Gets the human-readable name for the filter.
+
+See [method@Gtk.FileFilter.set_name].
</description>
<parameters>
<parameter name="filter">
-<parameter_description> a #GtkFileFilter
+<parameter_description> a `GtkFileFilter`
</parameter_description>
</parameter>
</parameters>
@@ -37503,54 +40384,58 @@ be modified or freed.
<function name="gtk_file_filter_new">
<description>
-Creates a new #GtkFileFilter with no rules added to it.
+Creates a new `GtkFileFilter` with no rules added to it.
Such a filter doesn’t accept any files, so is not
particularly useful until you add rules with
-gtk_file_filter_add_mime_type(), gtk_file_filter_add_pattern(),
-or gtk_file_filter_add_pixbuf_formats().
+[method@Gtk.FileFilter.add_mime_type],
+[method@Gtk.FileFilter.add_pattern], or
+[method@Gtk.FileFilter.add_pixbuf_formats].
To create a filter that accepts any file, use:
-|[<!-- language="C" -->
+```c
GtkFileFilter *filter = gtk_file_filter_new ();
gtk_file_filter_add_pattern (filter, "*");
-]|
+```
</description>
<parameters>
</parameters>
-<return> a new #GtkFileFilter
+<return> a new `GtkFileFilter`
</return>
</function>
<function name="gtk_file_filter_new_from_gvariant">
<description>
-Deserialize a file filter from an a{sv} variant in
-the format produced by gtk_file_filter_to_gvariant().
+Deserialize a file filter from a `GVariant`.
+
+The variant must be in the format produced by
+[method@Gtk.FileFilter.to_gvariant].
</description>
<parameters>
<parameter name="variant">
-<parameter_description> an a{sv} #GVariant
+<parameter_description> an `a{sv}` `GVariant`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkFileFilter object
+<return> a new `GtkFileFilter` object
</return>
</function>
<function name="gtk_file_filter_set_name">
<description>
-Sets a human-readable name of the filter; this is the string
-that will be displayed in the file chooser if there is a selectable
-list of filters.
+Sets a human-readable name of the filter.
+
+This is the string that will be displayed in the file chooser
+if there is a selectable list of filters.
</description>
<parameters>
<parameter name="filter">
-<parameter_description> a #GtkFileFilter
+<parameter_description> a `GtkFileFilter`
</parameter_description>
</parameter>
<parameter name="name">
@@ -37564,17 +40449,17 @@ to remove any existing name.
<function name="gtk_file_filter_to_gvariant">
<description>
-Serialize a file filter to an a{sv} variant.
+Serialize a file filter to an `a{sv}` variant.
</description>
<parameters>
<parameter name="filter">
-<parameter_description> a #GtkFileFilter
+<parameter_description> a `GtkFileFilter`
</parameter_description>
</parameter>
</parameters>
-<return> a new, floating, #GVariant
+<return> a new, floating, `GVariant`
</return>
</function>
@@ -37628,13 +40513,13 @@ choose to omit implementing it, but #GtkFilterListModel uses it.
<function name="gtk_filter_list_model_get_filter">
<description>
-Gets the #GtkFilter currently set on @self.
+Gets the `GtkFilter` currently set on @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFilterListModel
+<parameter_description> a `GtkFilterListModel`
</parameter_description>
</parameter>
</parameters>
@@ -37645,14 +40530,15 @@ or %NULL if the list isn't filtered
<function name="gtk_filter_list_model_get_incremental">
<description>
-Returns whether incremental filtering was enabled via
-gtk_filter_list_model_set_incremental().
+Returns whether incremental filtering is enabled.
+
+See [method@Gtk.FilterListModel.set_incremental].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFilterListModel
+<parameter_description> a `GtkFilterListModel`
</parameter_description>
</parameter>
</parameters>
@@ -37668,7 +40554,7 @@ Gets the model currently filtered or %NULL if none.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFilterListModel
+<parameter_description> a `GtkFilterListModel`
</parameter_description>
</parameter>
</parameters>
@@ -37685,20 +40571,21 @@ comparing the return value to 0 or you can compute the percentage
of the filter remaining by dividing the return value by the total
number of items in the underlying model:
-|[
+```c
pending = gtk_filter_list_model_get_pending (self);
model = gtk_filter_list_model_get_model (self);
percentage = pending / (double) g_list_model_get_n_items (model);
-]|
+```
If no filter operation is ongoing - in particular when
-#GtkFilterListModel:incremental is %FALSE - this function returns 0.
+[property@Gtk.FilterListModel:incremental] is %FALSE - this
+function returns 0.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFilterListModel
+<parameter_description> a `GtkFilterListModel`
</parameter_description>
</parameter>
</parameters>
@@ -37708,7 +40595,7 @@ If no filter operation is ongoing - in particular when
<function name="gtk_filter_list_model_new">
<description>
-Creates a new #GtkFilterListModel that will filter @model using the given
+Creates a new `GtkFilterListModel` that will filter @model using the given
@filter.
@@ -37723,7 +40610,7 @@ Creates a new #GtkFilterListModel that will filter @model using the given
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkFilterListModel
+<return> a new `GtkFilterListModel`
</return>
</function>
@@ -37734,7 +40621,7 @@ Sets the filter used to filter items.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFilterListModel
+<parameter_description> a `GtkFilterListModel`
</parameter_description>
</parameter>
<parameter name="filter">
@@ -37747,7 +40634,9 @@ Sets the filter used to filter items.
<function name="gtk_filter_list_model_set_incremental">
<description>
-When incremental filtering is enabled, the GtkFilterListModel will not
+Sets the filter model to do an incremental sort.
+
+When incremental filtering is enabled, the `GtkFilterListModel` will not
run filters immediately, but will instead queue an idle handler that
incrementally filters the items and adds them to the list. This of course
means that items are not instantly added to the list, but only appear
@@ -37759,13 +40648,13 @@ interesting around 10,000 to 100,000 items.
By default, incremental filtering is disabled.
-See gtk_filter_list_model_get_pending() for progress information
+See [method@Gtk.FilterListModel.get_pending] for progress information
about an ongoing incremental filtering operation.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFilterListModel
+<parameter_description> a `GtkFilterListModel`
</parameter_description>
</parameter>
<parameter name="incremental">
@@ -37788,7 +40677,7 @@ types match.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFilterListModel
+<parameter_description> a `GtkFilterListModel`
</parameter_description>
</parameter>
<parameter name="model">
@@ -37807,7 +40696,7 @@ Checks if the given @item is matched by the filter or not.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFilter
+<parameter_description> a `GtkFilter`
</parameter_description>
</parameter>
<parameter name="item">
@@ -37822,15 +40711,15 @@ keep it, %FALSE if not.
<function name="gtk_fixed_get_child_position">
<description>
-Retrieves the translation transformation of the given child #GtkWidget
-in the given #GtkFixed container.
+Retrieves the translation transformation of the
+given child `GtkWidget` in the `GtkFixed`.
-See also: gtk_fixed_get_child_transform().
+See also: [method@Gtk.Fixed.get_child_transform].
</description>
<parameters>
<parameter name="fixed">
-<parameter_description> a #GtkFixed
+<parameter_description> a `GtkFixed`
</parameter_description>
</parameter>
<parameter name="widget">
@@ -37858,47 +40747,47 @@ gtk_fixed_set_child_transform().
</description>
<parameters>
<parameter name="fixed">
-<parameter_description> a #GtkFixed
+<parameter_description> a `GtkFixed`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> a #GtkWidget, child of @fixed
+<parameter_description> a `GtkWidget`, child of @fixed
</parameter_description>
</parameter>
</parameters>
-<return> a #GskTransform or %NULL
+<return> a `GskTransform` or %NULL
in case no transform has been set on @widget
</return>
</function>
<function name="gtk_fixed_layout_child_get_transform">
<description>
-Retrieves the transformation of the child of a #GtkFixedLayout.
+Retrieves the transformation of the child.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkFixedLayoutChild
+<parameter_description> a `GtkFixedLayoutChild`
</parameter_description>
</parameter>
</parameters>
-<return> a #GskTransform
+<return> a `GskTransform`
</return>
</function>
<function name="gtk_fixed_layout_child_set_transform">
<description>
-Sets the transformation of the child of a #GtkFixedLayout.
+Sets the transformation of the child of a `GtkFixedLayout`.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkFixedLayoutChild
+<parameter_description> a `GtkFixedLayoutChild`
</parameter_description>
</parameter>
<parameter name="transform">
-<parameter_description> a #GskTransform
+<parameter_description> a `GskTransform`
</parameter_description>
</parameter>
</parameters>
@@ -37907,37 +40796,37 @@ Sets the transformation of the child of a #GtkFixedLayout.
<function name="gtk_fixed_layout_new">
<description>
-Creates a new #GtkFixedLayout.
+Creates a new `GtkFixedLayout`.
</description>
<parameters>
</parameters>
-<return> the newly created #GtkFixedLayout
+<return> the newly created `GtkFixedLayout`
</return>
</function>
<function name="gtk_fixed_move">
<description>
-Sets a translation transformation to the given @x and @y coordinates to
-the child @widget of the given #GtkFixed container.
+Sets a translation transformation to the given @x and @y
+coordinates to the child @widget of the `GtkFixed`.
</description>
<parameters>
<parameter name="fixed">
-<parameter_description> a #GtkFixed.
+<parameter_description> a `GtkFixed`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> the child widget.
+<parameter_description> the child widget
</parameter_description>
</parameter>
<parameter name="x">
-<parameter_description> the horizontal position to move the widget to.
+<parameter_description> the horizontal position to move the widget to
</parameter_description>
</parameter>
<parameter name="y">
-<parameter_description> the vertical position to move the widget to.
+<parameter_description> the vertical position to move the widget to
</parameter_description>
</parameter>
</parameters>
@@ -37946,37 +40835,36 @@ the child @widget of the given #GtkFixed container.
<function name="gtk_fixed_new">
<description>
-Creates a new #GtkFixed.
+Creates a new `GtkFixed`.
</description>
<parameters>
</parameters>
-<return> a new #GtkFixed.
+<return> a new `GtkFixed`.
</return>
</function>
<function name="gtk_fixed_put">
<description>
-Adds a widget to a #GtkFixed container and assigns a translation
-transformation to the given @x and @y coordinates to it.
+Adds a widget to a `GtkFixed` at the given position.
</description>
<parameters>
<parameter name="fixed">
-<parameter_description> a #GtkFixed.
+<parameter_description> a `GtkFixed`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> the widget to add.
+<parameter_description> the widget to add
</parameter_description>
</parameter>
<parameter name="x">
-<parameter_description> the horizontal position to place the widget at.
+<parameter_description> the horizontal position to place the widget at
</parameter_description>
</parameter>
<parameter name="y">
-<parameter_description> the vertical position to place the widget at.
+<parameter_description> the vertical position to place the widget at
</parameter_description>
</parameter>
</parameters>
@@ -37985,13 +40873,12 @@ transformation to the given @x and @y coordinates to it.
<function name="gtk_fixed_remove">
<description>
-Removes a child from @fixed, after it has been added
-with gtk_fixed_put().
+Removes a child from @fixed.
</description>
<parameters>
<parameter name="fixed">
-<parameter_description> a #GtkFixed
+<parameter_description> a `GtkFixed`
</parameter_description>
</parameter>
<parameter name="widget">
@@ -38006,17 +40893,18 @@ with gtk_fixed_put().
<description>
Sets the transformation for @widget.
-This is a convenience function that retrieves the #GtkFixedLayoutChild
-instance associated to @widget and calls gtk_fixed_layout_child_set_transform().
+This is a convenience function that retrieves the
+[class@Gtk.FixedLayoutChild] instance associated to
+@widget and calls [method@Gtk.FixedLayoutChild.set_transform].
</description>
<parameters>
<parameter name="fixed">
-<parameter_description> a #GtkFixed
+<parameter_description> a `GtkFixed`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> a #GtkWidget, child of @fixed
+<parameter_description> a `GtkWidget`, child of @fixed
</parameter_description>
</parameter>
<parameter name="transform">
@@ -38036,7 +40924,7 @@ Gets the model set via gtk_flatten_list_model_set_model().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFlattenListModel
+<parameter_description> a `GtkFlattenListModel`
</parameter_description>
</parameter>
</parameters>
@@ -38052,7 +40940,7 @@ Returns the model containing the item at the given position.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFlattenListModel
+<parameter_description> a `GtkFlattenListModel`
</parameter_description>
</parameter>
<parameter name="position">
@@ -38066,7 +40954,7 @@ Returns the model containing the item at the given position.
<function name="gtk_flatten_list_model_new">
<description>
-Creates a new #GtkFlattenListModel that flattens @list.
+Creates a new `GtkFlattenListModel` that flattens @list.
</description>
@@ -38076,7 +40964,7 @@ Creates a new #GtkFlattenListModel that flattens @list.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkFlattenListModel
+<return> a new `GtkFlattenListModel`
</return>
</function>
@@ -38087,7 +40975,7 @@ Sets a new model to be flattened.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFlattenListModel
+<parameter_description> a `GtkFlattenListModel`
</parameter_description>
</parameter>
<parameter name="model">
@@ -38110,21 +40998,20 @@ represent items from @model. @box is updated whenever @model changes.
If @model is %NULL, @box is left empty.
It is undefined to add or remove widgets directly (for example, with
-gtk_flow_box_insert()) while @box is bound to a
-model.
+[method@Gtk.FlowBox.insert]) while @box is bound to a model.
Note that using a model is incompatible with the filtering and sorting
-functionality in GtkFlowBox. When using a model, filtering and sorting
+functionality in `GtkFlowBox`. When using a model, filtering and sorting
should be implemented by the model.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="model">
-<parameter_description> the #GListModel to be bound to @box
+<parameter_description> the `GListModel` to be bound to @box
</parameter_description>
</parameter>
<parameter name="create_widget_func">
@@ -38146,7 +41033,9 @@ should be implemented by the model.
<function name="gtk_flow_box_child_changed">
<description>
Marks @child as changed, causing any state that depends on this
-to be updated. This affects sorting and filtering.
+to be updated.
+
+This affects sorting and filtering.
Note that calls to this method must be in sync with the data
used for the sorting and filtering functions. For instance, if
@@ -38158,14 +41047,15 @@ children, otherwise the resorting of the children will be wrong.
This generally means that if you don’t fully control the data
model, you have to duplicate the data that affects the sorting
-and filtering functions into the widgets themselves. Another
-alternative is to call gtk_flow_box_invalidate_sort() on any
-model change, but that is more expensive.
+and filtering functions into the widgets themselves.
+
+Another alternative is to call [method@Gtk.FlowBox.invalidate_sort]
+on any model change, but that is more expensive.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkFlowBoxChild
+<parameter_description> a `GtkFlowBoxChild`
</parameter_description>
</parameter>
</parameters>
@@ -38180,7 +41070,7 @@ Gets the child widget of @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFlowBoxChild
+<parameter_description> a `GtkFlowBoxChild`
</parameter_description>
</parameter>
</parameters>
@@ -38190,13 +41080,13 @@ Gets the child widget of @self.
<function name="gtk_flow_box_child_get_index">
<description>
-Gets the current index of the @child in its #GtkFlowBox container.
+Gets the current index of the @child in its `GtkFlowBox` container.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkFlowBoxChild
+<parameter_description> a `GtkFlowBoxChild`
</parameter_description>
</parameter>
</parameters>
@@ -38208,13 +41098,13 @@ in a flow box.
<function name="gtk_flow_box_child_is_selected">
<description>
Returns whether the @child is currently selected in its
-#GtkFlowBox container.
+`GtkFlowBox` container.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkFlowBoxChild
+<parameter_description> a `GtkFlowBoxChild`
</parameter_description>
</parameter>
</parameters>
@@ -38224,14 +41114,15 @@ Returns whether the @child is currently selected in its
<function name="gtk_flow_box_child_new">
<description>
-Creates a new #GtkFlowBoxChild, to be used as a child
-of a #GtkFlowBox.
+Creates a new `GtkFlowBoxChild`.
+
+This should only be used as a child of a `GtkFlowBox`.
</description>
<parameters>
</parameters>
-<return> a new #GtkFlowBoxChild
+<return> a new `GtkFlowBoxChild`
</return>
</function>
@@ -38242,7 +41133,7 @@ Sets the child widget of @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkFlowBoxChild
+<parameter_description> a `GtkFlowBoxChild`
</parameter_description>
</parameter>
<parameter name="child">
@@ -38261,7 +41152,7 @@ Returns whether children activate on single clicks.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
</parameters>
@@ -38278,7 +41169,7 @@ Gets the nth child in the @box.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="idx">
@@ -38287,21 +41178,22 @@ Gets the nth child in the @box.
</parameter>
</parameters>
<return> the child widget, which will
-always be a #GtkFlowBoxChild or %NULL in case no child widget
+always be a `GtkFlowBoxChild` or %NULL in case no child widget
with the given index exists.
</return>
</function>
<function name="gtk_flow_box_get_child_at_pos">
<description>
-Gets the child in the (@x, @y) position. Both @x and @y are
-assumed to be relative to the origin of @box.
+Gets the child in the (@x, @y) position.
+
+Both @x and @y are assumed to be relative to the origin of @box.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="x">
@@ -38314,7 +41206,7 @@ assumed to be relative to the origin of @box.
</parameter>
</parameters>
<return> the child widget, which will
-always be a #GtkFlowBoxChild or %NULL in case no child widget
+always be a `GtkFlowBoxChild` or %NULL in case no child widget
exists for the given x and y coordinates.
</return>
</function>
@@ -38327,7 +41219,7 @@ Gets the horizontal spacing.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
</parameters>
@@ -38337,14 +41229,13 @@ Gets the horizontal spacing.
<function name="gtk_flow_box_get_homogeneous">
<description>
-Returns whether the box is homogeneous (all children are the
-same size). See gtk_box_set_homogeneous().
+Returns whether the box is homogeneous.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
</parameters>
@@ -38360,7 +41251,7 @@ Gets the maximum number of children per line.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
</parameters>
@@ -38376,7 +41267,7 @@ Gets the minimum number of children per line.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
</parameters>
@@ -38392,7 +41283,7 @@ Gets the vertical spacing.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
</parameters>
@@ -38408,12 +41299,12 @@ Creates a list of all selected children.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
</parameters>
<return>
-A #GList containing the #GtkWidget for each selected child.
+A `GList` containing the `GtkWidget` for each selected child.
Free with g_list_free() when done.
</return>
</function>
@@ -38426,11 +41317,11 @@ Gets the selection mode of @box.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkSelectionMode
+<return> the `GtkSelectionMode`
</return>
</function>
@@ -38447,11 +41338,11 @@ in the @box, then the @widget will be appended to the end.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> the #GtkWidget to add
+<parameter_description> the `GtkWidget` to add
</parameter_description>
</parameter>
<parameter name="position">
@@ -38475,7 +41366,7 @@ term, and the entry with the string has changed.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
</parameters>
@@ -38492,7 +41383,7 @@ Call this when the result of the sort function on
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
</parameters>
@@ -38501,13 +41392,13 @@ Call this when the result of the sort function on
<function name="gtk_flow_box_new">
<description>
-Creates a GtkFlowBox.
+Creates a `GtkFlowBox`.
</description>
<parameters>
</parameters>
-<return> a new #GtkFlowBox container
+<return> a new `GtkFlowBox`
</return>
</function>
@@ -38518,7 +41409,7 @@ Removes a child from @box.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="widget">
@@ -38537,7 +41428,7 @@ mode allows it.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
</parameters>
@@ -38552,7 +41443,7 @@ mode allows it.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="child">
@@ -38573,7 +41464,7 @@ this function.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="func">
@@ -38596,7 +41487,7 @@ on them, otherwise you need to double-click.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="single">
@@ -38610,12 +41501,11 @@ on them, otherwise you need to double-click.
<function name="gtk_flow_box_set_column_spacing">
<description>
Sets the horizontal space to add between children.
-See the #GtkFlowBox:column-spacing property.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="spacing">
@@ -38629,21 +41519,23 @@ See the #GtkFlowBox:column-spacing property.
<function name="gtk_flow_box_set_filter_func">
<description>
By setting a filter function on the @box one can decide dynamically
-which of the children to show. For instance, to implement a search
-function that only shows the children matching the search terms.
+which of the children to show.
+
+For instance, to implement a search function that only shows the
+children matching the search terms.
The @filter_func will be called for each child after the call, and
it will continue to be called each time a child changes (via
-gtk_flow_box_child_changed()) or when gtk_flow_box_invalidate_filter()
-is called.
+[method@Gtk.FlowBoxChild.changed]) or when
+[method@Gtk.FlowBox.invalidate_filter] is called.
Note that using a filter function is incompatible with using a model
-(see gtk_flow_box_bind_model()).
+(see [method@Gtk.FlowBox.bind_model]).
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="filter_func">
@@ -38666,10 +41558,11 @@ lets you filter which children to show
<function name="gtk_flow_box_set_hadjustment">
<description>
Hooks up an adjustment to focus handling in @box.
+
The adjustment is also used for autoscrolling during
-rubberband selection. See gtk_scrolled_window_get_hadjustment()
+rubberband selection. See [method@Gtk.ScrolledWindow.get_hadjustment]
for a typical way of obtaining the adjustment, and
-gtk_flow_box_set_vadjustment()for setting the vertical
+[method@Gtk.FlowBox.set_vadjustment] for setting the vertical
adjustment.
The adjustments have to be in pixel units and in the same
@@ -38679,7 +41572,7 @@ of the box.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="adjustment">
@@ -38693,14 +41586,13 @@ when the focus is moved among the descendents of @container
<function name="gtk_flow_box_set_homogeneous">
<description>
-Sets the #GtkFlowBox:homogeneous property of @box, controlling
-whether or not all children of @box are given equal space
-in the box.
+Sets whether or not all children of @box are given
+equal space in the box.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="homogeneous">
@@ -38724,7 +41616,7 @@ than @n_children children long in the given orientation.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="n_children">
@@ -38743,7 +41635,7 @@ in @box’s orientation before flowing.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="n_children">
@@ -38757,12 +41649,11 @@ in @box’s orientation before flowing.
<function name="gtk_flow_box_set_row_spacing">
<description>
Sets the vertical space to add between children.
-See the #GtkFlowBox:row-spacing property.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="spacing">
@@ -38776,12 +41667,11 @@ See the #GtkFlowBox:row-spacing property.
<function name="gtk_flow_box_set_selection_mode">
<description>
Sets how selection works in @box.
-See #GtkSelectionMode for details.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="mode">
@@ -38800,16 +41690,16 @@ the children.
The @sort_func will be called for each child after the call,
and will continue to be called each time a child changes (via
-gtk_flow_box_child_changed()) and when gtk_flow_box_invalidate_sort()
-is called.
+[method@Gtk.FlowBoxChild.changed]) and when
+[method@Gtk.FlowBox.invalidate_sort] is called.
Note that using a sort function is incompatible with using a model
-(see gtk_flow_box_bind_model()).
+(see [method@Gtk.FlowBox.bind_model]).
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="sort_func">
@@ -38831,10 +41721,11 @@ Note that using a sort function is incompatible with using a model
<function name="gtk_flow_box_set_vadjustment">
<description>
Hooks up an adjustment to focus handling in @box.
+
The adjustment is also used for autoscrolling during
-rubberband selection. See gtk_scrolled_window_get_vadjustment()
+rubberband selection. See [method@Gtk.ScrolledWindow.get_vadjustment]
for a typical way of obtaining the adjustment, and
-gtk_flow_box_set_hadjustment()for setting the horizontal
+[method@Gtk.FlowBox.set_hadjustment] for setting the horizontal
adjustment.
The adjustments have to be in pixel units and in the same
@@ -38844,7 +41735,7 @@ of the box.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="adjustment">
@@ -38864,7 +41755,7 @@ mode allows it.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
</parameters>
@@ -38879,7 +41770,7 @@ mode allows it.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkFlowBox
+<parameter_description> a `GtkFlowBox`
</parameter_description>
</parameter>
<parameter name="child">
@@ -38898,7 +41789,7 @@ Gets whether the dialog is modal.
</description>
<parameters>
<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter_description> a `GtkFontButton`
</parameter_description>
</parameter>
</parameters>
@@ -38914,11 +41805,12 @@ Retrieves the title of the font chooser dialog.
</description>
<parameters>
<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter_description> a `GtkFontButton`
</parameter_description>
</parameter>
</parameters>
-<return> an internal copy of the title string which must not be freed.
+<return> an internal copy of the title string
+which must not be freed.
</return>
</function>
@@ -38930,7 +41822,7 @@ Returns whether the selected font is used in the label.
</description>
<parameters>
<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter_description> a `GtkFontButton`
</parameter_description>
</parameter>
</parameters>
@@ -38946,7 +41838,7 @@ Returns whether the selected size is used in the label.
</description>
<parameters>
<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter_description> a `GtkFontButton`
</parameter_description>
</parameter>
</parameters>
@@ -38968,7 +41860,7 @@ Creates a new font picker widget.
<function name="gtk_font_button_new_with_font">
<description>
-Creates a new font picker widget.
+Creates a new font picker widget showing the given font.
</description>
@@ -38989,7 +41881,7 @@ Sets whether the dialog should be modal.
</description>
<parameters>
<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter_description> a `GtkFontButton`
</parameter_description>
</parameter>
<parameter name="modal">
@@ -39002,12 +41894,12 @@ Sets whether the dialog should be modal.
<function name="gtk_font_button_set_title">
<description>
-Sets the title for the font chooser dialog.
+Sets the title for the font chooser dialog.
</description>
<parameters>
<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter_description> a `GtkFontButton`
</parameter_description>
</parameter>
<parameter name="title">
@@ -39020,12 +41912,13 @@ Sets the title for the font chooser dialog.
<function name="gtk_font_button_set_use_font">
<description>
-If @use_font is %TRUE, the font name will be written using the selected font.
+If @use_font is %TRUE, the font name will be written
+using the selected font.
</description>
<parameters>
<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter_description> a `GtkFontButton`
</parameter_description>
</parameter>
<parameter name="use_font">
@@ -39038,16 +41931,18 @@ If @use_font is %TRUE, the font name will be written using the selected font.
<function name="gtk_font_button_set_use_size">
<description>
-If @use_size is %TRUE, the font name will be written using the selected size.
+If @use_size is %TRUE, the font name will be written using
+the selected size.
</description>
<parameters>
<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter_description> a `GtkFontButton`
</parameter_description>
</parameter>
<parameter name="use_size">
-<parameter_description> If %TRUE, font name will be written using the selected size.
+<parameter_description> If %TRUE, font name will be written using the
+selected size.
</parameter_description>
</parameter>
</parameters>
@@ -39056,7 +41951,7 @@ If @use_size is %TRUE, the font name will be written using the selected size.
<function name="gtk_font_chooser_dialog_new">
<description>
-Creates a new #GtkFontChooserDialog.
+Creates a new `GtkFontChooserDialog`.
</description>
@@ -39070,7 +41965,7 @@ Creates a new #GtkFontChooserDialog.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkFontChooserDialog
+<return> a new `GtkFontChooserDialog`
</return>
</function>
@@ -39079,19 +41974,19 @@ Creates a new #GtkFontChooserDialog.
Gets the currently-selected font name.
Note that this can be a different string than what you set with
-gtk_font_chooser_set_font(), as the font chooser widget may
+[method@Gtk.FontChooser.set_font], as the font chooser widget may
normalize font names and thus return a string with a different
structure. For example, “Helvetica Italic Bold 12” could be
normalized to “Helvetica Bold Italic 12”.
-Use pango_font_description_equal() if you want to compare two
+Use [method@Pango.FontDescription.equal] if you want to compare two
font descriptions.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
</parameters>
@@ -39106,30 +42001,30 @@ free this string with g_free().
Gets the currently-selected font.
Note that this can be a different string than what you set with
-gtk_font_chooser_set_font(), as the font chooser widget may
+[method@Gtk.FontChooser.set_font], as the font chooser widget may
normalize font names and thus return a string with a different
structure. For example, “Helvetica Italic Bold 12” could be
normalized to “Helvetica Bold Italic 12”.
-Use pango_font_description_equal() if you want to compare two
+Use [method@Pango.FontDescription.equal] if you want to compare two
font descriptions.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
</parameters>
-<return> A #PangoFontDescription for the
+<return> A `PangoFontDescription` for the
current font, or %NULL if no font is selected.
</return>
</function>
<function name="gtk_font_chooser_get_font_face">
<description>
-Gets the #PangoFontFace representing the selected font group
+Gets the `PangoFontFace` representing the selected font group
details (i.e. family, slant, weight, width, etc).
If the selected font is not installed, returns %NULL.
@@ -39138,11 +42033,11 @@ If the selected font is not installed, returns %NULL.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
</parameters>
-<return> A #PangoFontFace representing the
+<return> A `PangoFontFace` representing the
selected font group details, or %NULL. The returned object is owned by
@fontchooser and must not be modified or freed.
</return>
@@ -39150,7 +42045,8 @@ selected font group details, or %NULL. The returned object is owned by
<function name="gtk_font_chooser_get_font_family">
<description>
-Gets the #PangoFontFamily representing the selected font family.
+Gets the `PangoFontFamily` representing the selected font family.
+
Font families are a collection of font faces.
If the selected font is not installed, returns %NULL.
@@ -39159,11 +42055,11 @@ If the selected font is not installed, returns %NULL.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
</parameters>
-<return> A #PangoFontFamily representing the
+<return> A `PangoFontFamily` representing the
selected font family, or %NULL. The returned object is owned by @fontchooser
and must not be modified or freed.
</return>
@@ -39177,7 +42073,7 @@ Gets the currently-selected font features.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
</parameters>
@@ -39194,11 +42090,11 @@ or %NULL if it does not have one.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
</parameters>
-<return> a #PangoFontMap, or %NULL
+<return> a `PangoFontMap`, or %NULL
</return>
</function>
@@ -39210,7 +42106,7 @@ The selected font size.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
</parameters>
@@ -39227,7 +42123,7 @@ Gets the language that is used for font features.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
</parameters>
@@ -39243,7 +42139,7 @@ Returns the current level of granularity for selecting fonts.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
</parameters>
@@ -39259,12 +42155,11 @@ Gets the text displayed in the preview area.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
</parameters>
-<return> the text displayed in the
-preview area
+<return> the text displayed in the preview area
</return>
</function>
@@ -39276,12 +42171,11 @@ Returns whether the preview entry is shown or not.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the preview entry is shown
-or %FALSE if it is hidden.
+<return> %TRUE if the preview entry is shown or %FALSE if it is hidden.
</return>
</function>
@@ -39293,11 +42187,11 @@ in the font chooser.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
<parameter name="filter">
-<parameter_description> a #GtkFontFilterFunc, or %NULL
+<parameter_description> a `GtkFontFilterFunc`, or %NULL
</parameter_description>
</parameter>
<parameter name="user_data">
@@ -39319,7 +42213,7 @@ Sets the currently-selected font.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
<parameter name="fontname">
@@ -39337,11 +42231,11 @@ Sets the currently-selected font from @font_desc.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
<parameter name="font_desc">
-<parameter_description> a #PangoFontDescription
+<parameter_description> a `PangoFontDescription`
</parameter_description>
</parameter>
</parameters>
@@ -39351,10 +42245,11 @@ Sets the currently-selected font from @font_desc.
<function name="gtk_font_chooser_set_font_map">
<description>
Sets a custom font map to use for this font chooser widget.
+
A custom font map can be used to present application-specific
fonts instead of or in addition to the normal system fonts.
-|[<!-- language="C" -->
+```c
FcConfig *config;
PangoFontMap *fontmap;
@@ -39365,24 +42260,24 @@ fontmap = pango_cairo_font_map_new_for_font_type (CAIRO_FONT_TYPE_FT);
pango_fc_font_map_set_config (PANGO_FC_FONT_MAP (fontmap), config);
gtk_font_chooser_set_font_map (font_chooser, fontmap);
-]|
+```
-Note that other GTK widgets will only be able to use the application-specific
-font if it is present in the font map they use:
+Note that other GTK widgets will only be able to use the
+application-specific font if it is present in the font map they use:
-|[
+```c
context = gtk_widget_get_pango_context (label);
pango_context_set_font_map (context, fontmap);
-]|
+```
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
<parameter name="fontmap">
-<parameter_description> a #PangoFontMap
+<parameter_description> a `PangoFontMap`
</parameter_description>
</parameter>
</parameters>
@@ -39396,7 +42291,7 @@ Sets the language to use for font features.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
<parameter name="language">
@@ -39414,7 +42309,7 @@ Sets the desired level of granularity for selecting fonts.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
<parameter name="level">
@@ -39428,12 +42323,13 @@ Sets the desired level of granularity for selecting fonts.
<function name="gtk_font_chooser_set_preview_text">
<description>
Sets the text displayed in the preview area.
+
The @text is used to show how the selected font looks.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
<parameter name="text">
@@ -39451,7 +42347,7 @@ Shows or hides the editable preview entry.
</description>
<parameters>
<parameter name="fontchooser">
-<parameter_description> a #GtkFontChooser
+<parameter_description> a `GtkFontChooser`
</parameter_description>
</parameter>
<parameter name="show_preview_entry">
@@ -39464,13 +42360,13 @@ Shows or hides the editable preview entry.
<function name="gtk_font_chooser_widget_new">
<description>
-Creates a new #GtkFontChooserWidget.
+Creates a new `GtkFontChooserWidget`.
</description>
<parameters>
</parameters>
-<return> a new #GtkFontChooserWidget
+<return> a new `GtkFontChooserWidget`
</return>
</function>
@@ -39482,7 +42378,7 @@ Gets the child widget of @frame.
</description>
<parameters>
<parameter name="frame">
-<parameter_description> a #GtkFrame
+<parameter_description> a `GtkFrame`
</parameter_description>
</parameter>
</parameters>
@@ -39492,51 +42388,50 @@ Gets the child widget of @frame.
<function name="gtk_frame_get_label">
<description>
-If the frame’s label widget is a #GtkLabel, returns the
-text in the label widget. (The frame will have a #GtkLabel
-for the label widget if a non-%NULL argument was passed
-to gtk_frame_new().)
+Returns the frame labels text.
+
+If the frame's label widget is not a `GtkLabel`, %NULL
+is returned.
</description>
<parameters>
<parameter name="frame">
-<parameter_description> a #GtkFrame
+<parameter_description> a `GtkFrame`
</parameter_description>
</parameter>
</parameters>
<return> the text in the label, or %NULL if there
-was no label widget or the label widget was not
-a #GtkLabel. This string is owned by GTK+ and
-must not be modified or freed.
+was no label widget or the label widget was not a `GtkLabel`.
+This string is owned by GTK and must not be modified or freed.
</return>
</function>
<function name="gtk_frame_get_label_align">
<description>
-Retrieves the X alignment of the frame’s label. See
-gtk_frame_set_label_align().
+Retrieves the X alignment of the frame’s label.
+
</description>
<parameters>
<parameter name="frame">
-<parameter_description> a #GtkFrame
+<parameter_description> a `GtkFrame`
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the frames X alignment
+</return>
</function>
<function name="gtk_frame_get_label_widget">
<description>
-Retrieves the label widget for the frame. See
-gtk_frame_set_label_widget().
+Retrieves the label widget for the frame.
</description>
<parameters>
<parameter name="frame">
-<parameter_description> a #GtkFrame
+<parameter_description> a `GtkFrame`
</parameter_description>
</parameter>
</parameters>
@@ -39547,7 +42442,8 @@ there is none.
<function name="gtk_frame_new">
<description>
-Creates a new #GtkFrame, with optional label @label.
+Creates a new `GtkFrame`, with optional label @label.
+
If @label is %NULL, the label is omitted.
@@ -39558,7 +42454,7 @@ If @label is %NULL, the label is omitted.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkFrame widget
+<return> a new `GtkFrame` widget
</return>
</function>
@@ -39569,7 +42465,7 @@ Sets the child widget of @frame.
</description>
<parameters>
<parameter name="frame">
-<parameter_description> a #GtkFrame
+<parameter_description> a `GtkFrame`
</parameter_description>
</parameter>
<parameter name="child">
@@ -39582,13 +42478,13 @@ Sets the child widget of @frame.
<function name="gtk_frame_set_label">
<description>
-Removes the current #GtkFrame:label-widget. If @label is not %NULL, creates a
-new #GtkLabel with that text and adds it as the #GtkFrame:label-widget.
+Creates a new `GtkLabel` with the @label and sets it as the frame's
+label widget.
</description>
<parameters>
<parameter name="frame">
-<parameter_description> a #GtkFrame
+<parameter_description> a `GtkFrame`
</parameter_description>
</parameter>
<parameter name="label">
@@ -39601,13 +42497,14 @@ new #GtkLabel with that text and adds it as the #GtkFrame:label-widget.
<function name="gtk_frame_set_label_align">
<description>
-Sets the X alignment of the frame widget’s label. The
-default value for a newly created frame is 0.0.
+Sets the X alignment of the frame widget’s label.
+
+The default value for a newly created frame is 0.0.
</description>
<parameters>
<parameter name="frame">
-<parameter_description> a #GtkFrame
+<parameter_description> a `GtkFrame`
</parameter_description>
</parameter>
<parameter name="xalign">
@@ -39622,13 +42519,15 @@ of the widget. A value of 0.0 represents left alignment;
<function name="gtk_frame_set_label_widget">
<description>
-Sets the #GtkFrame:label-widget for the frame. This is the widget that
-will appear embedded in the top edge of the frame as a title.
+Sets the label widget for the frame.
+
+This is the widget that will appear embedded in the top edge
+of the frame as a title.
</description>
<parameters>
<parameter name="frame">
-<parameter_description> a #GtkFrame
+<parameter_description> a `GtkFrame`
</parameter_description>
</parameter>
<parameter name="label_widget">
@@ -39641,19 +42540,21 @@ will appear embedded in the top edge of the frame as a title.
<function name="gtk_gesture_click_new">
<description>
-Returns a newly created #GtkGesture that recognizes single and multiple
-presses.
+Returns a newly created `GtkGesture` that recognizes
+single and multiple presses.
</description>
<parameters>
</parameters>
-<return> a newly created #GtkGestureClick
+<return> a newly created `GtkGestureClick`
</return>
</function>
<function name="gtk_gesture_drag_get_offset">
<description>
+Gets the offset from the start point.
+
If the @gesture is active, this function returns %TRUE and
fills in @x and @y with the coordinates of the current point,
as an offset to the starting drag point.
@@ -39680,15 +42581,17 @@ as an offset to the starting drag point.
<function name="gtk_gesture_drag_get_start_point">
<description>
+Gets the point where the drag started.
+
If the @gesture is active, this function returns %TRUE
and fills in @x and @y with the drag start coordinates,
-in window-relative coordinates.
+in surface-relative coordinates.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
<parameter name="x">
@@ -39706,22 +42609,23 @@ in window-relative coordinates.
<function name="gtk_gesture_drag_new">
<description>
-Returns a newly created #GtkGesture that recognizes drags.
+Returns a newly created `GtkGesture` that recognizes drags.
</description>
<parameters>
</parameters>
-<return> a newly created #GtkGestureDrag
+<return> a newly created `GtkGestureDrag`
</return>
</function>
<function name="gtk_gesture_get_bounding_box">
<description>
If there are touch sequences being currently handled by @gesture,
-this function returns %TRUE and fills in @rect with the bounding
-box containing all active touches. Otherwise, %FALSE will be
-returned.
+returns %TRUE and fills in @rect with the bounding box containing
+all active touches.
+
+Otherwise, %FALSE will be returned.
Note: This function will yield unexpected results on touchpad
gestures. Since there is no correlation between physical and
@@ -39733,7 +42637,7 @@ regardless of the number of touchpoints.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
<parameter name="rect">
@@ -39748,15 +42652,16 @@ regardless of the number of touchpoints.
<function name="gtk_gesture_get_bounding_box_center">
<description>
If there are touch sequences being currently handled by @gesture,
-this function returns %TRUE and fills in @x and @y with the center
-of the bounding box containing all active touches. Otherwise, %FALSE
-will be returned.
+returns %TRUE and fills in @x and @y with the center of the bounding
+box containing all active touches.
+
+Otherwise, %FALSE will be returned.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
<parameter name="x">
@@ -39774,18 +42679,20 @@ will be returned.
<function name="gtk_gesture_get_device">
<description>
-Returns the logical #GdkDevice that is currently operating
-on @gesture, or %NULL if the gesture is not being interacted.
+Returns the logical `GdkDevice` that is currently operating
+on @gesture.
+
+This returns %NULL if the gesture is not being interacted.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDevice, or %NULL
+<return> a `GdkDevice`, or %NULL
</return>
</function>
@@ -39797,12 +42704,12 @@ Returns all gestures in the group of @gesture
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
</parameters>
<return> The list
-of #GtkGestures, free with g_list_free()
+of `GtkGesture`s, free with g_list_free()
</return>
</function>
@@ -39810,19 +42717,19 @@ of #GtkGestures, free with g_list_free()
<description>
Returns the last event that was processed for @sequence.
-Note that the returned pointer is only valid as long as the @sequence
-is still interpreted by the @gesture. If in doubt, you should make
-a copy of the event.
+Note that the returned pointer is only valid as long as the
+@sequence is still interpreted by the @gesture. If in doubt,
+you should make a copy of the event.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
<parameter name="sequence">
-<parameter_description> a #GdkEventSequence
+<parameter_description> a `GdkEventSequence`
</parameter_description>
</parameter>
</parameters>
@@ -39832,13 +42739,13 @@ a copy of the event.
<function name="gtk_gesture_get_last_updated_sequence">
<description>
-Returns the #GdkEventSequence that was last updated on @gesture.
+Returns the `GdkEventSequence` that was last updated on @gesture.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
</parameters>
@@ -39848,20 +42755,21 @@ Returns the #GdkEventSequence that was last updated on @gesture.
<function name="gtk_gesture_get_point">
<description>
-If @sequence is currently being interpreted by @gesture, this
-function returns %TRUE and fills in @x and @y with the last coordinates
-stored for that event sequence. The coordinates are always relative to the
-widget allocation.
+If @sequence is currently being interpreted by @gesture,
+returns %TRUE and fills in @x and @y with the last coordinates
+stored for that event sequence.
+
+The coordinates are always relative to the widget allocation.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
<parameter name="sequence">
-<parameter_description> a #GdkEventSequence, or %NULL for pointer events
+<parameter_description> a `GdkEventSequence`, or %NULL for pointer events
</parameter_description>
</parameter>
<parameter name="x">
@@ -39885,7 +42793,7 @@ Returns the @sequence state, as seen by @gesture.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
<parameter name="sequence">
@@ -39899,49 +42807,52 @@ Returns the @sequence state, as seen by @gesture.
<function name="gtk_gesture_get_sequences">
<description>
-Returns the list of #GdkEventSequences currently being interpreted
+Returns the list of `GdkEventSequences` currently being interpreted
by @gesture.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
</parameters>
<return> A list
-of #GdkEventSequences, the list elements are owned by GTK
-and must not be freed or modified, the list itself must be deleted
+of `GdkEventSequence`, the list elements are owned by GTK and must
+not be freed or modified, the list itself must be deleted
through g_list_free()
</return>
</function>
<function name="gtk_gesture_group">
<description>
-Adds @gesture to the same group than @group_gesture. Gestures
-are by default isolated in their own groups.
+Adds @gesture to the same group than @group_gesture.
-Both gestures must have been added to the same widget before they
-can be grouped.
+Gestures are by default isolated in their own groups.
-When gestures are grouped, the state of #GdkEventSequences
-is kept in sync for all of those, so calling gtk_gesture_set_sequence_state(),
-on one will transfer the same value to the others.
+Both gestures must have been added to the same widget before
+they can be grouped.
+
+When gestures are grouped, the state of `GdkEventSequences`
+is kept in sync for all of those, so calling
+[method@Gtk.Gesture.set_sequence_state], on one will transfer
+the same value to the others.
Groups also perform an "implicit grabbing" of sequences, if a
-#GdkEventSequence state is set to #GTK_EVENT_SEQUENCE_CLAIMED on one group,
-every other gesture group attached to the same #GtkWidget will switch the
-state for that sequence to #GTK_EVENT_SEQUENCE_DENIED.
+`GdkEventSequence` state is set to %GTK_EVENT_SEQUENCE_CLAIMED
+on one group, every other gesture group attached to the same
+`GtkWidget` will switch the state for that sequence to
+%GTK_EVENT_SEQUENCE_DENIED.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
<parameter name="group_gesture">
-<parameter_description> #GtkGesture to group @gesture with
+<parameter_description> `GtkGesture` to group @gesture with
</parameter_description>
</parameter>
</parameters>
@@ -39950,18 +42861,18 @@ state for that sequence to #GTK_EVENT_SEQUENCE_DENIED.
<function name="gtk_gesture_handles_sequence">
<description>
-Returns %TRUE if @gesture is currently handling events corresponding to
-@sequence.
+Returns %TRUE if @gesture is currently handling events
+corresponding to @sequence.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
<parameter name="sequence">
-<parameter_description> a #GdkEventSequence or %NULL
+<parameter_description> a `GdkEventSequence` or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -39972,14 +42883,15 @@ Returns %TRUE if @gesture is currently handling events corresponding to
<function name="gtk_gesture_is_active">
<description>
Returns %TRUE if the gesture is currently active.
-A gesture is active meanwhile there are touch sequences
+
+A gesture is active while there are touch sequences
interacting with it.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
</parameters>
@@ -39995,11 +42907,11 @@ Returns %TRUE if both gestures pertain to the same group.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
<parameter name="other">
-<parameter_description> another #GtkGesture
+<parameter_description> another `GtkGesture`
</parameter_description>
</parameter>
</parameters>
@@ -40010,6 +42922,7 @@ Returns %TRUE if both gestures pertain to the same group.
<function name="gtk_gesture_is_recognized">
<description>
Returns %TRUE if the gesture is currently recognized.
+
A gesture is recognized if there are as many interacting
touch sequences as required by @gesture.
@@ -40017,7 +42930,7 @@ touch sequences as required by @gesture.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
</parameters>
@@ -40027,13 +42940,13 @@ touch sequences as required by @gesture.
<function name="gtk_gesture_long_press_get_delay_factor">
<description>
-Returns the delay factor as set by gtk_gesture_long_press_set_delay_factor().
+Returns the delay factor.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> A #GtkGestureLongPress
+<parameter_description> A `GtkGestureLongPress`
</parameter_description>
</parameter>
</parameters>
@@ -40043,25 +42956,27 @@ Returns the delay factor as set by gtk_gesture_long_press_set_delay_factor().
<function name="gtk_gesture_long_press_new">
<description>
-Returns a newly created #GtkGesture that recognizes long presses.
+Returns a newly created `GtkGesture` that recognizes long presses.
</description>
<parameters>
</parameters>
-<return> a newly created #GtkGestureLongPress
+<return> a newly created `GtkGestureLongPress`.
</return>
</function>
<function name="gtk_gesture_long_press_set_delay_factor">
<description>
-Applies the given delay factor. The default long press time will be
-multiplied by this value. Valid values are in the range [0.5..2.0].
+Applies the given delay factor.
+
+The default long press time will be multiplied by this value.
+Valid values are in the range [0.5..2.0].
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> A #GtkGestureLongPress
+<parameter_description> A `GtkGestureLongPress`
</parameter_description>
</parameter>
<parameter name="delay_factor">
@@ -40080,7 +42995,7 @@ Returns the orientation of the pan gestures that this @gesture expects.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> A #GtkGesturePan
+<parameter_description> A `GtkGesturePan`
</parameter_description>
</parameter>
</parameters>
@@ -40090,7 +43005,7 @@ Returns the orientation of the pan gestures that this @gesture expects.
<function name="gtk_gesture_pan_new">
<description>
-Returns a newly created #GtkGesture that recognizes pan gestures.
+Returns a newly created `GtkGesture` that recognizes pan gestures.
</description>
@@ -40100,7 +43015,7 @@ Returns a newly created #GtkGesture that recognizes pan gestures.
</parameter_description>
</parameter>
</parameters>
-<return> a newly created #GtkGesturePan
+<return> a newly created `GtkGesturePan`
</return>
</function>
@@ -40111,7 +43026,7 @@ Sets the orientation to be expected on pan gestures.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> A #GtkGesturePan
+<parameter_description> A `GtkGesturePan`
</parameter_description>
</parameter>
<parameter name="orientation">
@@ -40124,6 +43039,8 @@ Sets the orientation to be expected on pan gestures.
<function name="gtk_gesture_rotate_get_angle_delta">
<description>
+Gets the angle delta in radians.
+
If @gesture is active, this function returns the angle difference
in radians since the gesture was first recognized. If @gesture is
not active, 0 is returned.
@@ -40132,7 +43049,7 @@ not active, 0 is returned.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGestureRotate
+<parameter_description> a `GtkGestureRotate`
</parameter_description>
</parameter>
</parameters>
@@ -40142,38 +43059,38 @@ not active, 0 is returned.
<function name="gtk_gesture_rotate_new">
<description>
-Returns a newly created #GtkGesture that recognizes 2-touch
+Returns a newly created `GtkGesture` that recognizes 2-touch
rotation gestures.
</description>
<parameters>
</parameters>
-<return> a newly created #GtkGestureRotate
+<return> a newly created `GtkGestureRotate`
</return>
</function>
<function name="gtk_gesture_set_sequence_state">
<description>
-Sets the state of @sequence in @gesture. Sequences start
-in state #GTK_EVENT_SEQUENCE_NONE, and whenever they change
-state, they can never go back to that state. Likewise,
-sequences in state #GTK_EVENT_SEQUENCE_DENIED cannot turn
-back to a not denied state. With these rules, the lifetime
-of an event sequence is constrained to the next four:
+Sets the state of @sequence in @gesture.
+
+Sequences start in state %GTK_EVENT_SEQUENCE_NONE, and whenever
+they change state, they can never go back to that state. Likewise,
+sequences in state %GTK_EVENT_SEQUENCE_DENIED cannot turn back to
+a not denied state. With these rules, the lifetime of an event
+sequence is constrained to the next four:
* None
* None → Denied
* None → Claimed
* None → Claimed → Denied
-Note: Due to event handling ordering, it may be unsafe to
-set the state on another gesture within a #GtkGesture::begin
-signal handler, as the callback might be executed before
-the other gesture knows about the sequence. A safe way to
-perform this could be:
+Note: Due to event handling ordering, it may be unsafe to set the
+state on another gesture within a [signal@Gtk.Gesture::begin] signal
+handler, as the callback might be executed before the other gesture
+knows about the sequence. A safe way to perform this could be:
-|[
+```c
static void
first_gesture_begin_cb (GtkGesture *first_gesture,
GdkEventSequence *sequence,
@@ -40191,7 +43108,7 @@ gpointer user_data)
if (gtk_gesture_get_sequence_state (first_gesture, sequence) == GTK_EVENT_SEQUENCE_CLAIMED)
gtk_gesture_set_sequence_state (second_gesture, sequence, GTK_EVENT_SEQUENCE_DENIED);
}
-]|
+```
If both gestures are in the same group, just set the state on
the gesture emitting the event, the sequence will be already
@@ -40202,11 +43119,11 @@ gesture processes the event.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
<parameter name="sequence">
-<parameter_description> a #GdkEventSequence
+<parameter_description> a `GdkEventSequence`
</parameter_description>
</parameter>
<parameter name="state">
@@ -40222,14 +43139,16 @@ and the state is changed successfully
<function name="gtk_gesture_set_state">
<description>
Sets the state of all sequences that @gesture is currently
-interacting with. See gtk_gesture_set_sequence_state()
-for more details on sequence states.
+interacting with.
+
+See [method@Gtk.Gesture.set_sequence_state] for more details
+on sequence states.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
<parameter name="state">
@@ -40244,14 +43163,15 @@ was changed successfully
<function name="gtk_gesture_single_get_button">
<description>
-Returns the button number @gesture listens for, or 0 if @gesture
-reacts to any button press.
+Returns the button number @gesture listens for.
+
+If this is 0, the gesture reacts to any button press.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGestureSingle
+<parameter_description> a `GtkGestureSingle`
</parameter_description>
</parameter>
</parameters>
@@ -40261,14 +43181,14 @@ reacts to any button press.
<function name="gtk_gesture_single_get_current_button">
<description>
-Returns the button number currently interacting with @gesture, or 0 if there
-is none.
+Returns the button number currently interacting
+with @gesture, or 0 if there is none.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGestureSingle
+<parameter_description> a `GtkGestureSingle`
</parameter_description>
</parameter>
</parameters>
@@ -40279,13 +43199,15 @@ is none.
<function name="gtk_gesture_single_get_current_sequence">
<description>
Returns the event sequence currently interacting with @gesture.
-This is only meaningful if gtk_gesture_is_active() returns %TRUE.
+
+This is only meaningful if [method@Gtk.Gesture.is_active]
+returns %TRUE.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGestureSingle
+<parameter_description> a `GtkGestureSingle`
</parameter_description>
</parameter>
</parameters>
@@ -40295,14 +43217,15 @@ This is only meaningful if gtk_gesture_is_active() returns %TRUE.
<function name="gtk_gesture_single_get_exclusive">
<description>
-Gets whether a gesture is exclusive. For more information, see
-gtk_gesture_single_set_exclusive().
+Gets whether a gesture is exclusive.
+
+For more information, see [method@Gtk.GestureSingle.set_exclusive].
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGestureSingle
+<parameter_description> a `GtkGestureSingle`
</parameter_description>
</parameter>
</parameters>
@@ -40318,7 +43241,7 @@ Returns %TRUE if the gesture is only triggered by touch events.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGestureSingle
+<parameter_description> a `GtkGestureSingle`
</parameter_description>
</parameter>
</parameters>
@@ -40328,14 +43251,16 @@ Returns %TRUE if the gesture is only triggered by touch events.
<function name="gtk_gesture_single_set_button">
<description>
-Sets the button number @gesture listens to. If non-0, every
-button press from a different button number will be ignored.
-Touch events implicitly match with button 1.
+Sets the button number @gesture listens to.
+
+If non-0, every button press from a different button
+number will be ignored. Touch events implicitly match
+with button 1.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGestureSingle
+<parameter_description> a `GtkGestureSingle`
</parameter_description>
</parameter>
<parameter name="button">
@@ -40348,15 +43273,16 @@ Touch events implicitly match with button 1.
<function name="gtk_gesture_single_set_exclusive">
<description>
-Sets whether @gesture is exclusive. An exclusive gesture will
-only handle pointer and "pointer emulated" touch events, so at
-any given time, there is only one sequence able to interact with
-those.
+Sets whether @gesture is exclusive.
+
+An exclusive gesture will only handle pointer and "pointer emulated"
+touch events, so at any given time, there is only one sequence able
+to interact with those.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGestureSingle
+<parameter_description> a `GtkGestureSingle`
</parameter_description>
</parameter>
<parameter name="exclusive">
@@ -40369,14 +43295,16 @@ those.
<function name="gtk_gesture_single_set_touch_only">
<description>
+Sets whether to handle only touch events.
+
If @touch_only is %TRUE, @gesture will only handle events of type
-#GDK_TOUCH_BEGIN, #GDK_TOUCH_UPDATE or #GDK_TOUCH_END. If %FALSE,
+%GDK_TOUCH_BEGIN, %GDK_TOUCH_UPDATE or %GDK_TOUCH_END. If %FALSE,
mouse events will be handled too.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGestureSingle
+<parameter_description> a `GtkGestureSingle`
</parameter_description>
</parameter>
<parameter name="touch_only">
@@ -40389,20 +43317,22 @@ mouse events will be handled too.
<function name="gtk_gesture_stylus_get_axes">
<description>
-Returns the current values for the requested @axes. This function
-must be called from either the #GtkGestureStylus::down,
-#GtkGestureStylus::motion, #GtkGestureStylus::up or #GtkGestureStylus::proximity
+Returns the current values for the requested @axes.
+
+This function must be called from the handler of one of the
+[signal@Gtk.GestureStylus::down], [signal@Gtk.GestureStylus::motion],
+[signal@Gtk.GestureStylus::up] or [signal@Gtk.GestureStylus::proximity]
signals.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a GtkGestureStylus
+<parameter_description> a `GtkGestureStylus`
</parameter_description>
</parameter>
<parameter name="axes">
-<parameter_description> array of requested axes, terminated with #GDK_AXIS_IGNORE
+<parameter_description> array of requested axes, terminated with %GDK_AXIS_IGNORE
</parameter_description>
</parameter>
<parameter name="values">
@@ -40419,14 +43349,15 @@ signals.
Returns the current value for the requested @axis.
This function must be called from the handler of one of the
-#GtkGestureStylus::down, #GtkGestureStylus::motion,
-#GtkGestureStylus::up or #GtkGestureStylus::proximity signals.
+[signal@Gtk.GestureStylus::down], [signal@Gtk.GestureStylus::motion],
+[signal@Gtk.GestureStylus::up] or [signal@Gtk.GestureStylus::proximity]
+signals.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGestureStylus
+<parameter_description> a `GtkGestureStylus`
</parameter_description>
</parameter>
<parameter name="axis">
@@ -40444,14 +43375,16 @@ This function must be called from the handler of one of the
<function name="gtk_gesture_stylus_get_backlog">
<description>
-By default, GTK will limit rate of input events. On stylus input where
-accuracy of strokes is paramount, this function returns the accumulated
-coordinate/timing state before the emission of the current
-#GtkGestureStylus::motion signal.
+Returns the accumulated backlog of tracking information.
-This function may only be called within a #GtkGestureStylus::motion
+By default, GTK will limit rate of input events. On stylus input
+where accuracy of strokes is paramount, this function returns the
+accumulated coordinate/timing state before the emission of the
+current [Gtk.GestureStylus::motion] signal.
+
+This function may only be called within a [signal@Gtk.GestureStylus::motion]
signal handler, the state given in this signal and obtainable through
-gtk_gesture_stylus_get_axis() call express the latest (most up-to-date)
+[method@Gtk.GestureStylus.get_axis] express the latest (most up-to-date)
state in motion history.
The @backlog is provided in chronological order.
@@ -40460,7 +43393,7 @@ The @backlog is provided in chronological order.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGestureStylus
+<parameter_description> a `GtkGestureStylus`
</parameter_description>
</parameter>
<parameter name="backlog">
@@ -40478,16 +43411,18 @@ The @backlog is provided in chronological order.
<function name="gtk_gesture_stylus_get_device_tool">
<description>
-Returns the #GdkDeviceTool currently driving input through this gesture.
-This function must be called from either the #GtkGestureStylus::down,
-#GtkGestureStylus::motion, #GtkGestureStylus::up or #GtkGestureStylus::proximity
-signal handlers.
+Returns the `GdkDeviceTool` currently driving input through this gesture.
+
+This function must be called from the handler of one of the
+[signal@Gtk.GestureStylus::down], [signal@Gtk.GestureStylus::motion],
+[signal@Gtk.GestureStylus::up] or [signal@Gtk.GestureStylus::proximity]
+signals.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGestureStylus
+<parameter_description> a `GtkGestureStylus`
</parameter_description>
</parameter>
</parameters>
@@ -40497,7 +43432,7 @@ signal handlers.
<function name="gtk_gesture_stylus_new">
<description>
-Creates a new #GtkGestureStylus.
+Creates a new `GtkGestureStylus`.
</description>
@@ -40509,15 +43444,17 @@ Creates a new #GtkGestureStylus.
<function name="gtk_gesture_swipe_get_velocity">
<description>
-If the gesture is recognized, this function returns %TRUE and fill in
-@velocity_x and @velocity_y with the recorded velocity, as per the
-last event(s) processed.
+Gets the current velocity.
+
+If the gesture is recognized, this function returns %TRUE and fills
+in @velocity_x and @velocity_y with the recorded velocity, as per the
+last events processed.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGestureSwipe
+<parameter_description> a `GtkGestureSwipe`
</parameter_description>
</parameter>
<parameter name="velocity_x">
@@ -40535,13 +43472,13 @@ last event(s) processed.
<function name="gtk_gesture_swipe_new">
<description>
-Returns a newly created #GtkGesture that recognizes swipes.
+Returns a newly created `GtkGesture` that recognizes swipes.
</description>
<parameters>
</parameters>
-<return> a newly created #GtkGestureSwipe
+<return> a newly created `GtkGestureSwipe`
</return>
</function>
@@ -40552,7 +43489,7 @@ Separates @gesture into an isolated group.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGesture
+<parameter_description> a `GtkGesture`
</parameter_description>
</parameter>
</parameters>
@@ -40561,15 +43498,18 @@ Separates @gesture into an isolated group.
<function name="gtk_gesture_zoom_get_scale_delta">
<description>
-If @gesture is active, this function returns the zooming difference
-since the gesture was recognized (hence the starting point is
-considered 1:1). If @gesture is not active, 1 is returned.
+Gets the scale delta.
+
+If @gesture is active, this function returns the zooming
+difference since the gesture was recognized (hence the
+starting point is considered 1:1). If @gesture is not
+active, 1 is returned.
</description>
<parameters>
<parameter name="gesture">
-<parameter_description> a #GtkGestureZoom
+<parameter_description> a `GtkGestureZoom`
</parameter_description>
</parameter>
</parameters>
@@ -40579,23 +43519,22 @@ considered 1:1). If @gesture is not active, 1 is returned.
<function name="gtk_gesture_zoom_new">
<description>
-Returns a newly created #GtkGesture that recognizes zoom
-in/out gestures (usually known as pinch/zoom).
+Returns a newly created `GtkGesture` that recognizes
+pinch/zoom gestures.
</description>
<parameters>
</parameters>
-<return> a newly created #GtkGestureZoom
+<return> a newly created `GtkGestureZoom`
</return>
</function>
<function name="gtk_get_binary_age">
<description>
-Returns the binary age as passed to `libtool`
-when building the GTK library the process is running against.
-If `libtool` means nothing to you, don't
-worry about it.
+Returns the binary age as passed to `libtool`.
+
+If `libtool` means nothing to you, don't worry about it.
</description>
@@ -40661,10 +43600,9 @@ received @event, or %NULL
<function name="gtk_get_interface_age">
<description>
-Returns the interface age as passed to `libtool`
-when building the GTK library the process is running against.
-If `libtool` means nothing to you, don't
-worry about it.
+Returns the interface age as passed to `libtool`.
+
+If `libtool` means nothing to you, don't worry about it.
</description>
@@ -40709,7 +43647,8 @@ gtk_widget_set_default_direction (direction);
<function name="gtk_get_major_version">
<description>
Returns the major version number of the GTK library.
-(e.g. in GTK version 3.1.5 this is 3.)
+
+For example, in GTK version 3.1.5 this is 3.
This function is in the library, so it represents the GTK library
your code is running against. Contrast with the %GTK_MAJOR_VERSION
@@ -40727,7 +43666,8 @@ have included when compiling your code.
<function name="gtk_get_micro_version">
<description>
Returns the micro version number of the GTK library.
-(e.g. in GTK version 3.1.5 this is 5.)
+
+For example, in GTK version 3.1.5 this is 5.
This function is in the library, so it represents the GTK library
your code is are running against. Contrast with the
@@ -40745,7 +43685,8 @@ GTK headers you have included when compiling your code.
<function name="gtk_get_minor_version">
<description>
Returns the minor version number of the GTK library.
-(e.g. in GTK version 3.1.5 this is 1.)
+
+For example, in GTK version 3.1.5 this is 1.
This function is in the library, so it represents the GTK library
your code is are running against. Contrast with the
@@ -40762,18 +43703,20 @@ GTK headers you have included when compiling your code.
<function name="gtk_gl_area_attach_buffers">
<description>
+Binds buffers to the framebuffer.
+
Ensures that the @area framebuffer object is made the current draw
and read target, and that all the required buffers for the @area
are created and bound to the framebuffer.
This function is automatically called before emitting the
-#GtkGLArea::render signal, and doesn't normally need to be called
-by application code.
+[signal@Gtk.GLArea::render] signal, and doesn't normally need to be
+called by application code.
</description>
<parameters>
<parameter name="area">
-<parameter_description> a #GtkGLArea
+<parameter_description> a `GtkGLArea`
</parameter_description>
</parameter>
</parameters>
@@ -40788,7 +43731,7 @@ Returns whether the area is in auto render mode or not.
</description>
<parameters>
<parameter name="area">
-<parameter_description> a #GtkGLArea
+<parameter_description> a `GtkGLArea`
</parameter_description>
</parameter>
</parameters>
@@ -40798,17 +43741,17 @@ Returns whether the area is in auto render mode or not.
<function name="gtk_gl_area_get_context">
<description>
-Retrieves the #GdkGLContext used by @area.
+Retrieves the `GdkGLContext` used by @area.
</description>
<parameters>
<parameter name="area">
-<parameter_description> a #GtkGLArea
+<parameter_description> a `GtkGLArea`
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkGLContext
+<return> the `GdkGLContext`
</return>
</function>
@@ -40820,7 +43763,7 @@ Gets the current error set on the @area.
</description>
<parameters>
<parameter name="area">
-<parameter_description> a #GtkGLArea
+<parameter_description> a `GtkGLArea`
</parameter_description>
</parameter>
</parameters>
@@ -40836,7 +43779,7 @@ Returns whether the area has a depth buffer.
</description>
<parameters>
<parameter name="area">
-<parameter_description> a #GtkGLArea
+<parameter_description> a `GtkGLArea`
</parameter_description>
</parameter>
</parameters>
@@ -40852,7 +43795,7 @@ Returns whether the area has a stencil buffer.
</description>
<parameters>
<parameter name="area">
-<parameter_description> a #GtkGLArea
+<parameter_description> a `GtkGLArea`
</parameter_description>
</parameter>
</parameters>
@@ -40862,13 +43805,14 @@ Returns whether the area has a stencil buffer.
<function name="gtk_gl_area_get_required_version">
<description>
-Retrieves the required version of OpenGL set
-using gtk_gl_area_set_required_version().
+Retrieves the required version of OpenGL.
+
+See [method@Gtk.GLArea.set_required_version].
</description>
<parameters>
<parameter name="area">
-<parameter_description> a #GtkGLArea
+<parameter_description> a `GtkGLArea`
</parameter_description>
</parameter>
<parameter name="major">
@@ -40885,34 +43829,36 @@ using gtk_gl_area_set_required_version().
<function name="gtk_gl_area_get_use_es">
<description>
-Retrieves the value set by gtk_gl_area_set_use_es().
+Returns whether the `GtkGLArea` should use OpenGL ES.
+
+See [method@Gtk.GLArea.set_use_es].
</description>
<parameters>
<parameter name="area">
-<parameter_description> a #GtkGLArea
+<parameter_description> a `GtkGLArea`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the #GtkGLArea should create an OpenGL ES context
+<return> %TRUE if the `GtkGLArea` should create an OpenGL ES context
and %FALSE otherwise
</return>
</function>
<function name="gtk_gl_area_make_current">
<description>
-Ensures that the #GdkGLContext used by @area is associated with
-the #GtkGLArea.
+Ensures that the `GdkGLContext` used by @area is associated with
+the `GtkGLArea`.
This function is automatically called before emitting the
-#GtkGLArea::render signal, and doesn't normally need to be called
-by application code.
+[signal@Gtk.GLArea::render] signal, and doesn't normally need
+to be called by application code.
</description>
<parameters>
<parameter name="area">
-<parameter_description> a #GtkGLArea
+<parameter_description> a `GtkGLArea`
</parameter_description>
</parameter>
</parameters>
@@ -40921,30 +43867,32 @@ by application code.
<function name="gtk_gl_area_new">
<description>
-Creates a new #GtkGLArea widget.
+Creates a new `GtkGLArea` widget.
</description>
<parameters>
</parameters>
-<return> a new #GtkGLArea
+<return> a new `GtkGLArea`
</return>
</function>
<function name="gtk_gl_area_queue_render">
<description>
Marks the currently rendered data (if any) as invalid, and queues
-a redraw of the widget, ensuring that the #GtkGLArea::render signal
+a redraw of the widget.
+
+This ensures that the [signal@Gtk.GLArea::render] signal
is emitted during the draw.
-This is only needed when the gtk_gl_area_set_auto_render() has
+This is only needed when [method@Gtk.GLArea.set_auto_render] has
been called with a %FALSE value. The default behaviour is to
-emit #GtkGLArea::render on each draw.
+emit [signal@Gtk.GLArea::render] on each draw.
</description>
<parameters>
<parameter name="area">
-<parameter_description> a #GtkGLArea
+<parameter_description> a `GtkGLArea`
</parameter_description>
</parameter>
</parameters>
@@ -40953,20 +43901,22 @@ emit #GtkGLArea::render on each draw.
<function name="gtk_gl_area_set_auto_render">
<description>
-If @auto_render is %TRUE the #GtkGLArea::render signal will be
-emitted every time the widget draws. This is the default and is
+Sets whether the `GtkGLArea` is in auto render mode.
+
+If @auto_render is %TRUE the [signal@Gtk.GLArea::render] signal will
+be emitted every time the widget draws. This is the default and is
useful if drawing the widget is faster.
If @auto_render is %FALSE the data from previous rendering is kept
around and will be used for drawing the widget the next time,
unless the window is resized. In order to force a rendering
-gtk_gl_area_queue_render() must be called. This mode is useful when
-the scene changes seldom, but takes a long time to redraw.
+[method@Gtk.GLArea.queue_render] must be called. This mode is
+useful when the scene changes seldom, but takes a long time to redraw.
</description>
<parameters>
<parameter name="area">
-<parameter_description> a #GtkGLArea
+<parameter_description> a `GtkGLArea`
</parameter_description>
</parameter>
<parameter name="auto_render">
@@ -40980,17 +43930,19 @@ the scene changes seldom, but takes a long time to redraw.
<function name="gtk_gl_area_set_error">
<description>
Sets an error on the area which will be shown instead of the
-GL rendering. This is useful in the #GtkGLArea::create-context
+GL rendering.
+
+This is useful in the [signal@Gtk.GLArea::create-context]
signal if GL context creation fails.
</description>
<parameters>
<parameter name="area">
-<parameter_description> a #GtkGLArea
+<parameter_description> a `GtkGLArea`
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> a new #GError, or %NULL to unset the error
+<parameter_description> a new `GError`, or %NULL to unset the error
</parameter_description>
</parameter>
</parameters>
@@ -40999,6 +43951,8 @@ signal if GL context creation fails.
<function name="gtk_gl_area_set_has_depth_buffer">
<description>
+Sets whether the `GtkGLArea` should use a depth buffer.
+
If @has_depth_buffer is %TRUE the widget will allocate and
enable a depth buffer for the target framebuffer. Otherwise
there will be none.
@@ -41006,7 +43960,7 @@ there will be none.
</description>
<parameters>
<parameter name="area">
-<parameter_description> a #GtkGLArea
+<parameter_description> a `GtkGLArea`
</parameter_description>
</parameter>
<parameter name="has_depth_buffer">
@@ -41019,6 +43973,8 @@ there will be none.
<function name="gtk_gl_area_set_has_stencil_buffer">
<description>
+Sets whether the `GtkGLArea` should use a stencil buffer.
+
If @has_stencil_buffer is %TRUE the widget will allocate and
enable a stencil buffer for the target framebuffer. Otherwise
there will be none.
@@ -41026,7 +43982,7 @@ there will be none.
</description>
<parameters>
<parameter name="area">
-<parameter_description> a #GtkGLArea
+<parameter_description> a `GtkGLArea`
</parameter_description>
</parameter>
<parameter name="has_stencil_buffer">
@@ -41039,15 +43995,15 @@ there will be none.
<function name="gtk_gl_area_set_required_version">
<description>
-Sets the required version of OpenGL to be used when creating the context
-for the widget.
+Sets the required version of OpenGL to be used when creating
+the context for the widget.
This function must be called before the area has been realized.
</description>
<parameters>
<parameter name="area">
-<parameter_description> a #GtkGLArea
+<parameter_description> a `GtkGLArea`
</parameter_description>
</parameter>
<parameter name="major">
@@ -41072,7 +44028,7 @@ with either API.
</description>
<parameters>
<parameter name="area">
-<parameter_description> a #GtkGLArea
+<parameter_description> a `GtkGLArea`
</parameter_description>
</parameter>
<parameter name="use_es">
@@ -41133,7 +44089,7 @@ by @width and @height.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="child">
@@ -41175,7 +44131,7 @@ Attaching widgets labeled [1], [2], [3] with @sibling == %NULL and
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="child">
@@ -41211,7 +44167,7 @@ Returns which row defines the global baseline of @grid.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
</parameters>
@@ -41228,7 +44184,7 @@ cell at @column, @row.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="column">
@@ -41252,7 +44208,7 @@ Returns whether all columns of @grid have the same width.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
</parameters>
@@ -41268,7 +44224,7 @@ Returns the amount of space between the columns of @grid.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
</parameters>
@@ -41278,15 +44234,15 @@ Returns the amount of space between the columns of @grid.
<function name="gtk_grid_get_row_baseline_position">
<description>
-Returns the baseline position of @row as set
-by gtk_grid_set_row_baseline_position() or the default value
-%GTK_BASELINE_POSITION_CENTER.
+Returns the baseline position of @row.
+
+See [method Gtk Grid.set_row_baseline_position].
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="row">
@@ -41306,7 +44262,7 @@ Returns whether all rows of @grid have the same height.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
</parameters>
@@ -41322,7 +44278,7 @@ Returns the amount of space between the rows of @grid.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
</parameters>
@@ -41341,7 +44297,7 @@ position are grown to span the new column.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="position">
@@ -41364,7 +44320,7 @@ a column is inserted.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="sibling">
@@ -41391,7 +44347,7 @@ position are grown to span the new row.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="position">
@@ -41410,7 +44366,7 @@ Retrieves the column number to which @child attaches its left side.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkGridLayoutChild
+<parameter_description> a `GtkGridLayoutChild`
</parameter_description>
</parameter>
</parameters>
@@ -41426,7 +44382,7 @@ Retrieves the number of columns that @child spans to.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkGridLayoutChild
+<parameter_description> a `GtkGridLayoutChild`
</parameter_description>
</parameter>
</parameters>
@@ -41442,7 +44398,7 @@ Retrieves the row number to which @child attaches its top side.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkGridLayoutChild
+<parameter_description> a `GtkGridLayoutChild`
</parameter_description>
</parameter>
</parameters>
@@ -41458,7 +44414,7 @@ Retrieves the number of rows that @child spans to.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkGridLayoutChild
+<parameter_description> a `GtkGridLayoutChild`
</parameter_description>
</parameter>
</parameters>
@@ -41473,7 +44429,7 @@ Sets the column number to attach the left side of @child.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkGridLayoutChild
+<parameter_description> a `GtkGridLayoutChild`
</parameter_description>
</parameter>
<parameter name="column">
@@ -41491,7 +44447,7 @@ Sets the number of columns @child spans to.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkGridLayoutChild
+<parameter_description> a `GtkGridLayoutChild`
</parameter_description>
</parameter>
<parameter name="span">
@@ -41509,7 +44465,7 @@ Sets the row to place @child in.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkGridLayoutChild
+<parameter_description> a `GtkGridLayoutChild`
</parameter_description>
</parameter>
<parameter name="row">
@@ -41527,7 +44483,7 @@ Sets the number of rows @child spans to.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkGridLayoutChild
+<parameter_description> a `GtkGridLayoutChild`
</parameter_description>
</parameter>
<parameter name="span">
@@ -41546,7 +44502,7 @@ Retrieves the row set with gtk_grid_layout_set_baseline_row().
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGridLayout
+<parameter_description> a `GtkGridLayout`
</parameter_description>
</parameter>
</parameters>
@@ -41562,7 +44518,7 @@ Checks whether all columns of @grid should have the same width.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGridLayout
+<parameter_description> a `GtkGridLayout`
</parameter_description>
</parameter>
</parameters>
@@ -41578,7 +44534,7 @@ Retrieves the spacing set with gtk_grid_layout_set_column_spacing().
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGridLayout
+<parameter_description> a `GtkGridLayout`
</parameter_description>
</parameter>
</parameters>
@@ -41588,15 +44544,18 @@ Retrieves the spacing set with gtk_grid_layout_set_column_spacing().
<function name="gtk_grid_layout_get_row_baseline_position">
<description>
-Returns the baseline position of @row as set by
-gtk_grid_layout_set_row_baseline_position(), or the default value
-of %GTK_BASELINE_POSITION_CENTER.
+Returns the baseline position of @row.
+
+If no value has been set with
+[method@Gtk.GridLayout.set_row_baseline_position],
+the default value of %GTK_BASELINE_POSITION_CENTER
+is returned.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGridLayout
+<parameter_description> a `GtkGridLayout`
</parameter_description>
</parameter>
<parameter name="row">
@@ -41616,7 +44575,7 @@ Checks whether all rows of @grid should have the same height.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGridLayout
+<parameter_description> a `GtkGridLayout`
</parameter_description>
</parameter>
</parameters>
@@ -41632,7 +44591,7 @@ Retrieves the spacing set with gtk_grid_layout_set_row_spacing().
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGridLayout
+<parameter_description> a `GtkGridLayout`
</parameter_description>
</parameter>
</parameters>
@@ -41642,13 +44601,13 @@ Retrieves the spacing set with gtk_grid_layout_set_row_spacing().
<function name="gtk_grid_layout_new">
<description>
-Creates a new #GtkGridLayout.
+Creates a new `GtkGridLayout`.
</description>
<parameters>
</parameters>
-<return> the newly created #GtkGridLayout
+<return> the newly created `GtkGridLayout`
</return>
</function>
@@ -41663,7 +44622,7 @@ parent of the @grid.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGridLayout
+<parameter_description> a `GtkGridLayout`
</parameter_description>
</parameter>
<parameter name="row">
@@ -41681,7 +44640,7 @@ Sets whether all columns of @grid should have the same width.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGridLayout
+<parameter_description> a `GtkGridLayout`
</parameter_description>
</parameter>
<parameter name="homogeneous">
@@ -41699,7 +44658,7 @@ Sets the amount of space to insert between consecutive columns.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGridLayout
+<parameter_description> a `GtkGridLayout`
</parameter_description>
</parameter>
<parameter name="spacing">
@@ -41718,7 +44677,7 @@ grid, in case that row is assigned more space than is requested.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGridLayout
+<parameter_description> a `GtkGridLayout`
</parameter_description>
</parameter>
<parameter name="row">
@@ -41726,7 +44685,7 @@ grid, in case that row is assigned more space than is requested.
</parameter_description>
</parameter>
<parameter name="pos">
-<parameter_description> a #GtkBaselinePosition
+<parameter_description> a `GtkBaselinePosition`
</parameter_description>
</parameter>
</parameters>
@@ -41740,7 +44699,7 @@ Sets whether all rows of @grid should have the same height.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGridLayout
+<parameter_description> a `GtkGridLayout`
</parameter_description>
</parameter>
<parameter name="homogeneous">
@@ -41758,7 +44717,7 @@ Sets the amount of space to insert between consecutive rows.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGridLayout
+<parameter_description> a `GtkGridLayout`
</parameter_description>
</parameter>
<parameter name="spacing">
@@ -41777,22 +44736,22 @@ Creates a new grid widget.
</description>
<parameters>
</parameters>
-<return> the new #GtkGrid
+<return> the new `GtkGrid`
</return>
</function>
<function name="gtk_grid_query_child">
<description>
-Queries the attach points and spans of @child inside the given #GtkGrid.
+Queries the attach points and spans of @child inside the given `GtkGrid`.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> a #GtkWidget child of @grid
+<parameter_description> a `GtkWidget` child of @grid
</parameter_description>
</parameter>
<parameter name="column">
@@ -41817,13 +44776,15 @@ Queries the attach points and spans of @child inside the given #GtkGrid.
<function name="gtk_grid_remove">
<description>
-Removes a child from @grid, after it has been added
-with gtk_grid_attach() or gtk_grid_attach_next_to().
+Removes a child from @grid.
+
+The child must have been added with
+[method Gtk Grid.attach] or [method Gtk Grid.attach_next_to].
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="child">
@@ -41846,7 +44807,7 @@ are moved to the left.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="position">
@@ -41869,7 +44830,7 @@ are moved up.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="position">
@@ -41883,6 +44844,7 @@ are moved up.
<function name="gtk_grid_set_baseline_row">
<description>
Sets which row defines the global baseline for the entire grid.
+
Each row in the grid can have its own local baseline, but only
one of those is global, meaning it will be the baseline in the
parent of the @grid.
@@ -41890,7 +44852,7 @@ parent of the @grid.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="row">
@@ -41908,7 +44870,7 @@ Sets whether all columns of @grid will have the same width.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="homogeneous">
@@ -41926,7 +44888,7 @@ Sets the amount of space between columns of @grid.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="spacing">
@@ -41942,10 +44904,12 @@ Sets the amount of space between columns of @grid.
Sets how the baseline should be positioned on @row of the
grid, in case that row is assigned more space than is requested.
+The default baseline position is %GTK_BASELINE_POSITION_CENTER.
+
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="row">
@@ -41953,7 +44917,7 @@ grid, in case that row is assigned more space than is requested.
</parameter_description>
</parameter>
<parameter name="pos">
-<parameter_description> a #GtkBaselinePosition
+<parameter_description> a `GtkBaselinePosition`
</parameter_description>
</parameter>
</parameters>
@@ -41967,7 +44931,7 @@ Sets whether all rows of @grid will have the same height.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="homogeneous">
@@ -41985,7 +44949,7 @@ Sets the amount of space between rows of @grid.
</description>
<parameters>
<parameter name="grid">
-<parameter_description> a #GtkGrid
+<parameter_description> a `GtkGrid`
</parameter_description>
</parameter>
<parameter name="spacing">
@@ -42004,7 +44968,7 @@ Returns whether rows can be selected by dragging with the mouse.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkGridView
+<parameter_description> a `GtkGridView`
</parameter_description>
</parameter>
</parameters>
@@ -42020,7 +44984,7 @@ Gets the factory that's currently used to populate list items.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkGridView
+<parameter_description> a `GtkGridView`
</parameter_description>
</parameter>
</parameters>
@@ -42036,7 +45000,7 @@ Gets the maximum number of columns that the grid will use.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkGridView
+<parameter_description> a `GtkGridView`
</parameter_description>
</parameter>
</parameters>
@@ -42052,7 +45016,7 @@ Gets the minimum number of columns that the grid will use.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkGridView
+<parameter_description> a `GtkGridView`
</parameter_description>
</parameter>
</parameters>
@@ -42068,7 +45032,7 @@ Gets the model that's currently used to read the items displayed.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkGridView
+<parameter_description> a `GtkGridView`
</parameter_description>
</parameter>
</parameters>
@@ -42085,7 +45049,7 @@ selected on hover.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListView
+<parameter_description> a `GtkGridView`
</parameter_description>
</parameter>
</parameters>
@@ -42095,12 +45059,12 @@ selected on hover.
<function name="gtk_grid_view_new">
<description>
-Creates a new #GtkGridView that uses the given @factory for
+Creates a new `GtkGridView` that uses the given @factory for
mapping items to widgets.
The function takes ownership of the
arguments, so you can write code like
-```
+```c
grid_view = gtk_grid_view_new (create_model (),
gtk_builder_list_item_factory_new_from_resource ("/resource.ui"));
```
@@ -42117,7 +45081,7 @@ gtk_builder_list_item_factory_new_from_resource ("/resource.ui"));
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkGridView using the given @model and @factory
+<return> a new `GtkGridView` using the given @model and @factory
</return>
</function>
@@ -42128,7 +45092,7 @@ Sets whether selections can be changed by dragging with the mouse.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkGridView
+<parameter_description> a `GtkGridView`
</parameter_description>
</parameter>
<parameter name="enable_rubberband">
@@ -42141,12 +45105,12 @@ Sets whether selections can be changed by dragging with the mouse.
<function name="gtk_grid_view_set_factory">
<description>
-Sets the #GtkListItemFactory to use for populating list items.
+Sets the `GtkListItemFactory` to use for populating list items.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkGridView
+<parameter_description> a `GtkGridView`
</parameter_description>
</parameter>
<parameter name="factory">
@@ -42159,15 +45123,17 @@ Sets the #GtkListItemFactory to use for populating list items.
<function name="gtk_grid_view_set_max_columns">
<description>
-Sets the maximum number of columns to use. This number must be at least 1.
+Sets the maximum number of columns to use.
+
+This number must be at least 1.
If @max_columns is smaller than the minimum set via
-gtk_grid_view_set_min_columns(), that value is used instead.
+[method@Gtk.GridView.set_min_columns], that value is used instead.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkGridView
+<parameter_description> a `GtkGridView`
</parameter_description>
</parameter>
<parameter name="max_columns">
@@ -42180,15 +45146,17 @@ gtk_grid_view_set_min_columns(), that value is used instead.
<function name="gtk_grid_view_set_min_columns">
<description>
-Sets the minimum number of columns to use. This number must be at least 1.
+Sets the minimum number of columns to use.
+
+This number must be at least 1.
If @min_columns is smaller than the minimum set via
-gtk_grid_view_set_max_columns(), that value is ignored.
+[method@Gtk.GridView.set_max_columns], that value is ignored.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkGridView
+<parameter_description> a `GtkGridView`
</parameter_description>
</parameter>
<parameter name="min_columns">
@@ -42201,12 +45169,14 @@ gtk_grid_view_set_max_columns(), that value is ignored.
<function name="gtk_grid_view_set_model">
<description>
-Sets the #GtkSelectionModel to use for
+Sets the imodel to use.
+
+This must be a [iface@Gtk.SelectionModel].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkGridView
+<parameter_description> a `GtkGridView`
</parameter_description>
</parameter>
<parameter name="model">
@@ -42225,7 +45195,7 @@ selected on hover.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkGridView
+<parameter_description> a `GtkGridView`
</parameter_description>
</parameter>
<parameter name="single_click_activate">
@@ -42238,14 +45208,13 @@ selected on hover.
<function name="gtk_header_bar_get_decoration_layout">
<description>
-Gets the decoration layout set with
-gtk_header_bar_set_decoration_layout().
+Gets the decoration layout of the `GtkHeaderBar`.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkHeaderBar
+<parameter_description> a `GtkHeaderBar`
</parameter_description>
</parameter>
</parameters>
@@ -42262,7 +45231,7 @@ title buttons.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkHeaderBar
+<parameter_description> a `GtkHeaderBar`
</parameter_description>
</parameter>
</parameters>
@@ -42272,14 +45241,15 @@ title buttons.
<function name="gtk_header_bar_get_title_widget">
<description>
-Retrieves the title widget of the header. See
-gtk_header_bar_set_title_widget().
+Retrieves the title widget of the header.
+
+See [method@Gtk.HeaderBar.set_title_widget].
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkHeaderBar
+<parameter_description> a `GtkHeaderBar`
</parameter_description>
</parameter>
</parameters>
@@ -42290,13 +45260,13 @@ of the header, or %NULL if none has been set explicitly.
<function name="gtk_header_bar_new">
<description>
-Creates a new #GtkHeaderBar widget.
+Creates a new `GtkHeaderBar` widget.
</description>
<parameters>
</parameters>
-<return> a new #GtkHeaderBar
+<return> a new `GtkHeaderBar`
</return>
</function>
@@ -42308,7 +45278,7 @@ end of the @bar.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> A #GtkHeaderBar
+<parameter_description> A `GtkHeaderBar`
</parameter_description>
</parameter>
<parameter name="child">
@@ -42327,7 +45297,7 @@ start of the @bar.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> A #GtkHeaderBar
+<parameter_description> A `GtkHeaderBar`
</parameter_description>
</parameter>
<parameter name="child">
@@ -42340,14 +45310,17 @@ start of the @bar.
<function name="gtk_header_bar_remove">
<description>
-Removes a child from @bar, after it has been added
-with gtk_header_bar_pack_start(), gtk_header_bar_pack_end()
-or gtk_header_bar_set_title_widget().
+Removes a child from the `GtkHeaderBar`.
+
+The child must have been added with
+[method@Gtk.HeaderBar.pack_start],
+[method@Gtk.HeaderBar.pack_end] or
+[method@Gtk.HeaderBar.set_title_widget].
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkHeaderBar
+<parameter_description> a `GtkHeaderBar`
</parameter_description>
</parameter>
<parameter name="child">
@@ -42360,14 +45333,15 @@ or gtk_header_bar_set_title_widget().
<function name="gtk_header_bar_set_decoration_layout">
<description>
-Sets the decoration layout for this header bar, overriding
-the #GtkSettings:gtk-decoration-layout setting.
+Sets the decoration layout for this header bar.
+
+This property overrides the
+[property@Gtk.Settings:gtk-decoration-layout] setting.
There can be valid reasons for overriding the setting, such
as a header bar design that does not allow for buttons to take
room on the right, or only offers room for a single close button.
-Split header bars are another example for overriding the
-setting.
+Split header bars are another example for overriding the setting.
The format of the string is button names, separated by commas.
A colon separates the buttons that should appear on the left
@@ -42380,7 +45354,7 @@ on the left, and minimize, maximize and close buttons on the right.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkHeaderBar
+<parameter_description> a `GtkHeaderBar`
</parameter_description>
</parameter>
<parameter name="layout">
@@ -42395,12 +45369,12 @@ unset the layout
<function name="gtk_header_bar_set_show_title_buttons">
<description>
Sets whether this header bar shows the standard window
-title buttons including close, maximize, and minimize.
+title buttons.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkHeaderBar
+<parameter_description> a `GtkHeaderBar`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -42413,21 +45387,22 @@ title buttons including close, maximize, and minimize.
<function name="gtk_header_bar_set_title_widget">
<description>
-Sets the title for the #GtkHeaderBar.
+Sets the title for the `GtkHeaderBar`.
-When set to %NULL, the headerbar will display the title of the window it is
-contained in.
+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.
+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 title label to be
-visible again.
+You should set the title widget to %NULL, for the window
+title label to be visible again.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkHeaderBar
+<parameter_description> a `GtkHeaderBar`
</parameter_description>
</parameter>
<parameter name="title_widget">
@@ -42475,16 +45450,37 @@ output values will be in the same range.
<return></return>
</function>
+<function name="gtk_icon_cache_validate">
+<description>
+Validates the icon cache passed in the @cache and
+@cache_size fields of the @info structure. The
+validator checks that offsets specified in the
+cache do not point outside the mapped area, that
+strings look reasonable, and that pixbufs can
+be deserialized. The amount of validation can
+be controlled with the @flags field.
+
+
+</description>
+<parameters>
+<parameter name="info">
+<parameter_description> a CacheInfo structure
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the cache is valid
+</return>
+</function>
+
<function name="gtk_icon_paintable_get_file">
<description>
-Gets the #GFile that was used to load the icon, or %NULL if the icon was
-not loaded from a file.
+Gets the `GFile` that was used to load the icon.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconPaintable
+<parameter_description> a `GtkIconPaintable`
</parameter_description>
</parameter>
</parameters>
@@ -42502,36 +45498,38 @@ icon theme may use fallback icons - either those specified to
gtk_icon_theme_lookup_icon() or the always-available
"image-missing". The icon chosen is returned by this function.
-If the icon was created without an icon theme, this function returns %NULL.
+If the icon was created without an icon theme, this function
+returns %NULL.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconPaintable
+<parameter_description> a `GtkIconPaintable`
</parameter_description>
</parameter>
</parameters>
-<return> the themed icon-name for the icon, or %NULL
-if its not a themed icon.
+<return> the themed icon-name for the
+icon, or %NULL if its not a themed icon.
</return>
</function>
<function name="gtk_icon_paintable_is_symbolic">
<description>
-Checks if the icon is symbolic or not. This currently uses only
-the file name and not the file contents for determining this.
-This behaviour may change in the future.
+Checks if the icon is symbolic or not.
-Note that to render a symbolic #GtkIconPaintable properly (with
-recoloring), you have to set its icon name on a #GtkImage.
+This currently uses only the file name and not the file contents
+for determining this. This behaviour may change in the future.
+
+Note that to render a symbolic `GtkIconPaintable` properly (with
+recoloring), you have to set its icon name on a `GtkImage`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconPaintable
+<parameter_description> a `GtkIconPaintable`
</parameter_description>
</parameter>
</parameters>
@@ -42541,14 +45539,15 @@ recoloring), you have to set its icon name on a #GtkImage.
<function name="gtk_icon_paintable_new_for_file">
<description>
-Creates a #GtkIconPaintable for a file with a given size and scale
-#GtkIconPaintable. The icon can then be rendered by using it as a #GdkPaintable.
+Creates a `GtkIconPaintable` for a file with a given size and scale.
+
+The icon can then be rendered by using it as a `GdkPaintable`.
</description>
<parameters>
<parameter name="file">
-<parameter_description> a #GFile
+<parameter_description> a `GFile`
</parameter_description>
</parameter>
<parameter name="size">
@@ -42560,24 +45559,27 @@ Creates a #GtkIconPaintable for a file with a given size and scale
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkIconPaintable containing
+<return> a `GtkIconPaintable` containing
for the icon. Unref with g_object_unref()
</return>
</function>
<function name="gtk_icon_paintable_snapshot_with_colors">
<description>
-This is similar to the implementation of gdk_paintable_snapshot(), but if the icon is
-symbolic it will be recolored with the specified colors (which usually comes from the theme).
+Snapshots the `GtkIconPaintable`.
+
+This is similar to the implementation of [method@Gdk.Paintable.snapshot],
+but if the icon is symbolic it will be recolored with the specified colors
+(which usually comes from the theme).
</description>
<parameters>
<parameter name="icon">
-<parameter_description> a #GtkIconPaintable
+<parameter_description> a `GtkIconPaintable`
</parameter_description>
</parameter>
<parameter name="snapshot">
-<parameter_description> a #GdkSnapshot to snapshot to
+<parameter_description> a `GdkSnapshot` to snapshot to
</parameter_description>
</parameter>
<parameter name="width">
@@ -42589,22 +45591,22 @@ symbolic it will be recolored with the specified colors (which usually comes fro
</parameter_description>
</parameter>
<parameter name="foreground_color">
-<parameter_description> a #GdkRGBA representing the foreground color
+<parameter_description> a `GdkRGBA` representing the foreground color
of the icon or %NULL to use the default color.
</parameter_description>
</parameter>
<parameter name="success_color">
-<parameter_description> a #GdkRGBA representing the warning color
+<parameter_description> a `GdkRGBA` representing the warning color
of the icon or %NULL to use the default color
</parameter_description>
</parameter>
<parameter name="warning_color">
-<parameter_description> a #GdkRGBA representing the warning color
+<parameter_description> a `GdkRGBA` representing the warning color
of the icon or %NULL to use the default color
</parameter_description>
</parameter>
<parameter name="error_color">
-<parameter_description> a #GdkRGBA representing the error color
+<parameter_description> a `GdkRGBA` representing the error color
of the icon or %NULL to use the default color (allow-none)
</parameter_description>
</parameter>
@@ -42617,7 +45619,7 @@ of the icon or %NULL to use the default color (allow-none)
Adds a resource path that will be looked at when looking
for icons, similar to search paths.
-See gtk_icon_theme_set_resource_path().
+See [method@Gtk.IconTheme.set_resource_path].
This function should be used to make application-specific icons
available as part of the icon theme.
@@ -42625,7 +45627,7 @@ available as part of the icon theme.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconTheme
+<parameter_description> a `GtkIconTheme`
</parameter_description>
</parameter>
<parameter name="path">
@@ -42639,12 +45641,13 @@ available as part of the icon theme.
<function name="gtk_icon_theme_add_search_path">
<description>
Appends a directory to the search path.
-See gtk_icon_theme_set_search_path().
+
+See [method@Gtk.IconTheme.set_search_path].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconTheme
+<parameter_description> a `GtkIconTheme`
</parameter_description>
</parameter>
<parameter name="path">
@@ -42657,14 +45660,14 @@ See gtk_icon_theme_set_search_path().
<function name="gtk_icon_theme_get_display">
<description>
-Returns the display that the GtkIconTheme object was
+Returns the display that the `GtkIconTheme` object was
created for.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconTheme
+<parameter_description> a `GtkIconTheme`
</parameter_description>
</parameter>
</parameters>
@@ -42674,27 +45677,26 @@ created for.
<function name="gtk_icon_theme_get_for_display">
<description>
-Gets the icon theme object associated with @display; if this
-function has not previously been called for the given
-display, a new icon theme object will be created and
-associated with the display. Icon theme objects are
-fairly expensive to create, so using this function
-is usually a better choice than calling than gtk_icon_theme_new()
-and setting the display yourself; by using this function
-a single icon theme object will be shared between users.
+Gets the icon theme object associated with @display.
+
+If this function has not previously been called for the given
+display, a new icon theme object will be created and associated
+with the display. Icon theme objects are fairly expensive to create,
+so using this function is usually a better choice than calling
+[ctor Gtk IconTheme new] and setting the display yourself; by using
+this function a single icon theme object will be shared between users.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
-<return> A unique #GtkIconTheme associated with
-the given display. This icon theme is associated with
-the display and can be used as long as the display
-is open. Do not ref or unref it.
+<return> A unique `GtkIconTheme` associated with
+the given display. This icon theme is associated with the display
+and can be used as long as the display is open. Do not ref or unref it.
</return>
</function>
@@ -42706,7 +45708,7 @@ Lists the names of icons in the current icon theme.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconTheme
+<parameter_description> a `GtkIconTheme`
</parameter_description>
</parameter>
</parameters>
@@ -42719,15 +45721,16 @@ free the array using g_strfreev().
<function name="gtk_icon_theme_get_icon_sizes">
<description>
Returns an array of integers describing the sizes at which
-the icon is available without scaling. A size of -1 means
-that the icon is available in a scalable format. The array
-is zero-terminated.
+the icon is available without scaling.
+
+A size of -1 means that the icon is available in a scalable
+format. The array is zero-terminated.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconTheme
+<parameter_description> a `GtkIconTheme`
</parameter_description>
</parameter>
<parameter name="icon_name">
@@ -42746,13 +45749,13 @@ longer needed.
<description>
Gets the current resource path.
-See gtk_icon_theme_set_resource_path().
+See [method@Gtk.IconTheme.set_resource_path].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconTheme
+<parameter_description> a `GtkIconTheme`
</parameter_description>
</parameter>
</parameters>
@@ -42764,13 +45767,15 @@ The returned value should be freed with g_strfreev().
<function name="gtk_icon_theme_get_search_path">
<description>
-Gets the current search path. See gtk_icon_theme_set_search_path().
+Gets the current search path.
+
+See [method@Gtk.IconTheme.set_search_path].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconTheme
+<parameter_description> a `GtkIconTheme`
</parameter_description>
</parameter>
</parameters>
@@ -42788,7 +45793,7 @@ Gets the current icon theme name.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconTheme
+<parameter_description> a `GtkIconTheme`
</parameter_description>
</parameter>
</parameters>
@@ -42796,6 +45801,27 @@ Gets the current icon theme name.
</return>
</function>
+<function name="gtk_icon_theme_has_gicon">
+<description>
+Checks whether an icon theme includes an icon
+for a particular `GIcon`.
+
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a `GtkIconTheme`
+</parameter_description>
+</parameter>
+<parameter name="gicon">
+<parameter_description> a `GIcon`
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @self includes an icon for @gicon
+</return>
+</function>
+
<function name="gtk_icon_theme_has_icon">
<description>
Checks whether an icon theme includes an icon
@@ -42805,7 +45831,7 @@ for a particular name.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconTheme
+<parameter_description> a `GtkIconTheme`
</parameter_description>
</parameter>
<parameter name="icon_name">
@@ -42820,19 +45846,20 @@ icon for @icon_name.
<function name="gtk_icon_theme_lookup_by_gicon">
<description>
-Looks up a icon for a desired size and window scale, returning a
-#GtkIconPaintable. The icon can then be rendered by using it as a #GdkPaintable,
+Looks up a icon for a desired size and window scale.
+
+The icon can then be rendered by using it as a `GdkPaintable`,
or you can get information such as the filename and size.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconTheme
+<parameter_description> a `GtkIconTheme`
</parameter_description>
</parameter>
<parameter name="icon">
-<parameter_description> the #GIcon to look up
+<parameter_description> the `GIcon` to look up
</parameter_description>
</parameter>
<parameter name="size">
@@ -42852,33 +45879,35 @@ or you can get information such as the filename and size.
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkIconPaintable containing
+<return> a `GtkIconPaintable` containing
information about the icon. Unref with g_object_unref()
</return>
</function>
<function name="gtk_icon_theme_lookup_icon">
<description>
-Looks up a named icon for a desired size and window scale, returning a
-#GtkIconPaintable. The icon can then be rendered by using it as a #GdkPaintable,
+Looks up a named icon for a desired size and window scale,
+returning a `GtkIconPaintable`.
+
+The icon can then be rendered by using it as a `GdkPaintable`,
or you can get information such as the filename and size.
-If the available @icon_name is not available and @fallbacks are provided,
-they will be tried in order.
+If the available @icon_name is not available and @fallbacks are
+provided, they will be tried in order.
If no matching icon is found, then a paintable that renders the
"missing icon" icon is returned. If you need to do something else
-for missing icons you need to use gtk_icon_theme_has_icon().
+for missing icons you need to use [method@Gtk.IconTheme.has_icon].
Note that you probably want to listen for icon theme changes and
update the icon. This is usually done by overriding the
-#GtkWidgetClass.css-changed() function.
+GtkWidgetClass.css-changed() function.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconTheme
+<parameter_description> a `GtkIconTheme`
</parameter_description>
</parameter>
<parameter name="icon_name">
@@ -42906,23 +45935,25 @@ update the icon. This is usually done by overriding the
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkIconPaintable object
+<return> a `GtkIconPaintable` object
containing the icon.
</return>
</function>
<function name="gtk_icon_theme_new">
<description>
-Creates a new icon theme object. Icon theme objects are used
-to lookup up an icon by name in a particular icon theme.
-Usually, you’ll want to use gtk_icon_theme_get_for_display()
-rather than creating a new icon theme object for scratch.
+Creates a new icon theme object.
+
+Icon theme objects are used to lookup up an icon by name
+in a particular icon theme. Usually, you’ll want to use
+[func@Gtk.IconTheme.get_for_display] rather than creating
+a new icon theme object for scratch.
</description>
<parameters>
</parameters>
-<return> the newly created #GtkIconTheme object.
+<return> the newly created `GtkIconTheme` object.
</return>
</function>
@@ -42943,7 +45974,7 @@ but they are treated like unthemed icons.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconTheme
+<parameter_description> a `GtkIconTheme`
</parameter_description>
</parameter>
<parameter name="path">
@@ -42957,9 +45988,10 @@ that are searched for icons
<function name="gtk_icon_theme_set_search_path">
<description>
-Sets the search path for the icon theme object. When looking
-for an icon theme, GTK will search for a subdirectory of
-one or more of the directories in @path with the same name
+Sets the search path for the icon theme object.
+
+When looking for an icon theme, GTK will search for a subdirectory
+of one or more of the directories in @path with the same name
as the icon theme containing an index.theme file. (Themes from
multiple of the path elements are combined to allow themes to be
extended by adding icons in the user’s home directory.)
@@ -42975,7 +46007,7 @@ rather than directly on the icon path.)
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconTheme
+<parameter_description> a `GtkIconTheme`
</parameter_description>
</parameter>
<parameter name="path">
@@ -42989,14 +46021,16 @@ array of directories that are searched for icon themes
<function name="gtk_icon_theme_set_theme_name">
<description>
-Sets the name of the icon theme that the #GtkIconTheme object uses
-overriding system configuration. This function cannot be called
-on the icon theme objects returned from gtk_icon_theme_get_for_display().
+Sets the name of the icon theme that the `GtkIconTheme` object uses
+overriding system configuration.
+
+This function cannot be called on the icon theme objects returned
+from [type_func@Gtk.IconTheme.get_for_display].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkIconTheme
+<parameter_description> a `GtkIconTheme`
</parameter_description>
</parameter>
<parameter name="theme_name">
@@ -44350,9 +47384,10 @@ method sets #GtkIconView:reorderable to %FALSE.
<description>
Asks the widget that the input context is attached to delete
characters around the cursor position by emitting the
-GtkIMContext::delete_surrounding signal. Note that @offset and @n_chars
-are in characters not in bytes which differs from the usage other
-places in #GtkIMContext.
+GtkIMContext::delete_surrounding signal.
+
+Note that @offset and @n_chars are in characters not in bytes
+which differs from the usage other places in #GtkIMContext.
In order to use this function, you should first call
gtk_im_context_get_surrounding() to get the current context, and
@@ -44369,7 +47404,7 @@ not useful for applications.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkIMContext
+<parameter_description> a `GtkIMContext`
</parameter_description>
</parameter>
<parameter name="offset">
@@ -44389,14 +47424,14 @@ a negative value means start before the cursor.
<function name="gtk_im_context_filter_key">
<description>
Allow an input method to forward key press and release events
-to another input method, without necessarily having a GdkEvent
+to another input methodm without necessarily having a `GdkEvent`
available.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkIMContext
+<parameter_description> a `GtkIMContext`
</parameter_description>
</parameter>
<parameter name="press">
@@ -44434,15 +47469,17 @@ available.
<function name="gtk_im_context_filter_keypress">
<description>
-Allow an input method to internally handle key press and release
-events. If this function returns %TRUE, then no further processing
+Allow an input method to internally handle key press and release
+events.
+
+If this function returns %TRUE, then no further processing
should be done for this key event.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkIMContext
+<parameter_description> a `GtkIMContext`
</parameter_description>
</parameter>
<parameter name="event">
@@ -44451,21 +47488,21 @@ should be done for this key event.
</parameter>
</parameters>
<return> %TRUE if the input method handled the key event.
-
</return>
</function>
<function name="gtk_im_context_focus_in">
<description>
Notify the input method that the widget to which this
-input context corresponds has gained focus. The input method
-may, for example, change the displayed feedback to reflect
-this change.
+input context corresponds has gained focus.
+
+The input method may, for example, change the displayed
+feedback to reflect this change.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkIMContext
+<parameter_description> a `GtkIMContext`
</parameter_description>
</parameter>
</parameters>
@@ -44475,14 +47512,15 @@ this change.
<function name="gtk_im_context_focus_out">
<description>
Notify the input method that the widget to which this
-input context corresponds has lost focus. The input method
-may, for example, change the displayed feedback or reset the contexts
-state to reflect this change.
+input context corresponds has lost focus.
+
+The input method may, for example, change the displayed
+feedback or reset the contexts state to reflect this change.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkIMContext
+<parameter_description> a `GtkIMContext`
</parameter_description>
</parameter>
</parameters>
@@ -44493,13 +47531,13 @@ state to reflect this change.
<description>
Retrieve the current preedit string for the input context,
and a list of attributes to apply to the string.
-This string should be displayed inserted at the insertion
-point.
+
+This string should be displayed inserted at the insertion point.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkIMContext
+<parameter_description> a `GtkIMContext`
</parameter_description>
</parameter>
<parameter name="str">
@@ -44515,7 +47553,7 @@ must unreference it with pango_attr_list_unref().
</parameter>
<parameter name="cursor_pos">
<parameter_description> location to store position of cursor (in characters)
-within the preedit string.
+within the preedit string.
</parameter_description>
</parameter>
</parameters>
@@ -44524,19 +47562,68 @@ within the preedit string.
<function name="gtk_im_context_get_surrounding">
<description>
-Retrieves context around the insertion point. Input methods
-typically want context in order to constrain input text based on
-existing text; this is important for languages such as Thai where
-only some sequences of characters are allowed.
+Retrieves context around the insertion point.
+
+Input methods typically want context in order to constrain input text
+based on existing text; this is important for languages such as Thai
+where only some sequences of characters are allowed.
This function is implemented by emitting the
-GtkIMContext::retrieve_surrounding signal on the input method; in
-response to this signal, a widget should provide as much context as
+[signal@Gtk.IMContext::retrieve-surrounding] signal on the input method;
+in response to this signal, a widget should provide as much context as
is available, up to an entire paragraph, by calling
-gtk_im_context_set_surrounding(). Note that there is no obligation
-for a widget to respond to the ::retrieve_surrounding signal, so input
-methods must be prepared to function without context.
+[method@Gtk.IMContext.set_surrounding].
+Note that there is no obligation for a widget to respond to the
+`::retrieve-surrounding` signal, so input methods must be prepared to
+function without context.
+
+Deprecated: 4.2: Use [method@Gtk.IMContext.get_surrounding_with_selection] instead.
+
+</description>
+<parameters>
+<parameter name="context">
+<parameter_description> a `GtkIMContext`
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> location to store a UTF-8 encoded
+string of text holding context around the insertion point.
+If the function returns %TRUE, then you must free the result
+stored in this location with g_free().
+</parameter_description>
+</parameter>
+<parameter name="cursor_index">
+<parameter_description> location to store byte index of the insertion
+cursor within @text.
+</parameter_description>
+</parameter>
+</parameters>
+<return> `TRUE` if surrounding text was provided; in this case
+you must free the result stored in `text`.
+
+</return>
+</function>
+
+<function name="gtk_im_context_get_surrounding_with_selection">
+<description>
+Retrieves context around the insertion point.
+
+Input methods typically want context in order to constrain input
+text based on existing text; this is important for languages such
+as Thai where only some sequences of characters are allowed.
+
+This function is implemented by emitting the
+[signal@Gtk.IMContext::retrieve-surrounding] signal on the input method;
+in response to this signal, a widget should provide as much context as
+is available, up to an entire paragraph, by calling
+[method@Gtk.IMContext.set_surrounding_with_selection].
+
+Note that there is no obligation for a widget to respond to the
+`::retrieve-surrounding` signal, so input methods must be prepared to
+function without context.
+
+Since: 4.2
</description>
<parameters>
@@ -44556,22 +47643,29 @@ stored in this location with g_free().
cursor within @text.
</parameter_description>
</parameter>
+<parameter name="anchor_index">
+<parameter_description> location to store byte index of the selection
+bound within @text
+</parameter_description>
+</parameter>
</parameters>
-<return> %TRUE if surrounding text was provided; in this case
-you must free the result stored in *text.
+<return> `TRUE` if surrounding text was provided; in this case
+you must free the result stored in `text`.
+
</return>
</function>
<function name="gtk_im_context_reset">
<description>
Notify the input method that a change such as a change in cursor
-position has been made. This will typically cause the input
-method to clear the preedit state.
+position has been made.
+
+This will typically cause the input method to clear the preedit state.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkIMContext
+<parameter_description> a `GtkIMContext`
</parameter_description>
</parameter>
</parameters>
@@ -44580,15 +47674,16 @@ method to clear the preedit state.
<function name="gtk_im_context_set_client_widget">
<description>
-Set the client window for the input context; this is the
-#GtkWidget holding the input focus. This widget is
+Set the client widget for the input context.
+
+This is the `GtkWidget` holding the input focus. This widget is
used in order to correctly position status windows, and may
also be used for purposes internal to the input method.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkIMContext
+<parameter_description> a `GtkIMContext`
</parameter_description>
</parameter>
<parameter name="widget">
@@ -44602,14 +47697,15 @@ that the previous client widget no longer exists.
<function name="gtk_im_context_set_cursor_location">
<description>
-Notify the input method that a change in cursor
-position has been made. The location is relative to the client
-window.
+Notify the input method that a change in cursor
+position has been made.
+
+The location is relative to the client window.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkIMContext
+<parameter_description> a `GtkIMContext`
</parameter_description>
</parameter>
<parameter name="area">
@@ -44623,14 +47719,51 @@ window.
<function name="gtk_im_context_set_surrounding">
<description>
Sets surrounding context around the insertion point and preedit
+string.
+
+This function is expected to be called in response to the
+[signal@Gtk.IMContext::retrieve-surrounding] signal, and will
+likely have no effect if called at other times.
+
+Deprecated: 4.2: Use [method@Gtk.IMContext.set_surrounding_with_selection] instead
+
+</description>
+<parameters>
+<parameter name="context">
+<parameter_description> a `GtkIMContext`
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> text surrounding the insertion point, as UTF-8.
+the preedit string should not be included within
+@text.
+</parameter_description>
+</parameter>
+<parameter name="len">
+<parameter_description> the length of @text, or -1 if @text is nul-terminated
+</parameter_description>
+</parameter>
+<parameter name="cursor_index">
+<parameter_description> the byte index of the insertion cursor within @text.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_im_context_set_surrounding_with_selection">
+<description>
+Sets surrounding context around the insertion point and preedit
string. This function is expected to be called in response to the
GtkIMContext::retrieve_surrounding signal, and will likely have no
effect if called at other times.
+Since: 4.2
+
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkIMContext
+<parameter_description> a #GtkIMContext
</parameter_description>
</parameter>
<parameter name="text">
@@ -44644,7 +47777,11 @@ the preedit string should not be included within
</parameter_description>
</parameter>
<parameter name="cursor_index">
-<parameter_description> the byte index of the insertion cursor within @text.
+<parameter_description> the byte index of the insertion cursor within @text
+</parameter_description>
+</parameter>
+<parameter name="anchor_index">
+<parameter_description> the byte index of the selection bound within @text
</parameter_description>
</parameter>
</parameters>
@@ -44654,14 +47791,16 @@ the preedit string should not be included within
<function name="gtk_im_context_set_use_preedit">
<description>
Sets whether the IM context should use the preedit string
-to display feedback. If @use_preedit is FALSE (default
-is TRUE), then the IM context may use some other method to display
-feedback, such as displaying it in a child of the root window.
+to display feedback.
+
+If @use_preedit is %FALSE (default is %TRUE), then the IM context
+may use some other method to display feedback, such as displaying
+it in a child of the root window.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkIMContext
+<parameter_description> a `GtkIMContext`
</parameter_description>
</parameter>
<parameter name="use_preedit">
@@ -44714,7 +47853,6 @@ the length of the sequence should be zero.)
</parameter>
<parameter name="max_seq_len">
<parameter_description> Maximum length of a sequence in the table
-(cannot be greater than #GTK_MAX_COMPOSE_LEN)
</parameter_description>
</parameter>
<parameter name="n_seqs">
@@ -44745,7 +47883,7 @@ Gets the id of the currently active delegate of the @context.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkIMMulticontext
+<parameter_description> a `GtkIMMulticontext`
</parameter_description>
</parameter>
</parameters>
@@ -44755,13 +47893,13 @@ Gets the id of the currently active delegate of the @context.
<function name="gtk_im_multicontext_new">
<description>
-Creates a new #GtkIMMulticontext.
+Creates a new `GtkIMMulticontext`.
</description>
<parameters>
</parameters>
-<return> a new #GtkIMMulticontext.
+<return> a new `GtkIMMulticontext`.
</return>
</function>
@@ -44775,11 +47913,11 @@ replaced by the delegate corresponding to the new context id.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkIMMulticontext
+<parameter_description> a `GtkIMMulticontext`
</parameter_description>
</parameter>
<parameter name="context_id">
-<parameter_description> the id to use
+<parameter_description> the id to use
</parameter_description>
</parameter>
</parameters>
@@ -44793,7 +47931,7 @@ Resets the image to be empty.
</description>
<parameters>
<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter_description> a `GtkImage`
</parameter_description>
</parameter>
</parameters>
@@ -44802,45 +47940,39 @@ Resets the image to be empty.
<function name="gtk_image_get_gicon">
<description>
-Gets the #GIcon and size being displayed by the #GtkImage.
+Gets the `GIcon` being displayed by the `GtkImage`.
+
The storage type of the image must be %GTK_IMAGE_EMPTY or
-%GTK_IMAGE_GICON (see gtk_image_get_storage_type()).
+%GTK_IMAGE_GICON (see [method@Gtk.Image.get_storage_type]).
The caller of this function does not own a reference to the
-returned #GIcon.
-
-Note: This function was changed in 3.94 not to use out parameters
-anymore, but return the GIcon directly. See gtk_image_get_icon_size()
-for a way to get the icon size.
+returned `GIcon`.
</description>
<parameters>
<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter_description> a `GtkImage`
</parameter_description>
</parameter>
</parameters>
-<return> a #GIcon, or %NULL
+<return> a `GIcon`, or %NULL
</return>
</function>
<function name="gtk_image_get_icon_name">
<description>
-Gets the icon name and size being displayed by the #GtkImage.
+Gets the icon name and size being displayed by the `GtkImage`.
+
The storage type of the image must be %GTK_IMAGE_EMPTY or
-%GTK_IMAGE_ICON_NAME (see gtk_image_get_storage_type()).
-The returned string is owned by the #GtkImage and should not
+%GTK_IMAGE_ICON_NAME (see [method@Gtk.Image.get_storage_type]).
+The returned string is owned by the `GtkImage` and should not
be freed.
-Note: This function was changed in 3.94 not to use out parameters
-anymore, but return the icon name directly. See gtk_image_get_icon_size()
-for a way to get the icon size.
-
</description>
<parameters>
<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter_description> a `GtkImage`
</parameter_description>
</parameter>
</parameters>
@@ -44856,7 +47988,7 @@ Gets the icon size used by the @image when rendering icons.
</description>
<parameters>
<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter_description> a `GtkImage`
</parameter_description>
</parameter>
</parameters>
@@ -44866,9 +47998,10 @@ Gets the icon size used by the @image when rendering icons.
<function name="gtk_image_get_paintable">
<description>
-Gets the image #GdkPaintable being displayed by the #GtkImage.
+Gets the image `GdkPaintable` being displayed by the `GtkImage`.
+
The storage type of the image must be %GTK_IMAGE_EMPTY or
-%GTK_IMAGE_PAINTABLE (see gtk_image_get_storage_type()).
+%GTK_IMAGE_PAINTABLE (see [method@Gtk.Image.get_storage_type]).
The caller of this function does not own a reference to the
returned paintable.
@@ -44876,12 +48009,12 @@ returned paintable.
</description>
<parameters>
<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter_description> a `GtkImage`
</parameter_description>
</parameter>
</parameters>
-<return> the displayed paintable, or %NULL if
-the image is empty
+<return> the displayed paintable,
+or %NULL if the image is empty
</return>
</function>
@@ -44893,7 +48026,7 @@ Gets the pixel size used for named icons.
</description>
<parameters>
<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter_description> a `GtkImage`
</parameter_description>
</parameter>
</parameters>
@@ -44903,15 +48036,17 @@ Gets the pixel size used for named icons.
<function name="gtk_image_get_storage_type">
<description>
-Gets the type of representation being used by the #GtkImage
-to store image data. If the #GtkImage has no image data,
-the return value will be %GTK_IMAGE_EMPTY.
+Gets the type of representation being used by the `GtkImage`
+to store image data.
+
+If the `GtkImage` has no image data, the return value will
+be %GTK_IMAGE_EMPTY.
</description>
<parameters>
<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter_description> a `GtkImage`
</parameter_description>
</parameter>
</parameters>
@@ -44921,30 +48056,31 @@ the return value will be %GTK_IMAGE_EMPTY.
<function name="gtk_image_new">
<description>
-Creates a new empty #GtkImage widget.
+Creates a new empty `GtkImage` widget.
</description>
<parameters>
</parameters>
-<return> a newly created #GtkImage widget.
+<return> a newly created `GtkImage` widget.
</return>
</function>
<function name="gtk_image_new_from_file">
<description>
-Creates a new #GtkImage displaying the file @filename. If the file
-isn’t found or can’t be loaded, the resulting #GtkImage will
-display a “broken image” icon. This function never returns %NULL,
-it always returns a valid #GtkImage widget.
+Creates a new `GtkImage` displaying the file @filename.
+
+If the file isn’t found or can’t be loaded, the resulting `GtkImage`
+will display a “broken image” icon. This function never returns %NULL,
+it always returns a valid `GtkImage` widget.
If you need to detect failures to load the file, use
-gdk_texture_new_from_file() to load the file yourself, then create
-the #GtkImage from the texture.
+[ctor@Gdk.Texture.new_from_file] to load the file yourself,
+then create the `GtkImage` from the texture.
-The storage type (gtk_image_get_storage_type()) of the returned
-image is not defined, it will be whatever is appropriate for
-displaying the file.
+The storage type (see [method@Gtk.Image.get_storage_type])
+of the returned image is not defined, it will be whatever
+is appropriate for displaying the file.
</description>
@@ -44954,21 +48090,18 @@ displaying the file.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImage
+<return> a new `GtkImage`
</return>
</function>
<function name="gtk_image_new_from_gicon">
<description>
-Creates a #GtkImage displaying an icon from the current icon theme.
+Creates a `GtkImage` displaying an icon from the current icon theme.
+
If the icon name isn’t known, a “broken image” icon will be
-displayed instead. If the current icon theme is changed, the icon
+displayed instead. If the current icon theme is changed, the icon
will be updated appropriately.
-Note: Before 3.94, this function was taking an extra icon size
-argument. See gtk_image_set_icon_size() for another way to set
-the icon size.
-
</description>
<parameters>
@@ -44977,21 +48110,18 @@ the icon size.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImage displaying the themed icon
+<return> a new `GtkImage` displaying the themed icon
</return>
</function>
<function name="gtk_image_new_from_icon_name">
<description>
-Creates a #GtkImage displaying an icon from the current icon theme.
+Creates a `GtkImage` displaying an icon from the current icon theme.
+
If the icon name isn’t known, a “broken image” icon will be
-displayed instead. If the current icon theme is changed, the icon
+displayed instead. If the current icon theme is changed, the icon
will be updated appropriately.
-Note: Before 3.94, this function was taking an extra icon size
-argument. See gtk_image_set_icon_size() for another way to set
-the icon size.
-
</description>
<parameters>
@@ -45000,72 +48130,75 @@ the icon size.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImage displaying the themed icon
+<return> a new `GtkImage` displaying the themed icon
</return>
</function>
<function name="gtk_image_new_from_paintable">
<description>
-Creates a new #GtkImage displaying @paintable.
-The #GtkImage does not assume a reference to the
-paintable; you still need to unref it if you own references.
-#GtkImage will add its own reference rather than adopting yours.
+Creates a new `GtkImage` displaying @paintable.
+
+The `GtkImage` does not assume a reference to the paintable; you still
+need to unref it if you own references. `GtkImage` will add its own
+reference rather than adopting yours.
-The #GtkImage will track changes to the @paintable and update
+The `GtkImage` will track changes to the @paintable and update
its size and contents in response to it.
</description>
<parameters>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable, or %NULL
+<parameter_description> a `GdkPaintable`, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImage
+<return> a new `GtkImage`
</return>
</function>
<function name="gtk_image_new_from_pixbuf">
<description>
-Creates a new #GtkImage displaying @pixbuf.
-The #GtkImage does not assume a reference to the
-pixbuf; you still need to unref it if you own references.
-#GtkImage will add its own reference rather than adopting yours.
+Creates a new `GtkImage` displaying @pixbuf.
+
+The `GtkImage` does not assume a reference to the pixbuf; you still
+need to unref it if you own references. `GtkImage` will add its own
+reference rather than adopting yours.
-This is a helper for gtk_image_new_from_paintable(), and you can't
+This is a helper for [ctor@Gtk.Image.new_from_paintable], and you can't
get back the exact pixbuf once this is called, only a texture.
-Note that this function just creates an #GtkImage from the pixbuf. The
-#GtkImage created will not react to state changes. Should you want that,
-you should use gtk_image_new_from_icon_name().
+Note that this function just creates an `GtkImage` from the pixbuf.
+The `GtkImage` created will not react to state changes. Should you
+want that, you should use [ctor@Gtk.Image.new_from_icon_name].
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf, or %NULL
+<parameter_description> a `GdkPixbuf`, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImage
+<return> a new `GtkImage`
</return>
</function>
<function name="gtk_image_new_from_resource">
<description>
-Creates a new #GtkImage displaying the resource file @resource_path. If the file
-isn’t found or can’t be loaded, the resulting #GtkImage will
+Creates a new `GtkImage` displaying the resource file @resource_path.
+
+If the file isn’t found or can’t be loaded, the resulting `GtkImage` will
display a “broken image” icon. This function never returns %NULL,
-it always returns a valid #GtkImage widget.
+it always returns a valid `GtkImage` widget.
If you need to detect failures to load the file, use
-gdk_pixbuf_new_from_file() to load the file yourself, then create
-the #GtkImage from the pixbuf.
+[ctor@GdkPixbuf.Pixbuf.new_from_file] to load the file yourself,
+then create the `GtkImage` from the pixbuf.
-The storage type (gtk_image_get_storage_type()) of the returned
-image is not defined, it will be whatever is appropriate for
-displaying the file.
+The storage type (see [method@Gtk.Image.get_storage_type]) of
+the returned image is not defined, it will be whatever is
+appropriate for displaying the file.
</description>
@@ -45075,18 +48208,20 @@ displaying the file.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImage
+<return> a new `GtkImage`
</return>
</function>
<function name="gtk_image_set_from_file">
<description>
-See gtk_image_new_from_file() for details.
+Sets a `GtkImage` to show a file.
+
+See [ctor@Gtk.Image.new_from_file] for details.
</description>
<parameters>
<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter_description> a `GtkImage`
</parameter_description>
</parameter>
<parameter name="filename">
@@ -45099,16 +48234,14 @@ See gtk_image_new_from_file() for details.
<function name="gtk_image_set_from_gicon">
<description>
-See gtk_image_new_from_gicon() for details.
+Sets a `GtkImage` to show a `GIcon`.
-Note: Before 3.94, this function was taking an extra icon size
-argument. See gtk_image_set_icon_size() for another way to set
-the icon size.
+See [ctor@Gtk.Image.new_from_gicon] for details.
</description>
<parameters>
<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter_description> a `GtkImage`
</parameter_description>
</parameter>
<parameter name="icon">
@@ -45121,16 +48254,14 @@ the icon size.
<function name="gtk_image_set_from_icon_name">
<description>
-See gtk_image_new_from_icon_name() for details.
+Sets a `GtkImage` to show a named icon.
-Note: Before 3.94, this function was taking an extra icon size
-argument. See gtk_image_set_icon_size() for another way to set
-the icon size.
+See [ctor@Gtk.Image.new_from_icon_name] for details.
</description>
<parameters>
<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter_description> a `GtkImage`
</parameter_description>
</parameter>
<parameter name="icon_name">
@@ -45143,16 +48274,18 @@ the icon size.
<function name="gtk_image_set_from_paintable">
<description>
-See gtk_image_new_from_paintable() for details.
+Sets a `GtkImage` to show a `GdkPaintable`.
+
+See [ctor@Gtk.Image.new_from_paintable] for details.
</description>
<parameters>
<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter_description> a `GtkImage`
</parameter_description>
</parameter>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable or %NULL
+<parameter_description> a `GdkPaintable` or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -45161,19 +48294,22 @@ See gtk_image_new_from_paintable() for details.
<function name="gtk_image_set_from_pixbuf">
<description>
-See gtk_image_new_from_pixbuf() for details.
+Sets a `GtkImage` to show a `GdkPixbuf`.
+
+See [ctor@Gtk.Image.new_from_pixbuf] for details.
-Note: This is a helper for gtk_image_set_from_paintable(), and you can't
-get back the exact pixbuf once this is called, only a paintable.
+Note: This is a helper for [method@Gtk.Image.set_from_paintable],
+and you can't get back the exact pixbuf once this is called,
+only a paintable.
</description>
<parameters>
<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter_description> a `GtkImage`
</parameter_description>
</parameter>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf or %NULL
+<parameter_description> a `GdkPixbuf` or `NULL`
</parameter_description>
</parameter>
</parameters>
@@ -45182,12 +48318,14 @@ get back the exact pixbuf once this is called, only a paintable.
<function name="gtk_image_set_from_resource">
<description>
-See gtk_image_new_from_resource() for details.
+Sets a `GtkImage` to show a resource.
+
+See [ctor@Gtk.Image.new_from_resource] for details.
</description>
<parameters>
<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter_description> a `GtkImage`
</parameter_description>
</parameter>
<parameter name="resource_path">
@@ -45205,7 +48343,7 @@ Suggests an icon size to the theme for named icons.
</description>
<parameters>
<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter_description> a `GtkImage`
</parameter_description>
</parameter>
<parameter name="icon_size">
@@ -45218,14 +48356,15 @@ Suggests an icon size to the theme for named icons.
<function name="gtk_image_set_pixel_size">
<description>
-Sets the pixel size to use for named icons. If the pixel size is set
-to a value != -1, it is used instead of the icon size set by
-gtk_image_set_from_icon_name().
+Sets the pixel size to use for named icons.
+
+If the pixel size is set to a value != -1, it is used instead
+of the icon size set by [method@Gtk.Image.set_from_icon_name].
</description>
<parameters>
<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter_description> a `GtkImage`
</parameter_description>
</parameter>
<parameter name="pixel_size">
@@ -45238,15 +48377,17 @@ gtk_image_set_from_icon_name().
<function name="gtk_info_bar_add_action_widget">
<description>
-Add an activatable widget to the action area of a #GtkInfoBar,
-connecting a signal handler that will emit the #GtkInfoBar::response
-signal on the message area when the widget is activated. The widget
-is appended to the end of the message areas action area.
+Add an activatable widget to the action area of a `GtkInfoBar`.
+
+This also connects a signal handler that will emit the
+[signal@Gtk.InfoBar::response] signal on the message area
+when the widget is activated. The widget is appended to the
+end of the message areas action area.
</description>
<parameters>
<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter_description> a `GtkInfoBar`
</parameter_description>
</parameter>
<parameter name="child">
@@ -45263,17 +48404,18 @@ is appended to the end of the message areas action area.
<function name="gtk_info_bar_add_button">
<description>
-Adds a button with the given text and sets things up so that
-clicking the button will emit the “response” signal with the given
-response_id. The button is appended to the end of the info bars's
-action area. The button widget is returned, but usually you don't
-need it.
+Adds a button with the given text.
+
+Clicking the button will emit the [signal@Gtk.InfoBar::response]
+signal with the given response_id. The button is appended to the
+end of the info bars's action area. The button widget is returned,
+but usually you don't need it.
</description>
<parameters>
<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter_description> a `GtkInfoBar`
</parameter_description>
</parameter>
<parameter name="button_text">
@@ -45285,22 +48427,24 @@ need it.
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkButton widget
+<return> the `GtkButton` widget
that was added
</return>
</function>
<function name="gtk_info_bar_add_buttons">
<description>
-Adds more buttons, same as calling gtk_info_bar_add_button()
+Adds multiple buttons.
+
+This is the same as calling [method@Gtk.InfoBar.add_button]
repeatedly. The variable argument list should be %NULL-terminated
-as with gtk_info_bar_new_with_buttons(). Each button must have both
+as with [ctor@Gtk.InfoBar.new_with_buttons]. Each button must have both
text and response ID.
</description>
<parameters>
<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter_description> a `GtkInfoBar`
</parameter_description>
</parameter>
<parameter name="first_button_text">
@@ -45323,7 +48467,7 @@ Adds a widget to the content area of the info bar.
</description>
<parameters>
<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter_description> a `GtkInfoBar`
</parameter_description>
</parameter>
<parameter name="widget">
@@ -45342,7 +48486,7 @@ Returns the message type of the message area.
</description>
<parameters>
<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter_description> a `GtkInfoBar`
</parameter_description>
</parameter>
</parameters>
@@ -45358,11 +48502,11 @@ Returns whether the info bar is currently revealed.
</description>
<parameters>
<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter_description> a `GtkInfoBar`
</parameter_description>
</parameter>
</parameters>
-<return> the current value of the #GtkInfoBar:revealed property
+<return> the current value of the [property@Gtk.InfoBar:revealed] property
</return>
</function>
@@ -45374,7 +48518,7 @@ Returns whether the widget will display a standard close button.
</description>
<parameters>
<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter_description> a `GtkInfoBar`
</parameter_description>
</parameter>
</parameters>
@@ -45384,24 +48528,26 @@ Returns whether the widget will display a standard close button.
<function name="gtk_info_bar_new">
<description>
-Creates a new #GtkInfoBar object.
+Creates a new `GtkInfoBar` object.
</description>
<parameters>
</parameters>
-<return> a new #GtkInfoBar object
+<return> a new `GtkInfoBar` object
</return>
</function>
<function name="gtk_info_bar_new_with_buttons">
<description>
-Creates a new #GtkInfoBar with buttons. Button text/response ID
-pairs should be listed, with a %NULL pointer ending the list.
-A response ID can be any positive number,
-or one of the values in the #GtkResponseType enumeration. If the
+Creates a new `GtkInfoBar` with buttons.
+
+Button text/response ID pairs should be listed, with a %NULL pointer
+ending the list. A response ID can be any positive number,
+or one of the values in the `GtkResponseType` enumeration. If the
user clicks one of these dialog buttons, GtkInfoBar will emit
-the “response” signal with the corresponding response ID.
+the [signal@Gtk.InfoBar::response] signal with the corresponding
+response ID.
</description>
@@ -45416,20 +48562,21 @@ with %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkInfoBar
+<return> a new `GtkInfoBar`
</return>
</function>
<function name="gtk_info_bar_remove_action_widget">
<description>
-Removes a widget from the action area of @info_bar, after
-it been put there by a call to gtk_info_bar_add_action_widget()
-or gtk_info_bar_add_button().
+Removes a widget from the action area of @info_bar.
+
+The widget must have been put there by a call to
+[method@Gtk.InfoBar.add_action_widget] or [method@Gtk.InfoBar.add_button].
</description>
<parameters>
<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter_description> a `GtkInfoBar`
</parameter_description>
</parameter>
<parameter name="widget">
@@ -45442,13 +48589,12 @@ or gtk_info_bar_add_button().
<function name="gtk_info_bar_remove_child">
<description>
-Removes a widget from the content area of the info bar,
-after it has been added with gtk_info_bar_add_child().
+Removes a widget from the content area of the info bar.
</description>
<parameters>
<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter_description> a `GtkInfoBar`
</parameter_description>
</parameter>
<parameter name="widget">
@@ -45466,7 +48612,7 @@ Emits the “response” signal with the given @response_id.
</description>
<parameters>
<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter_description> a `GtkInfoBar`
</parameter_description>
</parameter>
<parameter name="response_id">
@@ -45481,15 +48627,16 @@ Emits the “response” signal with the given @response_id.
<description>
Sets the last widget in the info bar’s action area with
the given response_id as the default widget for the dialog.
+
Pressing “Enter” normally activates the default widget.
Note that this function currently requires @info_bar to
-be added to a widget hierarchy.
+be added to a widget hierarchy.
</description>
<parameters>
<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter_description> a `GtkInfoBar`
</parameter_description>
</parameter>
<parameter name="response_id">
@@ -45509,7 +48656,7 @@ GTK uses this type to determine how the message is displayed.
</description>
<parameters>
<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter_description> a `GtkInfoBar`
</parameter_description>
</parameter>
<parameter name="message_type">
@@ -45522,14 +48669,16 @@ GTK uses this type to determine how the message is displayed.
<function name="gtk_info_bar_set_response_sensitive">
<description>
-Calls gtk_widget_set_sensitive (widget, setting) for each
-widget in the info bars’s action area with the given response_id.
-A convenient way to sensitize/desensitize dialog buttons.
+Sets the sensitivity of action widgets for @response_id.
+
+Calls `gtk_widget_set_sensitive (widget, setting)` for each
+widget in the info bars’s action area with the given @response_id.
+A convenient way to sensitize/desensitize buttons.
</description>
<parameters>
<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter_description> a `GtkInfoBar`
</parameter_description>
</parameter>
<parameter name="response_id">
@@ -45546,16 +48695,19 @@ A convenient way to sensitize/desensitize dialog buttons.
<function name="gtk_info_bar_set_revealed">
<description>
-Sets the #GtkInfoBar:revealed property to @revealed. Changing this will make
-@info_bar reveal (%TRUE) or conceal (%FALSE) itself via a sliding transition.
+Sets whether the `GtkInfoBar` is revealed.
-Note: this does not show or hide @info_bar in the #GtkWidget:visible sense,
-so revealing has no effect if #GtkWidget:visible is %FALSE.
+Changing this will make @info_bar reveal or conceal
+itself via a sliding transition.
+
+Note: this does not show or hide @info_bar in the
+[property@Gtk.Widget:visible] sense, so revealing has no effect
+if [property@Gtk.Widget:visible] is %FALSE.
</description>
<parameters>
<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter_description> a `GtkInfoBar`
</parameter_description>
</parameter>
<parameter name="revealed">
@@ -45568,13 +48720,14 @@ so revealing has no effect if #GtkWidget:visible is %FALSE.
<function name="gtk_info_bar_set_show_close_button">
<description>
-If true, a standard close button is shown. When clicked it emits
-the response %GTK_RESPONSE_CLOSE.
+If true, a standard close button is shown.
+
+When clicked it emits the response %GTK_RESPONSE_CLOSE.
</description>
<parameters>
<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter_description> a `GtkInfoBar`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -45654,7 +48807,7 @@ triggering @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a keyval #GtkShortcutTrigger
+<parameter_description> a keyval `GtkShortcutTrigger`
</parameter_description>
</parameter>
</parameters>
@@ -45671,7 +48824,7 @@ triggering @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a keyval #GtkShortcutTrigger
+<parameter_description> a keyval `GtkShortcutTrigger`
</parameter_description>
</parameter>
</parameters>
@@ -45681,7 +48834,7 @@ triggering @self.
<function name="gtk_keyval_trigger_new">
<description>
-Creates a #GtkShortcutTrigger that will trigger whenever
+Creates a `GtkShortcutTrigger` that will trigger whenever
the key with the given @keyval and @modifiers is pressed.
@@ -45696,24 +48849,26 @@ the key with the given @keyval and @modifiers is pressed.
</parameter_description>
</parameter>
</parameters>
-<return> A new #GtkShortcutTrigger
+<return> A new `GtkShortcutTrigger`
</return>
</function>
<function name="gtk_label_get_attributes">
<description>
-Gets the attribute list that was set on the label using
-gtk_label_set_attributes(), if any. This function does
-not reflect attributes that come from the labels markup
-(see gtk_label_set_markup()). If you want to get the
-effective attributes for the label, use
-pango_layout_get_attribute (gtk_label_get_layout (self)).
+Gets the labels attribute list.
+
+This is the [struct@Pango.AttrList] that was set on the label using
+[method@Gtk.Label.set_attributes], if any. This function does not
+reflect attributes that come from the labels markup (see
+[method@Gtk.Label.set_markup]). If you want to get the effective
+attributes for the label, use
+`pango_layout_get_attribute (gtk_label_get_layout (self))`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -45725,18 +48880,19 @@ if none was set.
<function name="gtk_label_get_current_uri">
<description>
Returns the URI for the currently active link in the label.
+
The active link is the one under the mouse pointer or, in a
selectable label, the link in which the text cursor is currently
positioned.
-This function is intended for use in a #GtkLabel::activate-link handler
-or for use in a #GtkWidget::query-tooltip handler.
+This function is intended for use in a [signal@Gtk.Label::activate-link]
+handler or for use in a [signal@Gtk.Widget::query-tooltip] handler.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -45747,29 +48903,33 @@ The string is owned by GTK and must not be freed or modified.
<function name="gtk_label_get_ellipsize">
<description>
-Returns the ellipsizing position of the label. See gtk_label_set_ellipsize().
+Returns the ellipsizing position of the label.
+
+See [method@Gtk.Label.set_ellipsize].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
-<return> #PangoEllipsizeMode
+<return> `PangoEllipsizeMode`
</return>
</function>
<function name="gtk_label_get_extra_menu">
<description>
-Gets the menu model set with gtk_label_set_extra_menu().
+Gets the extra menu model of @label.
+
+See [method@Gtk.Label.set_extra_menu].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -45779,31 +48939,34 @@ Gets the menu model set with gtk_label_set_extra_menu().
<function name="gtk_label_get_justify">
<description>
-Returns the justification of the label. See gtk_label_set_justify().
+Returns the justification of the label.
+
+See [method@Gtk.Label.set_justify].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
-<return> #GtkJustification
+<return> `GtkJustification`
</return>
</function>
<function name="gtk_label_get_label">
<description>
-Fetches the text from a label widget including any embedded
-underlines indicating mnemonics and Pango markup. (See
-gtk_label_get_text()).
+Fetches the text from a label.
+
+The returned text includes any embedded underlines indicating
+mnemonics and Pango markup. (See [method@Gtk.Label.get_text]).
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -45814,38 +48977,40 @@ owned by the widget and must not be modified or freed.
<function name="gtk_label_get_layout">
<description>
-Gets the #PangoLayout used to display the label.
-The layout is useful to e.g. convert text positions to
-pixel positions, in combination with gtk_label_get_layout_offsets().
+Gets the `PangoLayout` used to display the label.
+
+The layout is useful to e.g. convert text positions to pixel
+positions, in combination with [method@Gtk.Label.get_layout_offsets].
The returned layout is owned by the @label so need not be
-freed by the caller. The @label is free to recreate its layout at
-any time, so it should be considered read-only.
+freed by the caller. The @label is free to recreate its layout
+at any time, so it should be considered read-only.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
-<return> the #PangoLayout for this label
+<return> the [class@Pango.Layout] for this label
</return>
</function>
<function name="gtk_label_get_layout_offsets">
<description>
-Obtains the coordinates where the label will draw the #PangoLayout
-representing the text in the label; useful to convert mouse events
-into coordinates inside the #PangoLayout, e.g. to take some action
-if some part of the label is clicked. Remember
-when using the #PangoLayout functions you need to convert to
-and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
+Obtains the coordinates where the label will draw its `PangoLayout`.
+
+The coordinates are useful to convert mouse events into coordinates
+inside the [class@Pango.Layout], e.g. to take some action if some part
+of the label is clicked. Remember when using the [class@Pango.Layout]
+functions you need to convert to and from pixels using PANGO_PIXELS()
+or [constant@Pango.SCALE].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="x">
@@ -45863,13 +49028,15 @@ and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
<function name="gtk_label_get_lines">
<description>
Gets the number of lines to which an ellipsized, wrapping
-label should be limited. See gtk_label_set_lines().
+label should be limited.
+
+See [method@Gtk.Label.set_lines].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -45879,14 +49046,15 @@ label should be limited. See gtk_label_set_lines().
<function name="gtk_label_get_max_width_chars">
<description>
-Retrieves the desired maximum width of @label, in characters. See
-gtk_label_set_width_chars().
+Retrieves the desired maximum width of @label, in characters.
+
+See [method@Gtk.Label.set_width_chars].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -45896,10 +49064,11 @@ gtk_label_set_width_chars().
<function name="gtk_label_get_measuring_layout">
<description>
-Gets a layout that can be used for measuring sizes. The returned
-layout will be identical to the label’s layout except for the
-layout’s width, which will be set to @width. Do not modify the returned
-layout.
+Gets a layout that can be used for measuring sizes.
+
+The returned layout will be identical to the label’s layout except for
+the layout’s width, which will be set to @width. Do not modify the
+returned layout.
</description>
@@ -45923,32 +49092,36 @@ layout.
<function name="gtk_label_get_mnemonic_keyval">
<description>
+Return the mnemonic accelerator.
+
If the label has been set so that it has a mnemonic key this function
returns the keyval used for the mnemonic accelerator. If there is no
-mnemonic set up it returns #GDK_KEY_VoidSymbol.
+mnemonic set up it returns `GDK_KEY_VoidSymbol`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
-<return> GDK keyval usable for accelerators, or #GDK_KEY_VoidSymbol
+<return> GDK keyval usable for accelerators, or `GDK_KEY_VoidSymbol`
</return>
</function>
<function name="gtk_label_get_mnemonic_widget">
<description>
Retrieves the target of the mnemonic (keyboard shortcut) of this
-label. See gtk_label_set_mnemonic_widget().
+label.
+
+See [method@Gtk.Label.set_mnemonic_widget].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -45959,13 +49132,13 @@ or %NULL if none has been set and the default algorithm will be used.
<function name="gtk_label_get_selectable">
<description>
-Gets the value set by gtk_label_set_selectable().
+Returns whether the label is selectable.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -45975,14 +49148,13 @@ Gets the value set by gtk_label_set_selectable().
<function name="gtk_label_get_selection_bounds">
<description>
-Gets the selected range of characters in the label, returning %TRUE
-if there’s a selection.
+Gets the selected range of characters in the label.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="start">
@@ -46006,7 +49178,7 @@ Returns whether the label is in single line mode.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -46016,15 +49188,17 @@ Returns whether the label is in single line mode.
<function name="gtk_label_get_text">
<description>
-Fetches the text from a label widget, as displayed on the
-screen. This does not include any embedded underlines
-indicating mnemonics or Pango markup. (See gtk_label_get_label())
+Fetches the text from a label.
+
+The returned text is as it appears on screen. This does not include
+any embedded underlines indicating mnemonics or Pango markup. (See
+[method@Gtk.Label.get_label])
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -46035,15 +49209,15 @@ string used by the label, and must not be modified.
<function name="gtk_label_get_use_markup">
<description>
-Returns whether the label’s text is interpreted as marked up with
-the [Pango text markup language][PangoMarkupFormat].
-See gtk_label_set_use_markup ().
+Returns whether the label’s text is interpreted as Pango markup.
+
+See [method@Gtk.Label.set_use_markup].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -46053,14 +49227,15 @@ See gtk_label_set_use_markup ().
<function name="gtk_label_get_use_underline">
<description>
-Returns whether an embedded underline in the label indicates a
-mnemonic. See gtk_label_set_use_underline().
+Returns whether an embedded underlines in the label indicate mnemonics.
+
+See [method@Gtk.Label.set_use_underline].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -46071,14 +49246,15 @@ the mnemonic accelerator keys.
<function name="gtk_label_get_width_chars">
<description>
-Retrieves the desired width of @label, in characters. See
-gtk_label_set_width_chars().
+Retrieves the desired width of @label, in characters.
+
+See [method@Gtk.Label.set_width_chars].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -46089,13 +49265,14 @@ gtk_label_set_width_chars().
<function name="gtk_label_get_wrap">
<description>
Returns whether lines in the label are automatically wrapped.
-See gtk_label_set_wrap().
+
+See [method@Gtk.Label.set_wrap].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -46105,13 +49282,15 @@ See gtk_label_set_wrap().
<function name="gtk_label_get_wrap_mode">
<description>
-Returns line wrap mode used by the label. See gtk_label_set_wrap_mode().
+Returns line wrap mode used by the label.
+
+See [method@Gtk.Label.set_wrap_mode].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -46121,13 +49300,15 @@ Returns line wrap mode used by the label. See gtk_label_set_wrap_mode().
<function name="gtk_label_get_xalign">
<description>
-Gets the #GtkLabel:xalign property for @label.
+Gets the `xalign` of the label.
+
+See the [property@Gtk.Label:xalign] property.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -46137,13 +49318,15 @@ Gets the #GtkLabel:xalign property for @label.
<function name="gtk_label_get_yalign">
<description>
-Gets the #GtkLabel:yalign property for @label.
+Gets the `yalign` of the label.
+
+See the [property@Gtk.Label:yalign] property.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
</parameters>
@@ -46153,8 +49336,9 @@ Gets the #GtkLabel:yalign property for @label.
<function name="gtk_label_new">
<description>
-Creates a new label with the given text inside it. You can
-pass %NULL to get an empty label widget.
+Creates a new label with the given text inside it.
+
+You can pass %NULL to get an empty label widget.
</description>
@@ -46164,25 +49348,25 @@ pass %NULL to get an empty label widget.
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkLabel
+<return> the new `GtkLabel`
</return>
</function>
<function name="gtk_label_new_with_mnemonic">
<description>
-Creates a new #GtkLabel, containing the text in @str.
+Creates a new `GtkLabel`, containing the text in @str.
If characters in @str are preceded by an underscore, they are
underlined. If you need a literal underscore character in a label, use
-'__' (two underscores). The first underlined character represents a
-keyboard accelerator called a mnemonic. The mnemonic key can be used
+'__' (two underscores). The first underlined character represents a
+keyboard accelerator called a mnemonic. The mnemonic key can be used
to activate another widget, chosen automatically, or explicitly using
-gtk_label_set_mnemonic_widget().
+[method@Gtk.Label.set_mnemonic_widget].
-If gtk_label_set_mnemonic_widget() is not called, then the first
-activatable ancestor of the #GtkLabel will be chosen as the mnemonic
-widget. For instance, if the label is inside a button or menu item,
-the button or menu item will automatically become the mnemonic widget
+If [method@Gtk.Label.set_mnemonic_widget] is not called, then the first
+activatable ancestor of the `GtkLabel` will be chosen as the mnemonic
+widget. For instance, if the label is inside a button or menu item,
+the button or menu item will automatically become the mnemonic widget
and be activated by the mnemonic.
@@ -46194,21 +49378,22 @@ mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkLabel
+<return> the new `GtkLabel`
</return>
</function>
<function name="gtk_label_select_region">
<description>
Selects a range of characters in the label, if the label is selectable.
-See gtk_label_set_selectable(). If the label is not selectable,
+
+See [method@Gtk.Label.set_selectable]. If the label is not selectable,
this function has no effect. If @start_offset or
@end_offset are -1, then the end of the label will be substituted.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="start_offset">
@@ -46225,24 +49410,23 @@ this function has no effect. If @start_offset or
<function name="gtk_label_set_attributes">
<description>
-Sets a #PangoAttrList; the attributes in the list are applied to the
-label text.
+Apply attributes to the label text.
-The attributes set with this function will be applied
-and merged with any other attributes previously effected by way
-of the #GtkLabel:use-underline or #GtkLabel:use-markup properties.
-While it is not recommended to mix markup strings with manually set
-attributes, if you must; know that the attributes will be applied
-to the label after the markup string is parsed.
+The attributes set with this function will be applied and merged with
+any other attributes previously effected by way of the
+[property@Gtk.Label:use-underline] or [property@Gtk.Label:use-markup]
+properties. While it is not recommended to mix markup strings with
+manually set attributes, if you must; know that the attributes will
+be applied to the label after the markup string is parsed.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="attrs">
-<parameter_description> a #PangoAttrList, or %NULL
+<parameter_description> a [struct@Pango.AttrList], or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -46251,17 +49435,19 @@ to the label after the markup string is parsed.
<function name="gtk_label_set_ellipsize">
<description>
-Sets the mode used to ellipsize (add an ellipsis: "...") to the text
-if there is not enough space to render the entire string.
+Sets the mode used to ellipsizei the text.
+
+The text will be ellipsized if there is not enough space
+to render the entire string.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="mode">
-<parameter_description> a #PangoEllipsizeMode
+<parameter_description> a `PangoEllipsizeMode`
</parameter_description>
</parameter>
</parameters>
@@ -46276,11 +49462,11 @@ the context menu for @label.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="model">
-<parameter_description> a #GMenuModel
+<parameter_description> a `GMenuModel`
</parameter_description>
</parameter>
</parameters>
@@ -46290,20 +49476,22 @@ the context menu for @label.
<function name="gtk_label_set_justify">
<description>
Sets the alignment of the lines in the text of the label relative to
-each other. %GTK_JUSTIFY_LEFT is the default value when the widget is
-first created with gtk_label_new(). If you instead want to set the
-alignment of the label as a whole, use gtk_widget_set_halign() instead.
-gtk_label_set_justify() has no effect on labels containing only a
-single line.
+each other.
+
+%GTK_JUSTIFY_LEFT is the default value when the widget is first created
+with [ctor Gtk Label new]. If you instead want to set the alignment of
+the label as a whole, use [method@Gtk.Widget.set_halign] instead.
+[method@Gtk.Label.set_justify] has no effect on labels containing
+only a single line.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="jtype">
-<parameter_description> a #GtkJustification
+<parameter_description> a `GtkJustification`
</parameter_description>
</parameter>
</parameters>
@@ -46312,15 +49500,16 @@ single line.
<function name="gtk_label_set_label">
<description>
-Sets the text of the label. The label is interpreted as
-including embedded underlines and/or Pango markup depending
-on the values of the #GtkLabel:use-underline and
-#GtkLabel:use-markup properties.
+Sets the text of the label.
+
+The label is interpreted as including embedded underlines and/or Pango
+markup depending on the values of the [property@Gtk.Label:use-underline]
+and [property@Gtk.Label:use-markup] properties.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="str">
@@ -46334,14 +49523,15 @@ on the values of the #GtkLabel:use-underline and
<function name="gtk_label_set_lines">
<description>
Sets the number of lines to which an ellipsized, wrapping label
-should be limited. This has no effect if the label is not wrapping
-or ellipsized. Set this to -1 if you don’t want to limit the
-number of lines.
+should be limited.
+
+This has no effect if the label is not wrapping or ellipsized.
+Set this to -1 if you don’t want to limit the number of lines.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="lines">
@@ -46354,14 +49544,15 @@ number of lines.
<function name="gtk_label_set_markup">
<description>
-Parses @str which is marked up with the
-[Pango text markup language][PangoMarkupFormat], setting the
-label’s text and attribute list based on the parse results.
+Sets the labels text and attributes from markup.
-If the @str is external data, you may need to escape it with
-g_markup_escape_text() or g_markup_printf_escaped():
+The string must be marked up with Pango markup
+(see [func@Pango.parse_markup]).
-|[<!-- language="C" -->
+If the @str is external data, you may need to escape it
+with g_markup_escape_text() or g_markup_printf_escaped():
+
+```c
GtkWidget *self = gtk_label_new (NULL);
const char *str = "...";
const char *format = "<span style=\"italic\">\%s</span>";
@@ -46370,25 +49561,25 @@ char *markup;
markup = g_markup_printf_escaped (format, str);
gtk_label_set_markup (GTK_LABEL (self), markup);
g_free (markup);
-]|
+```
-This function will set the #GtkLabel:use-markup property to %TRUE as
-a side effect.
+This function will set the [property@Gtk.Label:use-markup] property
+to %TRUE as a side effect.
-If you set the label contents using the #GtkLabel:label property you
-should also ensure that you set the #GtkLabel:use-markup property
-accordingly.
+If you set the label contents using the [property@Gtk.Label:label]
+property you should also ensure that you set the
+[property@Gtk.Label:use-markup] property accordingly.
-See also: gtk_label_set_text()
+See also: [method@Gtk.Label.set_text]
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="str">
-<parameter_description> a markup string (see [Pango markup format][PangoMarkupFormat])
+<parameter_description> a markup string
</parameter_description>
</parameter>
</parameters>
@@ -46397,24 +49588,24 @@ See also: gtk_label_set_text()
<function name="gtk_label_set_markup_with_mnemonic">
<description>
-Parses @str which is marked up with the
-[Pango text markup language][PangoMarkupFormat],
+Sets the labels text, attributes and mnemonic from markup.
+
+Parses @str which is marked up with Pango markup (see [func@Pango.parse_markup]),
setting the label’s text and attribute list based on the parse results.
If characters in @str are preceded by an underscore, they are underlined
indicating that they represent a keyboard accelerator called a mnemonic.
The mnemonic key can be used to activate another widget, chosen
-automatically, or explicitly using gtk_label_set_mnemonic_widget().
+automatically, or explicitly using method@Gtk.Label.set_mnemonic_widget].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="str">
-<parameter_description> a markup string (see
-[Pango markup format][PangoMarkupFormat])
+<parameter_description> a markup string
</parameter_description>
</parameter>
</parameters>
@@ -46428,7 +49619,7 @@ Sets the desired maximum width in characters of @label to @n_chars.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="n_chars">
@@ -46441,25 +49632,28 @@ Sets the desired maximum width in characters of @label to @n_chars.
<function name="gtk_label_set_mnemonic_widget">
<description>
+Associate the label with its mnemonic target.
+
If the label has been set so that it has a mnemonic key (using
-i.e. gtk_label_set_markup_with_mnemonic(),
-gtk_label_set_text_with_mnemonic(), gtk_label_new_with_mnemonic()
-or the “use_underline” property) the label can be associated with a
-widget that is the target of the mnemonic. When the label is inside
-a widget (like a #GtkButton or a #GtkNotebook tab) it is
-automatically associated with the correct widget, but sometimes
-(i.e. when the target is a #GtkEntry next to the label) you need to
-set it explicitly using this function.
-
-The target widget will be accelerated by emitting the
-GtkWidget::mnemonic-activate signal on it. The default handler for
-this signal will activate the widget if there are no mnemonic collisions
+i.e. [method@Gtk.Label.set_markup_with_mnemonic],
+[method@Gtk.Label.set_text_with_mnemonic],
+[ctor@Gtk.Label.new_with_mnemonic]
+or the [property@Gtk.Label:use_underline] property) the label can be
+associated with a widget that is the target of the mnemonic. When the
+label is inside a widget (like a [class@Gtk.Button] or a
+[class@Gtk.Notebook] tab) it is automatically associated with the correct
+widget, but sometimes (i.e. when the target is a [class@Gtk.Entry] next to
+the label) you need to set it explicitly using this function.
+
+The target widget will be accelerated by emitting the
+[signal@GtkWidget::mnemonic-activate] signal on it. The default handler for
+this signal will activate the widget if there are no mnemonic collisions
and toggle focus between the colliding widgets otherwise.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="widget">
@@ -46472,13 +49666,15 @@ and toggle focus between the colliding widgets otherwise.
<function name="gtk_label_set_selectable">
<description>
-Selectable labels allow the user to select text from the label, for
-copy-and-paste.
+Makes text in the label selectable.
+
+Selectable labels allow the user to select text from the label,
+for copy-and-paste.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -46496,7 +49692,7 @@ Sets whether the label is in single line mode.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="single_line_mode">
@@ -46509,21 +49705,23 @@ Sets whether the label is in single line mode.
<function name="gtk_label_set_text">
<description>
-Sets the text within the #GtkLabel widget. It overwrites any text that
-was there before.
+Sets the text within the `GtkLabel` widget.
+
+It overwrites any text that was there before.
-This function will clear any previously set mnemonic accelerators, and
-set the #GtkLabel:use-underline property to %FALSE as a side effect.
+This function will clear any previously set mnemonic accelerators,
+and set the [property@Gtk.Label:use-underline property] to %FALSE as
+a side effect.
-This function will set the #GtkLabel:use-markup property to %FALSE
-as a side effect.
+This function will set the [property@Gtk.Label:use-markup] property
+to %FALSE as a side effect.
-See also: gtk_label_set_markup()
+See also: [method@Gtk.Label.set_markup]
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="str">
@@ -46537,15 +49735,16 @@ See also: gtk_label_set_markup()
<function name="gtk_label_set_text_with_mnemonic">
<description>
Sets the label’s text from the string @str.
+
If characters in @str are preceded by an underscore, they are underlined
indicating that they represent a keyboard accelerator called a mnemonic.
The mnemonic key can be used to activate another widget, chosen
-automatically, or explicitly using gtk_label_set_mnemonic_widget().
+automatically, or explicitly using [method@Gtk.Label.set_mnemonic_widget].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="str">
@@ -46558,14 +49757,14 @@ automatically, or explicitly using gtk_label_set_mnemonic_widget().
<function name="gtk_label_set_use_markup">
<description>
-Sets whether the text of the label contains markup in
-[Pango’s text markup language][PangoMarkupFormat].
-See gtk_label_set_markup().
+Sets whether the text of the label contains markup.
+
+See [method@Gtk.Label.set_markup].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -46578,13 +49777,12 @@ See gtk_label_set_markup().
<function name="gtk_label_set_use_underline">
<description>
-If true, an underline in the text indicates the next character should be
-used for the mnemonic accelerator key.
+Sets whether underlines in the text indicate mnemonics.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -46602,7 +49800,7 @@ Sets the desired width in characters of @label to @n_chars.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="n_chars">
@@ -46615,20 +49813,22 @@ Sets the desired width in characters of @label to @n_chars.
<function name="gtk_label_set_wrap">
<description>
-Toggles line wrapping within the #GtkLabel widget. %TRUE makes it break
-lines if text exceeds the widget’s size. %FALSE lets the text get cut off
-by the edge of the widget if it exceeds the widget size.
+Toggles line wrapping within the `GtkLabel` widget.
+
+%TRUE makes it break lines if text exceeds the widget’s size.
+%FALSE lets the text get cut off by the edge of the widget if
+it exceeds the widget size.
Note that setting line wrapping to %TRUE does not make the label
wrap at its parent container’s width, because GTK widgets
conceptually can’t make their requisition depend on the parent
container’s size. For a label that wraps at a specific position,
-set the label’s width using gtk_widget_set_size_request().
+set the label’s width using [method@Gtk.Widget.set_size_request].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="wrap">
@@ -46641,14 +49841,16 @@ set the label’s width using gtk_widget_set_size_request().
<function name="gtk_label_set_wrap_mode">
<description>
-If line wrapping is on (see gtk_label_set_wrap()) this controls how
-the line wrapping is done. The default is %PANGO_WRAP_WORD which means
-wrap on word boundaries.
+Controls how line wrapping is done.
+
+This only affects the label if line wrapping is on. (See
+[method@Gtk.Label.set_wrap]) The default is %PANGO_WRAP_WORD
+which means wrap on word boundaries.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="wrap_mode">
@@ -46661,12 +49863,14 @@ wrap on word boundaries.
<function name="gtk_label_set_xalign">
<description>
-Sets the #GtkLabel:xalign property for @label.
+Sets the `xalign` of the label.
+
+See the [property@Gtk.Label:xalign] property.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="xalign">
@@ -46679,12 +49883,14 @@ Sets the #GtkLabel:xalign property for @label.
<function name="gtk_label_set_yalign">
<description>
-Sets the #GtkLabel:yalign property for @label.
+Sets the `yalign` of the label.
+
+See the [property@Gtk.Label:yalign] property.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLabel
+<parameter_description> a `GtkLabel`
</parameter_description>
</parameter>
<parameter name="yalign">
@@ -46697,13 +49903,13 @@ Sets the #GtkLabel:yalign property for @label.
<function name="gtk_layout_child_get_child_widget">
<description>
-Retrieves the #GtkWidget associated to the given @layout_child.
+Retrieves the `GtkWidget` associated to the given @layout_child.
</description>
<parameters>
<parameter name="layout_child">
-<parameter_description> a #GtkLayoutChild
+<parameter_description> a `GtkLayoutChild`
</parameter_description>
</parameter>
</parameters>
@@ -46713,35 +49919,35 @@ Retrieves the #GtkWidget associated to the given @layout_child.
<function name="gtk_layout_child_get_layout_manager">
<description>
-Retrieves the #GtkLayoutManager instance that created the
+Retrieves the `GtkLayoutManager` instance that created the
given @layout_child.
</description>
<parameters>
<parameter name="layout_child">
-<parameter_description> a #GtkLayoutChild
+<parameter_description> a `GtkLayoutChild`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkLayoutManager
+<return> a `GtkLayoutManager`
</return>
</function>
<function name="gtk_layout_manager_allocate">
<description>
-This function assigns the given @width, @height, and @baseline to
+Assigns the given @width, @height, and @baseline to
a @widget, and computes the position and sizes of the children of
the @widget using the layout management policy of @manager.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GtkLayoutManager
+<parameter_description> a `GtkLayoutManager`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> the #GtkWidget using @manager
+<parameter_description> the `GtkWidget` using @manager
</parameter_description>
</parameter>
<parameter name="width">
@@ -46762,28 +49968,28 @@ the @widget using the layout management policy of @manager.
<function name="gtk_layout_manager_get_layout_child">
<description>
-Retrieves a #GtkLayoutChild instance for the #GtkLayoutManager, creating
-one if necessary.
+Retrieves a `GtkLayoutChild` instance for the `GtkLayoutManager`,
+creating one if necessary.
The @child widget must be a child of the widget using @manager.
-The #GtkLayoutChild instance is owned by the #GtkLayoutManager, and is
-guaranteed to exist as long as @child is a child of the #GtkWidget using
-the given #GtkLayoutManager.
+The `GtkLayoutChild` instance is owned by the `GtkLayoutManager`,
+and is guaranteed to exist as long as @child is a child of the
+`GtkWidget` using the given `GtkLayoutManager`.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GtkLayoutManager
+<parameter_description> a `GtkLayoutManager`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkLayoutChild
+<return> a `GtkLayoutChild`
</return>
</function>
@@ -46795,41 +50001,41 @@ Retrieves the request mode of @manager.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GtkLayoutManager
+<parameter_description> a `GtkLayoutManager`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkSizeRequestMode
+<return> a `GtkSizeRequestMode`
</return>
</function>
<function name="gtk_layout_manager_get_widget">
<description>
-Retrieves the #GtkWidget using the given #GtkLayoutManager.
+Retrieves the `GtkWidget` using the given `GtkLayoutManager`.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GtkLayoutManager
+<parameter_description> a `GtkLayoutManager`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkWidget
+<return> a `GtkWidget`
</return>
</function>
<function name="gtk_layout_manager_layout_changed">
<description>
-Queues a resize on the #GtkWidget using @manager, if any.
+Queues a resize on the `GtkWidget` using @manager, if any.
-This function should be called by subclasses of #GtkLayoutManager in
-response to changes to their layout management policies.
+This function should be called by subclasses of `GtkLayoutManager`
+in response to changes to their layout management policies.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GtkLayoutManager
+<parameter_description> a `GtkLayoutManager`
</parameter_description>
</parameter>
</parameters>
@@ -46841,17 +50047,17 @@ response to changes to their layout management policies.
Measures the size of the @widget using @manager, for the
given @orientation and size.
-See [GtkWidget's geometry management section][geometry-management] for
+See the [class@Gtk.Widget] documentation on layout management for
more details.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GtkLayoutManager
+<parameter_description> a `GtkLayoutManager`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> the #GtkWidget using @manager
+<parameter_description> the `GtkWidget` using @manager
</parameter_description>
</parameter>
<parameter name="orientation">
@@ -46894,17 +50100,19 @@ natural size
<function name="gtk_level_bar_add_offset_value">
<description>
Adds a new offset marker on @self at the position specified by @value.
+
When the bar value is in the interval topped by @value (or between @value
-and #GtkLevelBar:max-value in case the offset is the last one on the bar)
-a style class named `level-`@name will be applied
+and [property@Gtk.LevelBar:max-value] in case the offset is the last one
+on the bar) a style class named `level-`@name will be applied
when rendering the level bar fill.
+
If another offset marker named @name exists, its value will be
replaced by @value.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLevelBar
+<parameter_description> a `GtkLevelBar`
</parameter_description>
</parameter>
<parameter name="name">
@@ -46921,13 +50129,13 @@ replaced by @value.
<function name="gtk_level_bar_get_inverted">
<description>
-Return the value of the #GtkLevelBar:inverted property.
+Returns whether the levelbar is inverted.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLevelBar
+<parameter_description> a `GtkLevelBar`
</parameter_description>
</parameter>
</parameters>
@@ -46937,13 +50145,13 @@ Return the value of the #GtkLevelBar:inverted property.
<function name="gtk_level_bar_get_max_value">
<description>
-Returns the value of the #GtkLevelBar:max-value property.
+Returns the `max-value` of the `GtkLevelBar`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLevelBar
+<parameter_description> a `GtkLevelBar`
</parameter_description>
</parameter>
</parameters>
@@ -46953,13 +50161,13 @@ Returns the value of the #GtkLevelBar:max-value property.
<function name="gtk_level_bar_get_min_value">
<description>
-Returns the value of the #GtkLevelBar:min-value property.
+Returns the `min-value of the `GtkLevelBar`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLevelBar
+<parameter_description> a `GtkLevelBar`
</parameter_description>
</parameter>
</parameters>
@@ -46969,30 +50177,29 @@ Returns the value of the #GtkLevelBar:min-value property.
<function name="gtk_level_bar_get_mode">
<description>
-Returns the value of the #GtkLevelBar:mode property.
+Returns the `mode` of the `GtkLevelBar`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLevelBar
+<parameter_description> a `GtkLevelBar`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkLevelBarMode
+<return> a `GtkLevelBarMode`
</return>
</function>
<function name="gtk_level_bar_get_offset_value">
<description>
-Fetches the value specified for the offset marker @name in @self,
-returning %TRUE in case an offset named @name was found.
+Fetches the value specified for the offset marker @name in @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLevelBar
+<parameter_description> a `GtkLevelBar`
</parameter_description>
</parameter>
<parameter name="name">
@@ -47010,37 +50217,36 @@ returning %TRUE in case an offset named @name was found.
<function name="gtk_level_bar_get_value">
<description>
-Returns the value of the #GtkLevelBar:value property.
+Returns the `value` of the `GtkLevelBar`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLevelBar
+<parameter_description> a `GtkLevelBar`
</parameter_description>
</parameter>
</parameters>
<return> a value in the interval between
-#GtkLevelBar:min-value and #GtkLevelBar:max-value
+`GtkLevelBar`:min-value and `GtkLevelBar`:max-value
</return>
</function>
<function name="gtk_level_bar_new">
<description>
-Creates a new #GtkLevelBar.
+Creates a new `GtkLevelBar`.
</description>
<parameters>
</parameters>
-<return> a #GtkLevelBar.
+<return> a `GtkLevelBar`.
</return>
</function>
<function name="gtk_level_bar_new_for_interval">
<description>
-Utility constructor that creates a new #GtkLevelBar for the specified
-interval.
+Creates a new `GtkLevelBar` for the specified interval.
</description>
@@ -47054,19 +50260,21 @@ interval.
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkLevelBar
+<return> a `GtkLevelBar`
</return>
</function>
<function name="gtk_level_bar_remove_offset_value">
<description>
-Removes an offset marker previously added with
-gtk_level_bar_add_offset_value().
+Removes an offset marker from a `GtkLevelBar`.
+
+The marker must have been previously added with
+[method@Gtk.LevelBar.add_offset_value].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLevelBar
+<parameter_description> a `GtkLevelBar`
</parameter_description>
</parameter>
<parameter name="name">
@@ -47079,12 +50287,12 @@ gtk_level_bar_add_offset_value().
<function name="gtk_level_bar_set_inverted">
<description>
-Sets the value of the #GtkLevelBar:inverted property.
+Sets whether the `GtkLevelBar` is inverted.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLevelBar
+<parameter_description> a `GtkLevelBar`
</parameter_description>
</parameter>
<parameter name="inverted">
@@ -47097,7 +50305,7 @@ Sets the value of the #GtkLevelBar:inverted property.
<function name="gtk_level_bar_set_max_value">
<description>
-Sets the value of the #GtkLevelBar:max-value property.
+Sets the `max-value` of the `GtkLevelBar`.
You probably want to update preexisting level offsets after calling
this function.
@@ -47105,7 +50313,7 @@ this function.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLevelBar
+<parameter_description> a `GtkLevelBar`
</parameter_description>
</parameter>
<parameter name="value">
@@ -47118,7 +50326,7 @@ this function.
<function name="gtk_level_bar_set_min_value">
<description>
-Sets the value of the #GtkLevelBar:min-value property.
+Sets the `min-value` of the `GtkLevelBar`.
You probably want to update preexisting level offsets after calling
this function.
@@ -47126,7 +50334,7 @@ this function.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLevelBar
+<parameter_description> a `GtkLevelBar`
</parameter_description>
</parameter>
<parameter name="value">
@@ -47139,16 +50347,16 @@ this function.
<function name="gtk_level_bar_set_mode">
<description>
-Sets the value of the #GtkLevelBar:mode property.
+Sets the `mode` of the `GtkLevelBar`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLevelBar
+<parameter_description> a `GtkLevelBar`
</parameter_description>
</parameter>
<parameter name="mode">
-<parameter_description> a #GtkLevelBarMode
+<parameter_description> a `GtkLevelBarMode`
</parameter_description>
</parameter>
</parameters>
@@ -47157,17 +50365,17 @@ Sets the value of the #GtkLevelBar:mode property.
<function name="gtk_level_bar_set_value">
<description>
-Sets the value of the #GtkLevelBar:value property.
+Sets the value of the `GtkLevelBar`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkLevelBar
+<parameter_description> a `GtkLevelBar`
</parameter_description>
</parameter>
<parameter name="value">
<parameter_description> a value in the interval between
-#GtkLevelBar:min-value and #GtkLevelBar:max-value
+[property@Gtk.LevelBar:min-value] and [property@Gtk.LevelBar:max-value]
</parameter_description>
</parameter>
</parameters>
@@ -47176,34 +50384,35 @@ Sets the value of the #GtkLevelBar:value property.
<function name="gtk_link_button_get_uri">
<description>
-Retrieves the URI set using gtk_link_button_set_uri().
+Retrieves the URI of the `GtkLinkButton`.
</description>
<parameters>
<parameter name="link_button">
-<parameter_description> a #GtkLinkButton
+<parameter_description> a `GtkLinkButton`
</parameter_description>
</parameter>
</parameters>
-<return> a valid URI. The returned string is owned by the link button
+<return> a valid URI. The returned string is owned by the link button
and should not be modified or freed.
</return>
</function>
<function name="gtk_link_button_get_visited">
<description>
-Retrieves the “visited” state of the URI where the #GtkLinkButton
-points. The button becomes visited when it is clicked. If the URI
+Retrieves the “visited” state of the `GtkLinkButton`.
+
+The button becomes visited when it is clicked. If the URI
is changed on the button, the “visited” state is unset again.
-The state may also be changed using gtk_link_button_set_visited().
+The state may also be changed using [method@Gtk.LinkButton.set_visited].
</description>
<parameters>
<parameter name="link_button">
-<parameter_description> a #GtkLinkButton
+<parameter_description> a `GtkLinkButton`
</parameter_description>
</parameter>
</parameters>
@@ -47213,7 +50422,7 @@ The state may also be changed using gtk_link_button_set_visited().
<function name="gtk_link_button_new">
<description>
-Creates a new #GtkLinkButton with the URI as its text.
+Creates a new `GtkLinkButton` with the URI as its text.
</description>
@@ -47229,7 +50438,7 @@ Creates a new #GtkLinkButton with the URI as its text.
<function name="gtk_link_button_new_with_label">
<description>
-Creates a new #GtkLinkButton containing a label.
+Creates a new `GtkLinkButton` containing a label.
</description>
@@ -47249,13 +50458,14 @@ Creates a new #GtkLinkButton containing a label.
<function name="gtk_link_button_set_uri">
<description>
-Sets @uri as the URI where the #GtkLinkButton points. As a side-effect
-this unsets the “visited” state of the button.
+Sets @uri as the URI where the `GtkLinkButton` points.
+
+As a side-effect this unsets the “visited” state of the button.
</description>
<parameters>
<parameter name="link_button">
-<parameter_description> a #GtkLinkButton
+<parameter_description> a `GtkLinkButton`
</parameter_description>
</parameter>
<parameter name="uri">
@@ -47268,13 +50478,14 @@ this unsets the “visited” state of the button.
<function name="gtk_link_button_set_visited">
<description>
-Sets the “visited” state of the URI where the #GtkLinkButton
-points. See gtk_link_button_get_visited() for more details.
+Sets the “visited” state of the `GtkLinkButton`.
+
+See [method@Gtk.LinkButton.get_visited] for more details.
</description>
<parameters>
<parameter name="link_button">
-<parameter_description> a #GtkLinkButton
+<parameter_description> a `GtkLinkButton`
</parameter_description>
</parameter>
<parameter name="visited">
@@ -47359,17 +50570,19 @@ offset.
<function name="gtk_list_box_append">
<description>
-Append a widget to the list. If a sort function is set, the widget will
+Append a widget to the list.
+
+If a sort function is set, the widget will
actually be inserted at the calculated position.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to add
+<parameter_description> the `GtkWidget` to add
</parameter_description>
</parameter>
</parameters>
@@ -47388,21 +50601,20 @@ represent items from @model. @box is updated whenever @model changes.
If @model is %NULL, @box is left empty.
It is undefined to add or remove widgets directly (for example, with
-gtk_list_box_insert()) while @box is bound to a
-model.
+[method@Gtk.ListBox.insert]) while @box is bound to a model.
Note that using a model is incompatible with the filtering and sorting
-functionality in GtkListBox. When using a model, filtering and sorting
+functionality in `GtkListBox`. When using a model, filtering and sorting
should be implemented by the model.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="model">
-<parameter_description> the #GListModel to be bound to @box
+<parameter_description> the `GListModel` to be bound to @box
</parameter_description>
</parameter>
<parameter name="create_widget_func">
@@ -47424,9 +50636,11 @@ or %NULL in case you also passed %NULL as @model
<function name="gtk_list_box_drag_highlight_row">
<description>
-This is a helper function for implementing DnD onto a #GtkListBox.
+Add a drag highlight to a row.
+
+This is a helper function for implementing DnD onto a `GtkListBox`.
The passed in @row will be highlighted by setting the
-#GTK_STATE_FLAG_DROP_ACTIVE state and any previously highlighted
+%GTK_STATE_FLAG_DROP_ACTIVE state and any previously highlighted
row will be unhighlighted.
The row will also be unhighlighted when the widget gets
@@ -47435,11 +50649,11 @@ a drag leave event.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="row">
-<parameter_description> a #GtkListBoxRow
+<parameter_description> a `GtkListBoxRow`
</parameter_description>
</parameter>
</parameters>
@@ -47448,13 +50662,13 @@ a drag leave event.
<function name="gtk_list_box_drag_unhighlight_row">
<description>
-If a row has previously been highlighted via gtk_list_box_drag_highlight_row()
+If a row has previously been highlighted via gtk_list_box_drag_highlight_row(),
it will have the highlight removed.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
</parameters>
@@ -47469,7 +50683,7 @@ Returns whether rows activate on single clicks.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
</parameters>
@@ -47486,7 +50700,7 @@ for vertical scrolling.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
</parameters>
@@ -47497,14 +50711,15 @@ for vertical scrolling.
<function name="gtk_list_box_get_row_at_index">
<description>
Gets the n-th child in the list (not counting headers).
-If @_index is negative or larger than the number of items in the
+
+If @index_ is negative or larger than the number of items in the
list, %NULL is returned.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="index_">
@@ -47512,7 +50727,7 @@ list, %NULL is returned.
</parameter_description>
</parameter>
</parameters>
-<return> the child #GtkWidget or %NULL
+<return> the child `GtkWidget` or %NULL
</return>
</function>
@@ -47524,7 +50739,7 @@ Gets the row at the @y position.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="y">
@@ -47539,21 +50754,21 @@ in case no row exists for the given y coordinate.
<function name="gtk_list_box_get_selected_row">
<description>
-Gets the selected row.
+Gets the selected row, or %NULL if no rows are selected.
Note that the box may allow multiple selection, in which
-case you should use gtk_list_box_selected_foreach() to
+case you should use [method@Gtk.ListBox.selected_foreach] to
find all selected rows.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
</parameters>
-<return> the selected row
+<return> the selected row or %NULL
</return>
</function>
@@ -47565,12 +50780,12 @@ Creates a list of all selected children.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
</parameters>
<return>
-A #GList containing the #GtkWidget for each selected child.
+A `GList` containing the `GtkWidget` for each selected child.
Free with g_list_free() when done.
</return>
</function>
@@ -47583,11 +50798,11 @@ Gets the selection mode of the listbox.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkSelectionMode
+<return> a `GtkSelectionMode`
</return>
</function>
@@ -47600,7 +50815,7 @@ between rows.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
</parameters>
@@ -47610,7 +50825,9 @@ between rows.
<function name="gtk_list_box_insert">
<description>
-Insert the @child into the @box at @position. If a sort function is
+Insert the @child into the @box at @position.
+
+If a sort function is
set, the widget will actually be inserted at the calculated position.
If @position is -1, or larger than the total number of items in the
@@ -47619,11 +50836,11 @@ If @position is -1, or larger than the total number of items in the
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to add
+<parameter_description> the `GtkWidget` to add
</parameter_description>
</parameter>
<parameter name="position">
@@ -47636,7 +50853,9 @@ If @position is -1, or larger than the total number of items in the
<function name="gtk_list_box_invalidate_filter">
<description>
-Update the filtering for all rows. Call this when result
+Update the filtering for all rows.
+
+Call this when result
of the filter function on the @box is changed due
to an external factor. For instance, this would be used
if the filter function just looked for a specific search
@@ -47645,7 +50864,7 @@ string and the entry with the search string has changed.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
</parameters>
@@ -47654,14 +50873,16 @@ string and the entry with the search string has changed.
<function name="gtk_list_box_invalidate_headers">
<description>
-Update the separators for all rows. Call this when result
+Update the separators for all rows.
+
+Call this when result
of the header function on the @box is changed due
to an external factor.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
</parameters>
@@ -47670,14 +50891,16 @@ to an external factor.
<function name="gtk_list_box_invalidate_sort">
<description>
-Update the sorting for all rows. Call this when result
+Update the sorting for all rows.
+
+Call this when result
of the sort function on the @box is changed due
to an external factor.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
</parameters>
@@ -47686,29 +50909,31 @@ to an external factor.
<function name="gtk_list_box_new">
<description>
-Creates a new #GtkListBox container.
+Creates a new `GtkListBox` container.
</description>
<parameters>
</parameters>
-<return> a new #GtkListBox
+<return> a new `GtkListBox`
</return>
</function>
<function name="gtk_list_box_prepend">
<description>
-Prepend a widget to the list. If a sort function is set, the widget will
+Prepend a widget to the list.
+
+If a sort function is set, the widget will
actually be inserted at the calculated position.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to add
+<parameter_description> the `GtkWidget` to add
</parameter_description>
</parameter>
</parameters>
@@ -47722,7 +50947,7 @@ Removes a child from @box.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="child">
@@ -47736,7 +50961,9 @@ Removes a child from @box.
<function name="gtk_list_box_row_changed">
<description>
Marks @row as changed, causing any state that depends on this
-to be updated. This affects sorting, filtering and headers.
+to be updated.
+
+This affects sorting, filtering and headers.
Note that calls to this method must be in sync with the data
used for the row functions. For instance, if the list is
@@ -47749,13 +50976,13 @@ of the rows will be wrong.
This generally means that if you don’t fully control the data
model you have to duplicate the data that affects the listbox
row functions into the row widgets themselves. Another alternative
-is to call gtk_list_box_invalidate_sort() on any model change,
+is to call [method@Gtk.ListBox.invalidate_sort] on any model change,
but that is more expensive.
</description>
<parameters>
<parameter name="row">
-<parameter_description> a #GtkListBoxRow
+<parameter_description> a `GtkListBoxRow`
</parameter_description>
</parameter>
</parameters>
@@ -47764,14 +50991,13 @@ but that is more expensive.
<function name="gtk_list_box_row_get_activatable">
<description>
-Gets the value of the #GtkListBoxRow:activatable property
-for this row.
+Gets whether the row is activatable.
</description>
<parameters>
<parameter name="row">
-<parameter_description> a #GtkListBoxRow
+<parameter_description> a `GtkListBoxRow`
</parameter_description>
</parameter>
</parameters>
@@ -47787,7 +51013,7 @@ Gets the child widget of @row.
</description>
<parameters>
<parameter name="row">
-<parameter_description> a #GtkListBoxRow
+<parameter_description> a `GtkListBoxRow`
</parameter_description>
</parameter>
</parameters>
@@ -47797,15 +51023,18 @@ Gets the child widget of @row.
<function name="gtk_list_box_row_get_header">
<description>
-Returns the current header of the @row. This can be used
-in a #GtkListBoxUpdateHeaderFunc to see if there is a header
-set already, and if so to update the state of it.
+Returns the current header of the @row.
+
+This can be used
+in a [callback@Gtk.ListBoxUpdateHeaderFunc] to see if
+there is a header set already, and if so to update
+the state of it.
</description>
<parameters>
<parameter name="row">
-<parameter_description> a #GtkListBoxRow
+<parameter_description> a `GtkListBoxRow`
</parameter_description>
</parameter>
</parameters>
@@ -47815,13 +51044,13 @@ set already, and if so to update the state of it.
<function name="gtk_list_box_row_get_index">
<description>
-Gets the current index of the @row in its #GtkListBox container.
+Gets the current index of the @row in its `GtkListBox` container.
</description>
<parameters>
<parameter name="row">
-<parameter_description> a #GtkListBoxRow
+<parameter_description> a `GtkListBoxRow`
</parameter_description>
</parameter>
</parameters>
@@ -47831,14 +51060,13 @@ Gets the current index of the @row in its #GtkListBox container.
<function name="gtk_list_box_row_get_selectable">
<description>
-Gets the value of the #GtkListBoxRow:selectable property
-for this row.
+Gets whether the row can be selected.
</description>
<parameters>
<parameter name="row">
-<parameter_description> a #GtkListBoxRow
+<parameter_description> a `GtkListBoxRow`
</parameter_description>
</parameter>
</parameters>
@@ -47849,13 +51077,13 @@ for this row.
<function name="gtk_list_box_row_is_selected">
<description>
Returns whether the child is currently selected in its
-#GtkListBox container.
+`GtkListBox` container.
</description>
<parameters>
<parameter name="row">
-<parameter_description> a #GtkListBoxRow
+<parameter_description> a `GtkListBoxRow`
</parameter_description>
</parameter>
</parameters>
@@ -47865,24 +51093,24 @@ Returns whether the child is currently selected in its
<function name="gtk_list_box_row_new">
<description>
-Creates a new #GtkListBoxRow, to be used as a child of a #GtkListBox.
+Creates a new `GtkListBoxRow`.
</description>
<parameters>
</parameters>
-<return> a new #GtkListBoxRow
+<return> a new `GtkListBoxRow`
</return>
</function>
<function name="gtk_list_box_row_set_activatable">
<description>
-Set the #GtkListBoxRow:activatable property for this row.
+Set whether the row is activatable.
</description>
<parameters>
<parameter name="row">
-<parameter_description> a #GtkListBoxRow
+<parameter_description> a `GtkListBoxRow`
</parameter_description>
</parameter>
<parameter name="activatable">
@@ -47900,7 +51128,7 @@ Sets the child widget of @self.
</description>
<parameters>
<parameter name="row">
-<parameter_description> a #GtkListBoxRow
+<parameter_description> a `GtkListBoxRow`
</parameter_description>
</parameter>
<parameter name="child">
@@ -47913,14 +51141,17 @@ Sets the child widget of @self.
<function name="gtk_list_box_row_set_header">
<description>
-Sets the current header of the @row. This is only allowed to be called
-from a #GtkListBoxUpdateHeaderFunc. It will replace any existing
-header in the row, and be shown in front of the row in the listbox.
+Sets the current header of the @row.
+
+This is only allowed to be called
+from a [callback@Gtk.ListBoxUpdateHeaderFunc].
+It will replace any existing header in the row,
+and be shown in front of the row in the listbox.
</description>
<parameters>
<parameter name="row">
-<parameter_description> a #GtkListBoxRow
+<parameter_description> a `GtkListBoxRow`
</parameter_description>
</parameter>
<parameter name="header">
@@ -47933,12 +51164,12 @@ header in the row, and be shown in front of the row in the listbox.
<function name="gtk_list_box_row_set_selectable">
<description>
-Set the #GtkListBoxRow:selectable property for this row.
+Set whether the row can be selected.
</description>
<parameters>
<parameter name="row">
-<parameter_description> a #GtkListBoxRow
+<parameter_description> a `GtkListBoxRow`
</parameter_description>
</parameter>
<parameter name="selectable">
@@ -47956,7 +51187,7 @@ Select all children of @box, if the selection mode allows it.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
</parameters>
@@ -47970,7 +51201,7 @@ Make @row the currently selected row.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="row">
@@ -47990,7 +51221,7 @@ Note that the selection cannot be modified from within this function.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="func">
@@ -48013,7 +51244,7 @@ otherwise you need to double-click.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="single">
@@ -48027,18 +51258,20 @@ otherwise you need to double-click.
<function name="gtk_list_box_set_adjustment">
<description>
Sets the adjustment (if any) that the widget uses to
-for vertical scrolling. For instance, this is used
-to get the page size for PageUp/Down key handling.
+for vertical scrolling.
+
+For instance, this is used to get the page size for
+PageUp/Down key handling.
In the normal case when the @box is packed inside
-a #GtkScrolledWindow the adjustment from that will
+a `GtkScrolledWindow` the adjustment from that will
be picked up automatically, so there is no need
to manually do that.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="adjustment">
@@ -48052,20 +51285,23 @@ to manually do that.
<function name="gtk_list_box_set_filter_func">
<description>
By setting a filter function on the @box one can decide dynamically which
-of the rows to show. For instance, to implement a search function on a list that
+of the rows to show.
+
+For instance, to implement a search function on a list that
filters the original list to only show the matching rows.
-The @filter_func will be called for each row after the call, and it will
-continue to be called each time a row changes (via gtk_list_box_row_changed()) or
-when gtk_list_box_invalidate_filter() is called.
+The @filter_func will be called for each row after the call, and
+it will continue to be called each time a row changes (via
+[method@Gtk.ListBoxRow.changed]) or when [method@Gtk.ListBox.invalidate_filter]
+is called.
Note that using a filter function is incompatible with using a model
-(see gtk_list_box_bind_model()).
+(see [method@Gtk.ListBox.bind_model]).
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="filter_func">
@@ -48086,29 +51322,36 @@ Note that using a filter function is incompatible with using a model
<function name="gtk_list_box_set_header_func">
<description>
+Sets a header function.
+
By setting a header function on the @box one can dynamically add headers
-in front of rows, depending on the contents of the row and its position in the list.
-For instance, one could use it to add headers in front of the first item of a
-new kind, in a list sorted by the kind.
+in front of rows, depending on the contents of the row and its position
+in the list.
+
+For instance, one could use it to add headers in front of the first item
+of a new kind, in a list sorted by the kind.
-The @update_header can look at the current header widget using gtk_list_box_row_get_header()
-and either update the state of the widget as needed, or set a new one using
-gtk_list_box_row_set_header(). If no header is needed, set the header to %NULL.
+The @update_header can look at the current header widget using
+[method@Gtk.ListBoxRow.get_header] and either update the state of the widget
+as needed, or set a new one using [method@Gtk.ListBoxRow.set_header]. If no
+header is needed, set the header to %NULL.
-Note that you may get many calls @update_header to this for a particular row when e.g.
-changing things that don’t affect the header. In this case it is important for performance
-to not blindly replace an existing header with an identical one.
+Note that you may get many calls @update_header to this for a particular
+row when e.g. changing things that don’t affect the header. In this case
+it is important for performance to not blindly replace an existing header
+with an identical one.
-The @update_header function will be called for each row after the call, and it will
-continue to be called each time a row changes (via gtk_list_box_row_changed()) and when
-the row before changes (either by gtk_list_box_row_changed() on the previous row, or when
-the previous row becomes a different row). It is also called for all rows when
-gtk_list_box_invalidate_headers() is called.
+The @update_header function will be called for each row after the call,
+and it will continue to be called each time a row changes (via
+[method@Gtk.ListBoxRow.changed]) and when the row before changes (either
+by [method@Gtk.ListBoxRow.changed] on the previous row, or when the previous
+row becomes a different row). It is also called for all rows when
+[method@Gtk.ListBox.invalidate_headers] is called.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="update_header">
@@ -48135,7 +51378,7 @@ it doesn't display any visible children.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="placeholder">
@@ -48149,16 +51392,15 @@ it doesn't display any visible children.
<function name="gtk_list_box_set_selection_mode">
<description>
Sets how selection works in the listbox.
-See #GtkSelectionMode for details.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="mode">
-<parameter_description> The #GtkSelectionMode
+<parameter_description> The `GtkSelectionMode`
</parameter_description>
</parameter>
</parameters>
@@ -48173,7 +51415,7 @@ between rows.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="show_separators">
@@ -48186,20 +51428,23 @@ between rows.
<function name="gtk_list_box_set_sort_func">
<description>
-By setting a sort function on the @box one can dynamically reorder the rows
-of the list, based on the contents of the rows.
+Sets a sort function.
-The @sort_func will be called for each row after the call, and will continue to
-be called each time a row changes (via gtk_list_box_row_changed()) and when
-gtk_list_box_invalidate_sort() is called.
+By setting a sort function on the @box one can dynamically reorder
+the rows of the list, based on the contents of the rows.
+
+The @sort_func will be called for each row after the call, and will
+continue to be called each time a row changes (via
+[method@Gtk.ListBoxRow.changed]) and when [method@Gtk.ListBox.invalidate_sort]
+is called.
Note that using a sort function is incompatible with using a model
-(see gtk_list_box_bind_model()).
+(see [method@Gtk.ListBox.bind_model]).
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="sort_func">
@@ -48225,7 +51470,7 @@ Unselect all children of @box, if the selection mode allows it.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
</parameters>
@@ -48239,7 +51484,7 @@ Unselects a single row of @box, if the selection mode allows it.
</description>
<parameters>
<parameter name="box">
-<parameter_description> a #GtkListBox
+<parameter_description> a `GtkListBox`
</parameter_description>
</parameter>
<parameter name="row">
@@ -48259,7 +51504,7 @@ gtk_list_item_set_activatable().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListItem
+<parameter_description> a `GtkListItem`
</parameter_description>
</parameter>
</parameters>
@@ -48276,7 +51521,7 @@ Gets the child previously set via gtk_list_item_set_child() or
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListItem
+<parameter_description> a `GtkListItem`
</parameter_description>
</parameter>
</parameters>
@@ -48286,14 +51531,15 @@ Gets the child previously set via gtk_list_item_set_child() or
<function name="gtk_list_item_get_item">
<description>
-Gets the item that is currently displayed in model that @self is
-currently bound to or %NULL if @self is unbound.
+Gets the model item that associated with @self.
+
+If @self is unbound, this function returns %NULL.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListItem
+<parameter_description> a `GtkListItem`
</parameter_description>
</parameter>
</parameters>
@@ -48304,13 +51550,14 @@ currently bound to or %NULL if @self is unbound.
<function name="gtk_list_item_get_position">
<description>
Gets the position in the model that @self currently displays.
+
If @self is unbound, %GTK_INVALID_LIST_POSITION is returned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListItem
+<parameter_description> a `GtkListItem`
</parameter_description>
</parameter>
</parameters>
@@ -48323,13 +51570,13 @@ If @self is unbound, %GTK_INVALID_LIST_POSITION is returned.
Checks if a list item has been set to be selectable via
gtk_list_item_set_selectable().
-Do not confuse this function with gtk_list_item_get_selected().
+Do not confuse this function with [method@Gtk.ListItem.get_selected].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListItem
+<parameter_description> a `GtkListItem`
</parameter_description>
</parameter>
</parameters>
@@ -48339,15 +51586,16 @@ Do not confuse this function with gtk_list_item_get_selected().
<function name="gtk_list_item_get_selected">
<description>
-Checks if the item is displayed as selected. The selected state is
-maintained by the container and its list model and cannot be set
-otherwise.
+Checks if the item is displayed as selected.
+
+The selected state is maintained by the liste widget and its model
+and cannot be set otherwise.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListItem
+<parameter_description> a `GtkListItem`
</parameter_description>
</parameter>
</parameters>
@@ -48444,15 +51692,15 @@ Sets @self to be activatable.
If an item is activatable, double-clicking on the item, using
the Return key or calling gtk_widget_activate() will activate
the item. Activating instructs the containing view to handle
-activation. #GtkListView for example will be emitting the
-#GtkListView::activate signal.
+activation. `GtkListView` for example will be emitting the
+[signal@Gtk.ListView::activate] signal.
-By default, list items are activatable
+By default, list items are activatable.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListItem
+<parameter_description> a `GtkListItem`
</parameter_description>
</parameter>
<parameter name="activatable">
@@ -48474,7 +51722,7 @@ binding it multiple times.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListItem
+<parameter_description> a `GtkListItem`
</parameter_description>
</parameter>
<parameter name="child">
@@ -48487,13 +51735,14 @@ binding it multiple times.
<function name="gtk_list_item_set_selectable">
<description>
-Sets @self to be selectable. If an item is selectable, clicking
-on the item or using the keyboard will try to select or unselect
-the item. If this succeeds is up to the model to determine, as
-it is managing the selected state.
+Sets @self to be selectable.
+
+If an item is selectable, clicking on the item or using the keyboard
+will try to select or unselect the item. If this succeeds is up to
+the model to determine, as it is managing the selected state.
Note that this means that making an item non-selectable has no
-influence on the selected state at all. A non-selectable item
+influence on the selected state at all. A non-selectable item
may still be selected.
By default, list items are selectable. When rebinding them to
@@ -48502,7 +51751,7 @@ a new item, they will also be reset to be selectable by GTK.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListItem
+<parameter_description> a `GtkListItem`
</parameter_description>
</parameter>
<parameter name="selectable">
@@ -48637,7 +51886,8 @@ values given to this function.
Calling
`gtk_list_store_insert_with_values (list_store, iter, position...)`
-has the same effect as calling
+has the same effect as calling:
+
|[<!-- language="C" -->
static void
insert_value (GtkListStore *list_store,
@@ -48651,12 +51901,15 @@ iter
);
}
]|
-with the difference that the former will only emit a row_inserted signal,
-while the latter will emit row_inserted, row_changed and, if the list store
-is sorted, rows_reordered. Since emitting the rows_reordered signal
-repeatedly can affect the performance of the program,
-gtk_list_store_insert_with_values() should generally be preferred when
-inserting rows in a sorted list store.
+
+with the difference that the former will only emit #GtkTreeModel::row-inserted
+once, while the latter will emit #GtkTreeModel::row-inserted,
+#GtkTreeModel::row-changed and, if the list store is sorted,
+#GtkTreeModel::rows-reordered for every inserted value.
+
+Since emitting the #GtkTreeModel::rows-reordered signal repeatedly can
+affect the performance of the program, gtk_list_store_insert_with_values()
+should generally be preferred when inserting rows in a sorted list store.
</description>
<parameters>
@@ -48665,7 +51918,7 @@ inserting rows in a sorted list store.
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> An unset #GtkTreeIter to set to the new row, or %NULL
+<parameter_description> An unset #GtkTreeIter to set to the new row
</parameter_description>
</parameter>
<parameter name="position">
@@ -48685,8 +51938,9 @@ rows
<description>
A variant of gtk_list_store_insert_with_values() which
takes the columns and values as two arrays, instead of
-varargs. This function is mainly intended for
-language-bindings.
+varargs.
+
+This function is mainly intended for language-bindings.
</description>
<parameters>
@@ -48695,7 +51949,7 @@ language-bindings.
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> An unset #GtkTreeIter to set to the new row, or %NULL.
+<parameter_description> An unset #GtkTreeIter to set to the new row
</parameter_description>
</parameter>
<parameter name="position">
@@ -49073,7 +52327,7 @@ Returns whether rows can be selected by dragging with the mouse.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListView
+<parameter_description> a `GtkListView`
</parameter_description>
</parameter>
</parameters>
@@ -49089,7 +52343,7 @@ Gets the factory that's currently used to populate list items.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListView
+<parameter_description> a `GtkListView`
</parameter_description>
</parameter>
</parameters>
@@ -49105,7 +52359,7 @@ Gets the model that's currently used to read the items displayed.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListView
+<parameter_description> a `GtkListView`
</parameter_description>
</parameter>
</parameters>
@@ -49122,7 +52376,7 @@ between rows.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListView
+<parameter_description> a `GtkListView`
</parameter_description>
</parameter>
</parameters>
@@ -49139,7 +52393,7 @@ selected on hover.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListView
+<parameter_description> a `GtkListView`
</parameter_description>
</parameter>
</parameters>
@@ -49149,12 +52403,12 @@ selected on hover.
<function name="gtk_list_view_new">
<description>
-Creates a new #GtkListView that uses the given @factory for
+Creates a new `GtkListView` that uses the given @factory for
mapping items to widgets.
The function takes ownership of the
arguments, so you can write code like
-```
+```c
list_view = gtk_list_view_new (create_model (),
gtk_builder_list_item_factory_new_from_resource ("/resource.ui"));
```
@@ -49171,7 +52425,7 @@ gtk_builder_list_item_factory_new_from_resource ("/resource.ui"));
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkListView using the given @model and @factory
+<return> a new `GtkListView` using the given @model and @factory
</return>
</function>
@@ -49182,7 +52436,7 @@ Sets whether selections can be changed by dragging with the mouse.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListView
+<parameter_description> a `GtkListView`
</parameter_description>
</parameter>
<parameter name="enable_rubberband">
@@ -49195,12 +52449,12 @@ Sets whether selections can be changed by dragging with the mouse.
<function name="gtk_list_view_set_factory">
<description>
-Sets the #GtkListItemFactory to use for populating list items.
+Sets the `GtkListItemFactory` to use for populating list items.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListView
+<parameter_description> a `GtkListView`
</parameter_description>
</parameter>
<parameter name="factory">
@@ -49213,12 +52467,14 @@ Sets the #GtkListItemFactory to use for populating list items.
<function name="gtk_list_view_set_model">
<description>
-Sets the #GtkSelectionModel to use.
+Sets the model to use.
+
+This must be a [iface@Gtk.SelectionModel] to use.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListView
+<parameter_description> a `GtkListView`
</parameter_description>
</parameter>
<parameter name="model">
@@ -49237,7 +52493,7 @@ between rows.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListView
+<parameter_description> a `GtkListView`
</parameter_description>
</parameter>
<parameter name="show_separators">
@@ -49256,7 +52512,7 @@ selected on hover.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkListView
+<parameter_description> a `GtkListView`
</parameter_description>
</parameter>
<parameter name="single_click_activate">
@@ -49269,17 +52525,17 @@ selected on hover.
<function name="gtk_lock_button_get_permission">
<description>
-Obtains the #GPermission object that controls @button.
+Obtains the `GPermission` object that controls @button.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkLockButton
+<parameter_description> a `GtkLockButton`
</parameter_description>
</parameter>
</parameters>
-<return> the #GPermission of @button
+<return> the `GPermission` of @button
</return>
</function>
@@ -49291,26 +52547,26 @@ Creates a new lock button which reflects the @permission.
</description>
<parameters>
<parameter name="permission">
-<parameter_description> a #GPermission
+<parameter_description> a `GPermission`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkLockButton
+<return> a new `GtkLockButton`
</return>
</function>
<function name="gtk_lock_button_set_permission">
<description>
-Sets the #GPermission object that controls @button.
+Sets the `GPermission` object that controls @button.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkLockButton
+<parameter_description> a `GtkLockButton`
</parameter_description>
</parameter>
<parameter name="permission">
-<parameter_description> a #GPermission object, or %NULL
+<parameter_description> a `GPermission` object, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -49325,7 +52581,7 @@ Gets the model that is currently being mapped or %NULL if none.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMapListModel
+<parameter_description> a `GtkMapListModel`
</parameter_description>
</parameter>
</parameters>
@@ -49335,13 +52591,13 @@ Gets the model that is currently being mapped or %NULL if none.
<function name="gtk_map_list_model_has_map">
<description>
-Checks if a map function is currently set on @self
+Checks if a map function is currently set on @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMapListModel
+<parameter_description> a `GtkMapListModel`
</parameter_description>
</parameter>
</parameters>
@@ -49351,7 +52607,7 @@ Checks if a map function is currently set on @self
<function name="gtk_map_list_model_new">
<description>
-Creates a new #GtkMapListModel for the given arguments.
+Creates a new `GtkMapListModel` for the given arguments.
</description>
@@ -49373,18 +52629,19 @@ Creates a new #GtkMapListModel for the given arguments.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkMapListModel
+<return> a new `GtkMapListModel`
</return>
</function>
<function name="gtk_map_list_model_set_map_func">
<description>
-Sets the function used to map items. The function will be called whenever
-an item needs to be mapped and must return the item to use for the given
-input item.
+Sets the function used to map items.
-Note that #GtkMapListModel may call this function multiple times on the
-same item, because it may delete items it doesn't need anymore.
+The function will be called whenever an item needs to be mapped
+and must return the item to use for the given input item.
+
+Note that `GtkMapListModel` may call this function multiple times
+on the same item, because it may delete items it doesn't need anymore.
GTK makes no effort to ensure that @map_func conforms to the item type
of @self. It assumes that the caller knows what they are doing and the map
@@ -49393,7 +52650,7 @@ function returns items of the appropriate type.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMapListModel
+<parameter_description> a `GtkMapListModel`
</parameter_description>
</parameter>
<parameter name="map_func">
@@ -49423,7 +52680,7 @@ they are doing and have set up an appropriate map function.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMapListModel
+<parameter_description> a `GtkMapListModel`
</parameter_description>
</parameter>
<parameter name="model">
@@ -49442,7 +52699,7 @@ Gets the media stream managed by @controls or %NULL if none.
</description>
<parameters>
<parameter name="controls">
-<parameter_description> a #GtkMediaControls
+<parameter_description> a `GtkMediaControls`
</parameter_description>
</parameter>
</parameters>
@@ -49452,7 +52709,7 @@ Gets the media stream managed by @controls or %NULL if none.
<function name="gtk_media_controls_new">
<description>
-Creates a new #GtkMediaControls managing the @stream passed to it.
+Creates a new `GtkMediaControls` managing the @stream passed to it.
</description>
@@ -49463,7 +52720,7 @@ manage or %NULL for none.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkMediaControls
+<return> a new `GtkMediaControls`
</return>
</function>
@@ -49474,11 +52731,11 @@ Sets the stream that is controlled by @controls.
</description>
<parameters>
<parameter name="controls">
-<parameter_description> a #GtkMediaControls widget
+<parameter_description> a `GtkMediaControls` widget
</parameter_description>
</parameter>
<parameter name="stream">
-<parameter_description> a #GtkMediaStream, or %NULL
+<parameter_description> a `GtkMediaStream`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -49487,12 +52744,12 @@ Sets the stream that is controlled by @controls.
<function name="gtk_media_file_clear">
<description>
-Resets the media file to be empty.
+Resets the media file to be empty.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaFile
+<parameter_description> a `GtkMediaFile`
</parameter_description>
</parameter>
</parameters>
@@ -49510,12 +52767,12 @@ When @self is not playing or not playing from a file,
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaFile
+<parameter_description> a `GtkMediaFile`
</parameter_description>
</parameter>
</parameters>
-<return> The currently playing file or %NULL if not
-playing from a file.
+<return> The currently playing file
+or %NULL if not playing from a file.
</return>
</function>
@@ -49530,12 +52787,12 @@ When @self is not playing or not playing from a stream,
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaFile
+<parameter_description> a `GtkMediaFile`
</parameter_description>
</parameter>
</parameters>
-<return> The currently playing stream or %NULL if not
-playing from a stream.
+<return> The currently playing
+stream or %NULL if not playing from a stream.
</return>
</function>
@@ -49547,13 +52804,13 @@ Creates a new empty media file.
</description>
<parameters>
</parameters>
-<return> a new #GtkMediaFile
+<return> a new `GtkMediaFile`
</return>
</function>
<function name="gtk_media_file_new_for_file">
<description>
-Creates a new media file to play @file.
+Creates a new media file to play @file.
</description>
@@ -49563,14 +52820,16 @@ Creates a new media file to play @file.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkMediaFile playing @file
+<return> a new `GtkMediaFile` playing @file
</return>
</function>
<function name="gtk_media_file_new_for_filename">
<description>
+Creates a new media file for the given filename.
+
This is a utility function that converts the given @filename
-to a #GFile and calls gtk_media_file_new_for_file().
+to a `GFile` and calls [ctor@Gtk.MediaFile.new_for_file].
</description>
@@ -49580,15 +52839,16 @@ to a #GFile and calls gtk_media_file_new_for_file().
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkMediaFile playing @filename
+<return> a new `GtkMediaFile` playing @filename
</return>
</function>
<function name="gtk_media_file_new_for_input_stream">
<description>
-Creates a new media file to play @stream. If you want the
-resulting media to be seekable, the stream should implement
-the #GSeekable interface.
+Creates a new media file to play @stream.
+
+If you want the resulting media to be seekable,
+the stream should implement the `GSeekable` interface.
</description>
@@ -49598,14 +52858,16 @@ the #GSeekable interface.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkMediaFile
+<return> a new `GtkMediaFile`
</return>
</function>
<function name="gtk_media_file_new_for_resource">
<description>
+Creates a new new media file for the given resource.
+
This is a utility function that converts the given @resource
-to a #GFile and calls gtk_media_file_new_for_file().
+to a `GFile` and calls [ctor@Gtk.MediaFile.new_for_file].
</description>
@@ -49615,20 +52877,20 @@ to a #GFile and calls gtk_media_file_new_for_file().
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkMediaFile playing @resource_path
+<return> a new `GtkMediaFile` playing @resource_path
</return>
</function>
<function name="gtk_media_file_set_file">
<description>
-If any file is still playing, stop playing it.
+Sets the `GtkMediaFile` to play the given file.
-Then start playing the given @file.
+If any file is still playing, stop playing it.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaFile
+<parameter_description> a `GtkMediaFile`
</parameter_description>
</parameter>
<parameter name="file">
@@ -49641,13 +52903,15 @@ Then start playing the given @file.
<function name="gtk_media_file_set_filename">
<description>
+Sets the `GtkMediaFile to play the given file.
+
This is a utility function that converts the given @filename
-to a #GFile and calls gtk_media_file_set_file().
+to a `GFile` and calls [method@Gtk.MediaFile.set_file].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaFile
+<parameter_description> a `GtkMediaFile`
</parameter_description>
</parameter>
<parameter name="filename">
@@ -49660,16 +52924,17 @@ to a #GFile and calls gtk_media_file_set_file().
<function name="gtk_media_file_set_input_stream">
<description>
-If anything is still playing, stop playing it. Then start
-playing the given @stream.
+Sets the `GtkMediaFile` to play the given stream.
+
+If anything is still playing, stop playing it.
Full control about the @stream is assumed for the duration of
-playback. The stream will not bt be closed.
+playback. The stream will not be closed.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaFile
+<parameter_description> a `GtkMediaFile`
</parameter_description>
</parameter>
<parameter name="stream">
@@ -49682,13 +52947,15 @@ playback. The stream will not bt be closed.
<function name="gtk_media_file_set_resource">
<description>
+Sets the `GtkMediaFile to play the given resource.
+
This is a utility function that converts the given @resource_path
-to a #GFile and calls gtk_media_file_set_file().
+to a `GFile` and calls [method@Gtk.MediaFile.set_file].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaFile
+<parameter_description> a `GtkMediaFile`
</parameter_description>
</parameter>
<parameter name="resource_path">
@@ -49701,13 +52968,17 @@ to a #GFile and calls gtk_media_file_set_file().
<function name="gtk_media_stream_ended">
<description>
-Pauses the media stream and marks it as ended. This is a hint only, calls
-to GtkMediaStream.play() may still happen.
+Pauses the media stream and marks it as ended.
+
+This is a hint only, calls to GtkMediaStream.play()
+may still happen.
+
+The media stream must be prepared when this function is called.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -49718,13 +52989,13 @@ to GtkMediaStream.play() may still happen.
<description>
Sets @self into an error state using a printf()-style format string.
-This is a utility function that calls gtk_media_stream_gerror(). See
-that function for details.
+This is a utility function that calls [method@Gtk.MediaStream.gerror].
+See that function for details.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
<parameter name="domain">
@@ -49751,13 +53022,13 @@ that function for details.
<description>
Sets @self into an error state using a printf()-style format string.
-This is a utility function that calls gtk_media_stream_gerror(). See
-that function for details.
+This is a utility function that calls [method@Gtk.MediaStream.gerror].
+See that function for details.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
<parameter name="domain">
@@ -49773,7 +53044,7 @@ that function for details.
</parameter_description>
</parameter>
<parameter name="args">
-<parameter_description> #va_list of parameters for the message format
+<parameter_description> `va_list` of parameters for the message format
</parameter_description>
</parameter>
</parameters>
@@ -49782,26 +53053,27 @@ that function for details.
<function name="gtk_media_stream_gerror">
<description>
-Sets @self into an error state. This will pause the stream
-(you can check for an error via gtk_media_stream_get_error() in
-your GtkMediaStream.pause() implementation), abort pending seeks
-and mark the stream as prepared.
+Sets @self into an error state.
+
+This will pause the stream (you can check for an error
+via [method@Gtk.MediaStream.get_error] in your
+GtkMediaStream.pause() implementation), abort pending
+seeks and mark the stream as prepared.
-if the stream is already in an error state, this call will be ignored
-and the existing error will be retained.
-FIXME: Or do we want to set the new error?
+if the stream is already in an error state, this call
+will be ignored and the existing error will be retained.
To unset an error, the stream must be reset via a call to
-gtk_media_stream_unprepared().
+[method@Gtk.MediaStream.unprepared].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> the #GError to set
+<parameter_description> the `GError` to set
</parameter_description>
</parameter>
</parameters>
@@ -49810,14 +53082,15 @@ gtk_media_stream_unprepared().
<function name="gtk_media_stream_get_duration">
<description>
-Gets the duration of the stream. If the duration is not known,
-0 will be returned.
+Gets the duration of the stream.
+
+If the duration is not known, 0 will be returned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -49833,7 +53106,7 @@ Returns whether the streams playback is finished.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -49843,40 +53116,45 @@ Returns whether the streams playback is finished.
<function name="gtk_media_stream_get_error">
<description>
-If the stream is in an error state, returns the #GError explaining that state.
-Any type of error can be reported here depending on the implementation of the
-media stream.
+If the stream is in an error state, returns the `GError`
+explaining that state.
+
+Any type of error can be reported here depending on the
+implementation of the media stream.
-A media stream in an error cannot be operated on, calls like
-gtk_media_stream_play() or gtk_media_stream_seek() will not have any effect.
+A media stream in an error cannot be operated on, calls
+like [method Gtk MediaStream play] or
+[method Gtk MediaStream seek] will not have any effect.
-#GtkMediaStream itself does not provide a way to unset an error, but
-implementations may provide options. For example, a #GtkMediaFile will unset
-errors when a new source is set with ie gtk_media_file_set_file().
+`GtkMediaStream` itself does not provide a way to unset
+an error, but implementations may provide options. For example,
+a [class@Gtk.MediaFile] will unset errors when a new source is
+set, e.g. with [method@Gtk.MediaFile.set_file].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
-<return> %NULL if not in an error state or
-the #GError of the stream
+<return> %NULL if not in an
+error state or the `GError` of the stream
</return>
</function>
<function name="gtk_media_stream_get_loop">
<description>
-Returns whether the stream is set to loop. See
-gtk_media_stream_set_loop() for details.
+Returns whether the stream is set to loop.
+
+See [method@Gtk.MediaStream.set_loop] for details.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -49887,13 +53165,14 @@ gtk_media_stream_set_loop() for details.
<function name="gtk_media_stream_get_muted">
<description>
Returns whether the audio for the stream is muted.
-See gtk_media_stream_set_muted() for details.
+
+See [method@Gtk.MediaStream.set_muted] for details.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -49909,7 +53188,7 @@ Return whether the stream is currently playing.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -49925,7 +53204,7 @@ Returns the current presentation timestamp in microseconds.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -49936,13 +53215,14 @@ Returns the current presentation timestamp in microseconds.
<function name="gtk_media_stream_get_volume">
<description>
Returns the volume of the audio for the stream.
-See gtk_media_stream_set_volume() for details.
+
+See [method@Gtk.MediaStream.set_volume] for details.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -49958,7 +53238,7 @@ Returns whether the stream has audio.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -49974,7 +53254,7 @@ Returns whether the stream has video.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -49984,14 +53264,15 @@ Returns whether the stream has video.
<function name="gtk_media_stream_is_prepared">
<description>
-Returns whether the stream has finished initializing and existence of
-audio and video is known.
+Returns whether the stream has finished initializing.
+
+At this point the existence of audio and video is known.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -50008,14 +53289,14 @@ this function returns %TRUE. However, if this function returns
%FALSE, streams are guaranteed to not be seekable and user interfaces
may hide controls that allow seeking.
-It is allowed to call gtk_media_stream_seek() on a non-seekable
+It is allowed to call [method Gtk MediaStream seek] on a non-seekable
stream, though it will not do anything.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -50031,7 +53312,7 @@ Checks if there is currently a seek operation going on.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -50041,13 +53322,14 @@ Checks if there is currently a seek operation going on.
<function name="gtk_media_stream_pause">
<description>
-Pauses playback of the stream. If the stream
-is not playing, do nothing.
+Pauses playback of the stream.
+
+If the stream is not playing, do nothing.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -50056,13 +53338,14 @@ is not playing, do nothing.
<function name="gtk_media_stream_play">
<description>
-Starts playing the stream. If the stream
-is in error or already playing, do nothing.
+Starts playing the stream.
+
+If the stream is in error or already playing, do nothing.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -50071,7 +53354,7 @@ is in error or already playing, do nothing.
<function name="gtk_media_stream_prepared">
<description>
-Called by #GtkMediaStream implementations to advertise the stream
+Called by `GtkMediaStream` implementations to advertise the stream
being ready to play and providing details about the stream.
Note that the arguments are hints. If the stream implementation
@@ -50080,12 +53363,12 @@ side of caution and return %TRUE. User interfaces will use those
values to determine what controls to show.
This function may not be called again until the stream has been
-reset via gtk_media_stream_unprepared().
+reset via [method@Gtk.MediaStream.unprepared].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
<parameter name="has_audio">
@@ -50110,29 +53393,31 @@ reset via gtk_media_stream_unprepared().
<function name="gtk_media_stream_realize">
<description>
-Called by users to attach the media stream to a #GdkSurface they manage.
-The stream can then access the resources of @surface for its rendering
-purposes. In particular, media streams might want to create
-#GdkGLContexts or sync to the #GdkFrameClock.
+Called by users to attach the media stream to a `GdkSurface` they manage.
+
+The stream can then access the resources of @surface for its
+rendering purposes. In particular, media streams might want to
+create a `GdkGLContext` or sync to the `GdkFrameClock`.
Whoever calls this function is responsible for calling
-gtk_media_stream_unrealize() before either the stream or @surface get
-destroyed.
+[method@Gtk.MediaStream.unrealize] before either the stream
+or @surface get destroyed.
-Multiple calls to this function may happen from different users of the
-video, even with the same @surface. Each of these calls must be followed
-by its own call to gtk_media_stream_unrealize().
+Multiple calls to this function may happen from different
+users of the video, even with the same @surface. Each of these
+calls must be followed by its own call to
+[method@Gtk.MediaStream.unrealize].
It is not required to call this function to make a media stream work.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
</parameters>
@@ -50141,19 +53426,22 @@ It is not required to call this function to make a media stream work.
<function name="gtk_media_stream_seek">
<description>
-Start a seek operation on @self to @timestamp. If @timestamp is out of range,
-it will be clamped.
+Start a seek operation on @self to @timestamp.
+
+If @timestamp is out of range, it will be clamped.
-Seek operations may not finish instantly. While a seek operation is
-in process, the GtkMediaStream:seeking property will be set.
+Seek operations may not finish instantly. While a
+seek operation is in process, the [property@Gtk.MediaStream:seeking]
+property will be set.
-When calling gtk_media_stream_seek() during an ongoing seek operation,
-the new seek will override any pending seek.
+When calling gtk_media_stream_seek() during an
+ongoing seek operation, the new seek will override
+any pending seek.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
<parameter name="timestamp">
@@ -50167,16 +53455,17 @@ the new seek will override any pending seek.
<function name="gtk_media_stream_seek_failed">
<description>
Ends a seek operation started via GtkMediaStream.seek() as a failure.
+
This will not cause an error on the stream and will assume that
playback continues as if no seek had happened.
-See gtk_media_stream_seek_success() for the other way of
+See [method@Gtk.MediaStream.seek_success] for the other way of
ending a seek.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -50186,16 +53475,17 @@ ending a seek.
<function name="gtk_media_stream_seek_success">
<description>
Ends a seek operation started via GtkMediaStream.seek() successfully.
-This function will unset the GtkMediaStream:ended property if it was
-set.
-See gtk_media_stream_seek_failed() for the other way of
+This function will unset the GtkMediaStream:ended property
+if it was set.
+
+See [method@Gtk.MediaStream.seek_failed] for the other way of
ending a seek.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -50204,16 +53494,19 @@ ending a seek.
<function name="gtk_media_stream_set_loop">
<description>
-Sets whether the stream should loop, ie restart playback from
-the beginning instead of stopping at the end.
+Sets whether the stream should loop.
-Not all streams may support looping, in particular non-seekable
-streams. Those streams will ignore the loop setting and just end.
+In this case, it will attempt to restart playback
+from the beginning instead of stopping at the end.
+
+Not all streams may support looping, in particular
+non-seekable streams. Those streams will ignore the
+loop setting and just end.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
<parameter name="loop">
@@ -50226,18 +53519,19 @@ streams. Those streams will ignore the loop setting and just end.
<function name="gtk_media_stream_set_muted">
<description>
-Sets whether the audio stream should be muted. Muting a stream will
-cause no audio to be played, but it does not modify the volume.
-This means that muting and then unmuting the stream will restore
-the volume settings.
+Sets whether the audio stream should be muted.
+
+Muting a stream will cause no audio to be played, but it
+does not modify the volume. This means that muting and
+then unmuting the stream will restore the volume settings.
-If the stream has no audio, calling this function will still work
-but it will not have an audible effect.
+If the stream has no audio, calling this function will
+still work but it will not have an audible effect.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
<parameter name="muted">
@@ -50255,7 +53549,7 @@ Starts or pauses playback of the stream.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
<parameter name="playing">
@@ -50268,21 +53562,22 @@ Starts or pauses playback of the stream.
<function name="gtk_media_stream_set_volume">
<description>
-Sets the volume of the audio stream. This function call will work even if
-the stream is muted.
+Sets the volume of the audio stream.
-The given @volume should range from 0.0 for silence to 1.0 for as loud as
-possible. Values outside of this range will be clamped to the nearest
-value.
+This function call will work even if the stream is muted.
+
+The given @volume should range from 0.0 for silence to 1.0
+for as loud as possible. Values outside of this range will
+be clamped to the nearest value.
-If the stream has no audio or is muted, calling this function will still
-work but it will not have an immediate audible effect. When the stream is
-unmuted, the new volume setting will take effect.
+If the stream has no audio or is muted, calling this function
+will still work but it will not have an immediate audible effect.
+When the stream is unmuted, the new volume setting will take effect.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
<parameter name="volume">
@@ -50295,15 +53590,16 @@ unmuted, the new volume setting will take effect.
<function name="gtk_media_stream_unprepared">
<description>
-Resets a given media stream implementation. gtk_media_stream_prepared()
-can now be called again.
+Resets a given media stream implementation.
+
+[method@Gtk.MediaStream.prepared] can then be called again.
This function will also reset any error state the stream was in.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
@@ -50312,17 +53608,19 @@ This function will also reset any error state the stream was in.
<function name="gtk_media_stream_unrealize">
<description>
-Undoes a previous call to gtk_media_stream_realize() and causes
-the stream to release all resources it had allocated from @surface.
+Undoes a previous call to gtk_media_stream_realize().
+
+This causes the stream to release all resources it had
+allocated from @surface.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream previously realized
+<parameter_description> a `GtkMediaStream` previously realized
</parameter_description>
</parameter>
<parameter name="surface">
-<parameter_description> the #GdkSurface the stream was realized with
+<parameter_description> the `GdkSurface` the stream was realized with
</parameter_description>
</parameter>
</parameters>
@@ -50331,14 +53629,18 @@ the stream to release all resources it had allocated from @surface.
<function name="gtk_media_stream_update">
<description>
-Media stream implementations should regularly call this function to
-update the timestamp reported by the stream. It is up to
-implementations to call this at the frequency they deem appropriate.
+Media stream implementations should regularly call this
+function to update the timestamp reported by the stream.
+
+It is up to implementations to call this at the frequency
+they deem appropriate.
+
+The media stream must be prepared when this function is called.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
<parameter name="timestamp">
@@ -50357,11 +53659,11 @@ Returns the direction the popup will be pointing at when popped up.
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkArrowType value
+<return> a `GtkArrowType` value
</return>
</function>
@@ -50373,7 +53675,7 @@ Returns whether the button has a frame.
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
</parameters>
@@ -50389,7 +53691,7 @@ Gets the name of the icon shown in the button.
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
</parameters>
@@ -50405,7 +53707,7 @@ Gets the label shown in the button
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
</parameters>
@@ -50415,48 +53717,49 @@ Gets the label shown in the button
<function name="gtk_menu_button_get_menu_model">
<description>
-Returns the #GMenuModel used to generate the popup.
+Returns the `GMenuModel` used to generate the popup.
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
</parameters>
-<return> a #GMenuModel or %NULL
+<return> a `GMenuModel` or %NULL
</return>
</function>
<function name="gtk_menu_button_get_popover">
<description>
-Returns the #GtkPopover that pops out of the button.
-If the button is not using a #GtkPopover, this function
+Returns the `GtkPopover` that pops out of the button.
+
+If the button is not using a `GtkPopover`, this function
returns %NULL.
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkPopover or %NULL
+<return> a `GtkPopover` or %NULL
</return>
</function>
<function name="gtk_menu_button_get_use_underline">
<description>
Returns whether an embedded underline in the text indicates a
-mnemonic. See gtk_menu_button_set_use_underline().
+mnemonic.
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
</parameters>
@@ -50467,15 +53770,17 @@ the mnemonic accelerator keys.
<function name="gtk_menu_button_new">
<description>
-Creates a new #GtkMenuButton widget with downwards-pointing
-arrow as the only child. You can replace the child widget
-with another #GtkWidget should you wish to.
+Creates a new `GtkMenuButton` widget with downwards-pointing
+arrow as the only child.
+
+You can replace the child widget with another `GtkWidget`
+should you wish to.
</description>
<parameters>
</parameters>
-<return> The newly created #GtkMenuButton widget
+<return> The newly created `GtkMenuButton`
</return>
</function>
@@ -50486,7 +53791,7 @@ Dismiss the menu.
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
</parameters>
@@ -50500,7 +53805,7 @@ Pop up the menu.
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
</parameters>
@@ -50510,25 +53815,26 @@ Pop up the menu.
<function name="gtk_menu_button_set_create_popup_func">
<description>
Sets @func to be called when a popup is about to be shown.
+
@func should use one of
-- gtk_menu_button_set_popover()
-- gtk_menu_button_set_menu_model()
+- [method@Gtk.MenuButton.set_popover]
+- [method@Gtk.MenuButton.set_menu_model]
to set a popup for @menu_button.
If @func is non-%NULL, @menu_button will always be sensitive.
-Using this function will not reset the menu widget attached to @menu_button.
-Instead, this can be done manually in @func.
+Using this function will not reset the menu widget attached to
+@menu_button. Instead, this can be done manually in @func.
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
<parameter name="func">
-<parameter_description> function to call when a popuop is about to
+<parameter_description> function to call when a popup is about to
be shown, but none has been provided via other means, or %NULL
to reset to default behavior.
</parameter_description>
@@ -50547,9 +53853,10 @@ to reset to default behavior.
<function name="gtk_menu_button_set_direction">
<description>
-Sets the direction in which the popup will be popped up, as
-well as changing the arrow’s direction. The child will not
-be changed to an arrow if it was customized.
+Sets the direction in which the popup will be popped up.
+
+If the button is automatically populated with an arrow icon,
+its direction will be changed to match.
If the does not fit in the available space in the given direction,
GTK will its best to keep it inside the screen and fully visible.
@@ -50560,11 +53867,11 @@ as if you passed %GTK_ARROW_DOWN (although you won’t see any arrows).
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
<parameter name="direction">
-<parameter_description> a #GtkArrowType
+<parameter_description> a `GtkArrowType`
</parameter_description>
</parameter>
</parameters>
@@ -50578,7 +53885,7 @@ Sets the style of the button.
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
<parameter name="has_frame">
@@ -50596,7 +53903,7 @@ Sets the name of an icon to show inside the menu button.
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
<parameter name="icon_name">
@@ -50614,7 +53921,7 @@ Sets the label to show inside the menu button.
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
<parameter name="label">
@@ -50627,23 +53934,25 @@ Sets the label to show inside the menu button.
<function name="gtk_menu_button_set_menu_model">
<description>
-Sets the #GMenuModel from which the popup will be constructed,
-or %NULL to dissociate any existing menu model and disable the button.
+Sets the `GMenuModel` from which the popup will be constructed.
-A #GtkPopover will be created from the menu model with gtk_popover_menu_new_from_model().
-Actions will be connected as documented for this function.
+If @menu_model is %NULL, the button is disabled.
-If #GtkMenuButton:popover is already set, it will be dissociated from the @menu_button,
-and the property is set to %NULL.
+A [class@Gtk.Popover] will be created from the menu model with
+[ctor@Gtk.PopoverMenu.new_from_model]. Actions will be connected
+as documented for this function.
+
+If [property@Gtk.MenuButton:popover] is already set, it will be
+dissociated from the @menu_button, and the property is set to %NULL.
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
<parameter name="menu_model">
-<parameter_description> a #GMenuModel, or %NULL to unset and disable the
+<parameter_description> a `GMenuModel`, or %NULL to unset and disable the
button
</parameter_description>
</parameter>
@@ -50653,20 +53962,21 @@ button
<function name="gtk_menu_button_set_popover">
<description>
-Sets the #GtkPopover that will be popped up when the @menu_button is clicked,
-or %NULL to dissociate any existing popover and disable the button.
+Sets the `GtkPopover` that will be popped up when the @menu_button is clicked.
+
+If @popover is %NULL, the button is disabled.
-If #GtkMenuButton:menu-model is set, the menu model is dissociated from the
-@menu_button, and the property is set to %NULL.
+If [property@Gtk.MenuButton:menu-model] is set, the menu model is dissociated
+from the @menu_button, and the property is set to %NULL.
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
<parameter name="popover">
-<parameter_description> a #GtkPopover, or %NULL to unset and disable the button
+<parameter_description> a `GtkPopover`, or %NULL to unset and disable the button
</parameter_description>
</parameter>
</parameters>
@@ -50675,13 +53985,12 @@ If #GtkMenuButton:menu-model is set, the menu model is dissociated from the
<function name="gtk_menu_button_set_use_underline">
<description>
-If true, an underline in the text indicates the next character should be
-used for the mnemonic accelerator key.
+If true, an underline in the text indicates a mnemonic.
</description>
<parameters>
<parameter name="menu_button">
-<parameter_description> a #GtkMenuButton
+<parameter_description> a `GtkMenuButton`
</parameter_description>
</parameter>
<parameter name="use_underline">
@@ -50694,33 +54003,32 @@ used for the mnemonic accelerator key.
<function name="gtk_message_dialog_format_secondary_markup">
<description>
-Sets the secondary text of the message dialog to be @message_format (with
-printf()-style), which is marked up with the
-[Pango text markup language][PangoMarkupFormat].
+Sets the secondary text of the message dialog.
-Due to an oversight, this function does not escape special XML characters
-like gtk_message_dialog_new_with_markup() does. Thus, if the arguments
-may contain special XML characters, you should use g_markup_printf_escaped()
-to escape it.
+The @message_format is assumed to contain Pango markup.
-|[<!-- language="C" -->
+Due to an oversight, this function does not escape special
+XML characters like [ctor@Gtk.MessageDialog.new_with_markup]
+does. Thus, if the arguments may contain special XML characters,
+you should use g_markup_printf_escaped() to escape it.
+
+```c
char *msg;
msg = g_markup_printf_escaped (message_format, ...);
gtk_message_dialog_format_secondary_markup (message_dialog,
"%s", msg);
g_free (msg);
-]|
+```
</description>
<parameters>
<parameter name="message_dialog">
-<parameter_description> a #GtkMessageDialog
+<parameter_description> a `GtkMessageDialog`
</parameter_description>
</parameter>
<parameter name="message_format">
-<parameter_description> printf()-style markup string (see
- [Pango markup format][PangoMarkupFormat]), or %NULL
+<parameter_description> printf()-style string with Pango markup
</parameter_description>
</parameter>
<parameter name="Varargs">
@@ -50733,13 +54041,12 @@ g_free (msg);
<function name="gtk_message_dialog_format_secondary_text">
<description>
-Sets the secondary text of the message dialog to be @message_format
-(with printf()-style).
+Sets the secondary text of the message dialog.
</description>
<parameters>
<parameter name="message_dialog">
-<parameter_description> a #GtkMessageDialog
+<parameter_description> a `GtkMessageDialog`
</parameter_description>
</parameter>
<parameter name="message_format">
@@ -50756,31 +54063,34 @@ Sets the secondary text of the message dialog to be @message_format
<function name="gtk_message_dialog_get_message_area">
<description>
-Returns the message area of the dialog. This is the box where the
-dialog’s primary and secondary labels are packed. You can add your
-own extra content to that box and it will appear below those labels.
-See gtk_dialog_get_content_area() for the corresponding
-function in the parent #GtkDialog.
+Returns the message area of the dialog.
+
+This is the box where the dialog’s primary and secondary labels
+are packed. You can add your own extra content to that box and it
+will appear below those labels. See [method@Gtk.Dialog.get_content_area]
+for the corresponding function in the parent [class@Gtk.Dialog].
</description>
<parameters>
<parameter name="message_dialog">
-<parameter_description> a #GtkMessageDialog
+<parameter_description> a `GtkMessageDialog`
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkBox corresponding to the
+<return> A `GtkBox` corresponding to the
“message area” in the @message_dialog.
</return>
</function>
<function name="gtk_message_dialog_new">
<description>
-Creates a new message dialog, which is a simple dialog with some text
-the user may want to see. When the user clicks a button a “response”
-signal is emitted with response IDs from #GtkResponseType. See
-#GtkDialog for more details.
+Creates a new message dialog.
+
+This is a simple dialog with some text the user may want to see.
+When the user clicks a button a “response” signal is emitted with
+response IDs from [enum@Gtk.ResponseType]. See [class@Gtk.Dialog]
+for more details.
</description>
@@ -50810,27 +54120,30 @@ signal is emitted with response IDs from #GtkResponseType. See
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkMessageDialog
+<return> a new `GtkMessageDialog`
</return>
</function>
<function name="gtk_message_dialog_new_with_markup">
<description>
-Creates a new message dialog, which is a simple dialog with some text that
-is marked up with the [Pango text markup language][PangoMarkupFormat].
-When the user clicks a button a “response” signal is emitted with
-response IDs from #GtkResponseType. See #GtkDialog for more details.
+Creates a new message dialog.
+
+This is a simple dialog with some text that is marked up with
+Pango markup. When the user clicks a button a “response” signal
+is emitted with response IDs from [enum@Gtk.ResponseType]. See
+[class@Gtk.Dialog] for more details.
Special XML characters in the printf() arguments passed to this
function will automatically be escaped as necessary.
(See g_markup_printf_escaped() for how this is implemented.)
Usually this is what you want, but if you have an existing
Pango markup string that you want to use literally as the
-label, then you need to use gtk_message_dialog_set_markup()
+label, then you need to use [method@Gtk.MessageDialog.set_markup]
instead, since you can’t pass the markup string either
as the format (it might contain “%” characters) or as a string
argument.
-|[<!-- language="C" -->
+
+```c
GtkWidget *dialog;
GtkDialogFlags flags = GTK_DIALOG_DESTROY_WITH_PARENT;
dialog = gtk_message_dialog_new (parent_window,
@@ -50840,7 +54153,7 @@ GTK_BUTTONS_CLOSE,
NULL);
gtk_message_dialog_set_markup (GTK_MESSAGE_DIALOG (dialog),
markup);
-]|
+```
</description>
@@ -50870,23 +54183,22 @@ markup);
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkMessageDialog
+<return> a new `GtkMessageDialog`
</return>
</function>
<function name="gtk_message_dialog_set_markup">
<description>
-Sets the text of the message dialog to be @str, which is marked
-up with the [Pango text markup language][PangoMarkupFormat].
+Sets the text of the message dialog.
</description>
<parameters>
<parameter name="message_dialog">
-<parameter_description> a #GtkMessageDialog
+<parameter_description> a `GtkMessageDialog`
</parameter_description>
</parameter>
<parameter name="str">
-<parameter_description> markup string (see [Pango markup format][PangoMarkupFormat])
+<parameter_description> string with Pango markup
</parameter_description>
</parameter>
</parameters>
@@ -50895,8 +54207,10 @@ up with the [Pango text markup language][PangoMarkupFormat].
<function name="gtk_mnemonic_action_get">
<description>
-Gets the mnemonic action. This is an action that calls
-gtk_widget_mnemonic_activate() on the given widget upon activation.
+Gets the mnemonic action.
+
+This is an action that calls gtk_widget_mnemonic_activate()
+on the given widget upon activation.
</description>
@@ -50914,7 +54228,7 @@ Gets the keyval that must be pressed to succeed triggering @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a mnemonic #GtkShortcutTrigger
+<parameter_description> a mnemonic `GtkShortcutTrigger`
</parameter_description>
</parameter>
</parameters>
@@ -50924,7 +54238,7 @@ Gets the keyval that must be pressed to succeed triggering @self.
<function name="gtk_mnemonic_trigger_new">
<description>
-Creates a #GtkShortcutTrigger that will trigger whenever the key with
+Creates a `GtkShortcutTrigger` that will trigger whenever the key with
the given @keyval is pressed and mnemonics have been activated.
Mnemonics are activated by calling code when a key event with the right
@@ -50938,7 +54252,7 @@ modifiers is detected.
</parameter_description>
</parameter>
</parameters>
-<return> A new #GtkShortcutTrigger
+<return> A new `GtkShortcutTrigger`
</return>
</function>
@@ -50956,14 +54270,14 @@ Creates a new GtkModelButton.
<function name="gtk_mount_operation_get_display">
<description>
-Gets the display on which windows of the #GtkMountOperation
+Gets the display on which windows of the `GtkMountOperation`
will be shown.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkMountOperation
+<parameter_description> a `GtkMountOperation`
</parameter_description>
</parameter>
</parameters>
@@ -50973,13 +54287,13 @@ will be shown.
<function name="gtk_mount_operation_get_parent">
<description>
-Gets the transient parent used by the #GtkMountOperation
+Gets the transient parent used by the `GtkMountOperation`.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkMountOperation
+<parameter_description> a `GtkMountOperation`
</parameter_description>
</parameter>
</parameters>
@@ -50989,14 +54303,14 @@ Gets the transient parent used by the #GtkMountOperation
<function name="gtk_mount_operation_is_showing">
<description>
-Returns whether the #GtkMountOperation is currently displaying
+Returns whether the `GtkMountOperation` is currently displaying
a window.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkMountOperation
+<parameter_description> a `GtkMountOperation`
</parameter_description>
</parameter>
</parameters>
@@ -51006,7 +54320,7 @@ a window.
<function name="gtk_mount_operation_new">
<description>
-Creates a new #GtkMountOperation
+Creates a new `GtkMountOperation`.
</description>
@@ -51016,22 +54330,22 @@ Creates a new #GtkMountOperation
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkMountOperation
+<return> a new `GtkMountOperation`
</return>
</function>
<function name="gtk_mount_operation_set_display">
<description>
-Sets the display to show windows of the #GtkMountOperation on.
+Sets the display to show windows of the `GtkMountOperation` on.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkMountOperation
+<parameter_description> a `GtkMountOperation`
</parameter_description>
</parameter>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -51041,12 +54355,12 @@ Sets the display to show windows of the #GtkMountOperation on.
<function name="gtk_mount_operation_set_parent">
<description>
Sets the transient parent for windows shown by the
-#GtkMountOperation.
+`GtkMountOperation`.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkMountOperation
+<parameter_description> a `GtkMountOperation`
</parameter_description>
</parameter>
<parameter name="parent">
@@ -51064,7 +54378,7 @@ Adds a @filter to @self to use for matching.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMultiFilter
+<parameter_description> a `GtkMultiFilter`
</parameter_description>
</parameter>
<parameter name="filter">
@@ -51079,13 +54393,14 @@ Adds a @filter to @self to use for matching.
<description>
Removes the filter at the given @position from the list of filters used
by @self.
+
If @position is larger than the number of filters, nothing happens and
the function returns.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMultiFilter
+<parameter_description> a `GtkMultiFilter`
</parameter_description>
</parameter>
<parameter name="position">
@@ -51104,7 +54419,7 @@ Returns the underlying model of @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMultiSelection
+<parameter_description> a `GtkMultiSelection`
</parameter_description>
</parameter>
</parameters>
@@ -51120,27 +54435,28 @@ Creates a new selection to handle @model.
</description>
<parameters>
<parameter name="model">
-<parameter_description> the #GListModel to manage, or %NULL
+<parameter_description> the `GListModel` to manage, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkMultiSelection
+<return> a new `GtkMultiSelection`
</return>
</function>
<function name="gtk_multi_selection_set_model">
<description>
-Sets the model that @self should wrap. If @model is %NULL, @self
-will be empty.
+Sets the model that @self should wrap.
+
+If @model is %NULL, @self will be empty.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMultiSelection
+<parameter_description> a `GtkMultiSelection`
</parameter_description>
</parameter>
<parameter name="model">
-<parameter_description> A #GListModel to wrap
+<parameter_description> A `GListModel` to wrap
</parameter_description>
</parameter>
</parameters>
@@ -51149,14 +54465,15 @@ will be empty.
<function name="gtk_multi_sorter_append">
<description>
-Add @sorter to @self to use for sorting at the end. @self
-will consult all existing sorters before it will sort with
-the given @sorter.
+Add @sorter to @self to use for sorting at the end.
+
+@self will consult all existing sorters before it will
+sort with the given @sorter.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMultiSorter
+<parameter_description> a `GtkMultiSorter`
</parameter_description>
</parameter>
<parameter name="sorter">
@@ -51180,7 +54497,7 @@ items as equal.
</description>
<parameters>
</parameters>
-<return> a new #GtkMultiSorter
+<return> a new `GtkMultiSorter`
</return>
</function>
@@ -51194,7 +54511,7 @@ If @position is larger than the number of sorters, nothing happens.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkMultiSorter
+<parameter_description> a `GtkMultiSorter`
</parameter_description>
</parameter>
<parameter name="position">
@@ -51223,10 +54540,13 @@ Returns the name of the action that will be activated.
<function name="gtk_named_action_new">
<description>
-Creates an action that when activated, activates the action given by
-the detailed @name on the widget passing the given arguments to it.
+Creates an action that when activated, activates
+the named action on the widget.
+
+It also passes the given arguments to it.
-See gtk_widget_insert_action_group() for how to add actions to widgets.
+See [method@Gtk.Widget.insert_action_group] for
+how to add actions to widgets.
</description>
@@ -51236,7 +54556,7 @@ See gtk_widget_insert_action_group() for how to add actions to widgets.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkShortcutAction
+<return> a new `GtkShortcutAction`
</return>
</function>
@@ -51245,17 +54565,19 @@ See gtk_widget_insert_action_group() for how to add actions to widgets.
Destroys a dialog.
When a dialog is destroyed, it will break any references it holds
-to other objects. If it is visible it will be hidden and any underlying
-window system resources will be destroyed.
+to other objects.
-Note that this does not release any reference to the object (as opposed to
-destroying a GtkWindow) because there is no reference from the windowing
-system to the #GtkNativeDialog.
+If it is visible it will be hidden and any underlying window system
+resources will be destroyed.
+
+Note that this does not release any reference to the object (as opposed
+to destroying a `GtkWindow`) because there is no reference from the
+windowing system to the `GtkNativeDialog`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNativeDialog
+<parameter_description> a `GtkNativeDialog`
</parameter_description>
</parameter>
</parameters>
@@ -51264,13 +54586,13 @@ system to the #GtkNativeDialog.
<function name="gtk_native_dialog_get_modal">
<description>
-Returns whether the dialog is modal. See gtk_native_dialog_set_modal().
+Returns whether the dialog is modal.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNativeDialog
+<parameter_description> a `GtkNativeDialog`
</parameter_description>
</parameter>
</parameters>
@@ -51280,13 +54602,13 @@ Returns whether the dialog is modal. See gtk_native_dialog_set_modal().
<function name="gtk_native_dialog_get_title">
<description>
-Gets the title of the #GtkNativeDialog.
+Gets the title of the `GtkNativeDialog`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNativeDialog
+<parameter_description> a `GtkNativeDialog`
</parameter_description>
</parameter>
</parameters>
@@ -51298,14 +54620,13 @@ and must not be modified or freed.
<function name="gtk_native_dialog_get_transient_for">
<description>
-Fetches the transient parent for this window. See
-gtk_native_dialog_set_transient_for().
+Fetches the transient parent for this window.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNativeDialog
+<parameter_description> a `GtkNativeDialog`
</parameter_description>
</parameter>
</parameters>
@@ -51322,7 +54643,7 @@ Determines whether the dialog is visible.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNativeDialog
+<parameter_description> a `GtkNativeDialog`
</parameter_description>
</parameter>
</parameters>
@@ -51332,16 +54653,18 @@ Determines whether the dialog is visible.
<function name="gtk_native_dialog_hide">
<description>
-Hides the dialog if it is visilbe, aborting any interaction. Once this
-is called the #GtkNativeDialog::response signal will not be emitted
-until after the next call to gtk_native_dialog_show().
+Hides the dialog if it is visible, aborting any interaction.
+
+Once this is called the [signal@Gtk.NativeDialog::response] signal
+will *not* be emitted until after the next call to
+[method Gtk NativeDialog show].
If the dialog is not visible this does nothing.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNativeDialog
+<parameter_description> a `GtkNativeDialog`
</parameter_description>
</parameter>
</parameters>
@@ -51350,17 +54673,18 @@ If the dialog is not visible this does nothing.
<function name="gtk_native_dialog_set_modal">
<description>
-Sets a dialog modal or non-modal. Modal dialogs prevent interaction
-with other windows in the same application. To keep modal dialogs
-on top of main application windows, use
-gtk_native_dialog_set_transient_for() to make the dialog transient for the
-parent; most [window managers][gtk-X11-arch]
-will then disallow lowering the dialog below the parent.
+Sets a dialog modal or non-modal.
+
+Modal dialogs prevent interaction with other windows in the same
+application. To keep modal dialogs on top of main application
+windows, use [method@Gtk.NativeDialog.set_transient_for] to make
+the dialog transient for the parent; most window managers will
+then disallow lowering the dialog below the parent.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNativeDialog
+<parameter_description> a `GtkNativeDialog`
</parameter_description>
</parameter>
<parameter name="modal">
@@ -51373,12 +54697,12 @@ will then disallow lowering the dialog below the parent.
<function name="gtk_native_dialog_set_title">
<description>
-Sets the title of the #GtkNativeDialog.
+Sets the title of the `GtkNativeDialog.`
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNativeDialog
+<parameter_description> a `GtkNativeDialog`
</parameter_description>
</parameter>
<parameter name="title">
@@ -51392,17 +54716,17 @@ Sets the title of the #GtkNativeDialog.
<function name="gtk_native_dialog_set_transient_for">
<description>
Dialog windows should be set transient for the main application
-window they were spawned from. This allows
-[window managers][gtk-X11-arch] to e.g. keep the
-dialog on top of the main window, or center the dialog over the
-main window.
+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.
Passing %NULL for @parent unsets the current transient window.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNativeDialog
+<parameter_description> a `GtkNativeDialog`
</parameter_description>
</parameter>
<parameter name="parent">
@@ -51415,17 +54739,18 @@ Passing %NULL for @parent unsets the current transient window.
<function name="gtk_native_dialog_show">
<description>
-Shows the dialog on the display, allowing the user to interact with
-it. When the user accepts the state of the dialog the dialog will
-be automatically hidden and the #GtkNativeDialog::response signal
-will be emitted.
+Shows the dialog on the display.
+
+When the user accepts the state of the dialog the dialog will
+be automatically hidden and the [signal@Gtk.NativeDialog::response]
+signal will be emitted.
Multiple calls while the dialog is visible will be ignored.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNativeDialog
+<parameter_description> a `GtkNativeDialog`
</parameter_description>
</parameter>
</parameters>
@@ -51434,29 +54759,29 @@ Multiple calls while the dialog is visible will be ignored.
<function name="gtk_native_get_for_surface">
<description>
-Finds the GtkNative associated with the surface.
+Finds the `GtkNative` associated with the surface.
</description>
<parameters>
<parameter name="surface">
-<parameter_description> a #GdkSurface
+<parameter_description> a `GdkSurface`
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkNative that is associated with @surface
+<return> the `GtkNative` that is associated with @surface
</return>
</function>
<function name="gtk_native_get_renderer">
<description>
-Returns the renderer that is used for this #GtkNative.
+Returns the renderer that is used for this `GtkNative`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNative
+<parameter_description> a `GtkNative`
</parameter_description>
</parameter>
</parameters>
@@ -51466,13 +54791,13 @@ Returns the renderer that is used for this #GtkNative.
<function name="gtk_native_get_surface">
<description>
-Returns the surface of this #GtkNative.
+Returns the surface of this `GtkNative`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNative
+<parameter_description> a `GtkNative`
</parameter_description>
</parameter>
</parameters>
@@ -51482,13 +54807,15 @@ Returns the surface of this #GtkNative.
<function name="gtk_native_get_surface_transform">
<description>
-Retrieves the surface transform of @self. This is the translation
-from @self's surface coordinates into @self's widget coordinates.
+Retrieves the surface transform of @self.
+
+This is the translation from @self's surface coordinates into
+@self's widget coordinates.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a @GtkNative
+<parameter_description> a `GtkNative`
</parameter_description>
</parameter>
<parameter name="x">
@@ -51505,12 +54832,14 @@ from @self's surface coordinates into @self's widget coordinates.
<function name="gtk_native_realize">
<description>
-Realizes a #GtkNative.
+Realizes a `GtkNative`.
+
+This should only be used by subclasses.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNative
+<parameter_description> a `GtkNative`
</parameter_description>
</parameter>
</parameters>
@@ -51519,12 +54848,14 @@ Realizes a #GtkNative.
<function name="gtk_native_unrealize">
<description>
-Unrealizes a #GtkNative.
+Unrealizes a `GtkNative`.
+
+This should only be used by subclasses.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNative
+<parameter_description> a `GtkNative`
</parameter_description>
</parameter>
</parameters>
@@ -51533,9 +54864,11 @@ Unrealizes a #GtkNative.
<function name="gtk_never_trigger_get">
<description>
-Gets the never trigger. This is a singleton for a trigger
-that never triggers. Use this trigger instead of %NULL
-because it implements all virtual functions.
+Gets the never trigger.
+
+This is a singleton for a trigger that never triggers.
+Use this trigger instead of %NULL because it implements
+all virtual functions.
</description>
@@ -51553,7 +54886,7 @@ Gets the model that @self is wrapping.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNoSelection
+<parameter_description> a `GtkNoSelection`
</parameter_description>
</parameter>
</parameters>
@@ -51569,27 +54902,28 @@ Creates a new selection to handle @model.
</description>
<parameters>
<parameter name="model">
-<parameter_description> the #GListModel to manage, or %NULL
+<parameter_description> the `GListModel` to manage, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkNoSelection
+<return> a new `GtkNoSelection`
</return>
</function>
<function name="gtk_no_selection_set_model">
<description>
Sets the model that @self should wrap.
+
If @model is %NULL, this model will be empty.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNoSelection
+<parameter_description> a `GtkNoSelection`
</parameter_description>
</parameter>
<parameter name="model">
-<parameter_description> A #GListModel to wrap
+<parameter_description> A `GListModel` to wrap
</parameter_description>
</parameter>
</parameters>
@@ -51604,15 +54938,15 @@ Appends a page to @notebook.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to use as the contents of the page
+<parameter_description> the `GtkWidget` to use as the contents of the page
</parameter_description>
</parameter>
<parameter name="tab_label">
-<parameter_description> the #GtkWidget to be used as the label
+<parameter_description> the `GtkWidget` to be used as the label
for the page, or %NULL to use the default label, “page N”
</parameter_description>
</parameter>
@@ -51631,15 +54965,15 @@ label in the popup menu.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to use as the contents of the page
+<parameter_description> the `GtkWidget` to use as the contents of the page
</parameter_description>
</parameter>
<parameter name="tab_label">
-<parameter_description> the #GtkWidget to be used as the label
+<parameter_description> the `GtkWidget` to be used as the label
for the page, or %NULL to use the default label, “page N”
</parameter_description>
</parameter>
@@ -51648,7 +54982,7 @@ for the page, or %NULL to use the default label, “page N”
page-switch menu, if that is enabled. If %NULL, and @tab_label
is a #GtkLabel or %NULL, then the menu label will be a newly
created label with the same text as @tab_label; if @tab_label
-is not a #GtkLabel, @menu_label must be specified if the
+is not a `GtkLabel`, @menu_label must be specified if the
page-switch menu is to be used.
</parameter_description>
</parameter>
@@ -51662,7 +54996,7 @@ page in the notebook, or -1 if function fails
<description>
Removes the child from the notebook.
-This function is very similar to gtk_notebook_remove_page(),
+This function is very similar to [method@Gtk.Notebook.remove_page],
but additionally informs the notebook that the removal
is happening as part of a tab DND operation, which should
not be cancelled.
@@ -51670,7 +55004,7 @@ not be cancelled.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
@@ -51683,13 +55017,15 @@ not be cancelled.
<function name="gtk_notebook_get_action_widget">
<description>
-Gets one of the action widgets. See gtk_notebook_set_action_widget().
+Gets one of the action widgets.
+
+See [method@Gtk.Notebook.set_action_widget].
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="pack_type">
@@ -51697,8 +55033,9 @@ Gets one of the action widgets. See gtk_notebook_set_action_widget().
</parameter_description>
</parameter>
</parameters>
-<return> The action widget with the given
-@pack_type or %NULL when this action widget has not been set
+<return> The action widget
+with the given @pack_type or %NULL when this action
+widget has not been set
</return>
</function>
@@ -51710,7 +55047,7 @@ Returns the page number of the current page.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
</parameters>
@@ -51728,11 +55065,12 @@ Gets the current group name for @notebook.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
</parameters>
-<return> the group name, or %NULL if none is set
+<return> the group name,
+or %NULL if none is set
</return>
</function>
@@ -51744,7 +55082,7 @@ Retrieves the menu label widget of the page containing @child.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
@@ -51752,9 +55090,9 @@ Retrieves the menu label widget of the page containing @child.
</parameter_description>
</parameter>
</parameters>
-<return> the menu label, or %NULL if the
-notebook page does not have a menu label other than the default (the tab
-label).
+<return> the menu label, or %NULL
+if the notebook page does not have a menu label other than
+the default (the tab label).
</return>
</function>
@@ -51767,7 +55105,7 @@ Retrieves the text of the menu label for the page containing
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
@@ -51775,10 +55113,10 @@ Retrieves the text of the menu label for the page containing
</parameter_description>
</parameter>
</parameters>
-<return> the text of the tab label, or %NULL if the widget does
-not have a menu label other than the default menu label, or the menu label
-widget is not a #GtkLabel. The string is owned by the widget and must not be
-freed.
+<return> the text of the tab label, or %NULL if
+the widget does not have a menu label other than the default
+menu label, or the menu label widget is not a `GtkLabel`.
+The string is owned by the widget and must not be freed.
</return>
</function>
@@ -51790,7 +55128,7 @@ Gets the number of pages in a notebook.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
</parameters>
@@ -51806,7 +55144,7 @@ Returns the child widget contained in page number @page_num.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="page_num">
@@ -51822,13 +55160,13 @@ is out of bounds
<function name="gtk_notebook_get_page">
<description>
-Returns the #GtkNotebookPage for @child.
+Returns the `GtkNotebookPage` for @child.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
@@ -51836,38 +55174,40 @@ Returns the #GtkNotebookPage for @child.
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkNotebookPage for @child
+<return> the `GtkNotebookPage` for @child
</return>
</function>
<function name="gtk_notebook_get_pages">
<description>
-Returns a #GListModel that contains the pages of the notebook,
-and can be used to keep an up-to-date view.
+Returns a `GListModel` that contains the pages of the notebook.
+
+This can be used to keep an up-to-date view. The model also
+implements [iface@Gtk.SelectionModel] and can be used to track
+and modify the visible page.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
</parameters>
<return> a
-#GListModel for the notebook's children
+`GListModel` for the notebook's children
</return>
</function>
<function name="gtk_notebook_get_scrollable">
<description>
Returns whether the tab label area has arrows for scrolling.
-See gtk_notebook_set_scrollable().
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
</parameters>
@@ -51878,13 +55218,12 @@ See gtk_notebook_set_scrollable().
<function name="gtk_notebook_get_show_border">
<description>
Returns whether a bevel will be drawn around the notebook pages.
-See gtk_notebook_set_show_border().
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
</parameters>
@@ -51895,13 +55234,12 @@ See gtk_notebook_set_show_border().
<function name="gtk_notebook_get_show_tabs">
<description>
Returns whether the tabs of the notebook are shown.
-See gtk_notebook_set_show_tabs().
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
</parameters>
@@ -51917,11 +55255,11 @@ Returns whether the tab contents can be detached from @notebook.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> a child #GtkWidget
+<parameter_description> a child `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -51932,6 +55270,7 @@ Returns whether the tab contents can be detached from @notebook.
<function name="gtk_notebook_get_tab_label">
<description>
Returns the tab label widget for the page @child.
+
%NULL is returned if @child is not in @notebook or
if no tab label has specifically been set for @child.
@@ -51939,7 +55278,7 @@ if no tab label has specifically been set for @child.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
@@ -51960,7 +55299,7 @@ Retrieves the text of the tab label for the page containing
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
@@ -51968,22 +55307,21 @@ Retrieves the text of the tab label for the page containing
</parameter_description>
</parameter>
</parameters>
-<return> the text of the tab label, or %NULL if the tab label
-widget is not a #GtkLabel. The string is owned by the widget and must not be
-freed.
+<return> the text of the tab label, or %NULL if
+the tab label idget is not a `GtkLabel`. The string is owned
+by the widget and must not be freed.
</return>
</function>
<function name="gtk_notebook_get_tab_pos">
<description>
-Gets the edge at which the tabs for switching pages in the
-notebook are drawn.
+Gets the edge at which the tabs are drawn.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
</parameters>
@@ -51999,11 +55337,11 @@ Gets whether the tab can be reordered via drag and drop or not.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> a child #GtkWidget
+<parameter_description> a child `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -52019,15 +55357,15 @@ Insert a page into @notebook at the given position.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to use as the contents of the page
+<parameter_description> the `GtkWidget` to use as the contents of the page
</parameter_description>
</parameter>
<parameter name="tab_label">
-<parameter_description> the #GtkWidget to be used as the label
+<parameter_description> the `GtkWidget` to be used as the label
for the page, or %NULL to use the default label, “page N”
</parameter_description>
</parameter>
@@ -52051,15 +55389,15 @@ the widget to use as the label in the popup menu.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to use as the contents of the page
+<parameter_description> the `GtkWidget` to use as the contents of the page
</parameter_description>
</parameter>
<parameter name="tab_label">
-<parameter_description> the #GtkWidget to be used as the label
+<parameter_description> the `GtkWidget` to be used as the label
for the page, or %NULL to use the default label, “page N”
</parameter_description>
</parameter>
@@ -52085,25 +55423,26 @@ page in the notebook
<function name="gtk_notebook_new">
<description>
-Creates a new #GtkNotebook widget with no pages.
+Creates a new `GtkNotebook` widget with no pages.
</description>
<parameters>
</parameters>
-<return> the newly created #GtkNotebook
+<return> the newly created `GtkNotebook`
</return>
</function>
<function name="gtk_notebook_next_page">
<description>
-Switches to the next page. Nothing happens if the current page is
-the last page.
+Switches to the next page.
+
+Nothing happens if the current page is the last page.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
</parameters>
@@ -52118,7 +55457,7 @@ Returns the notebook child to which @page belongs.
</description>
<parameters>
<parameter name="page">
-<parameter_description> a #GtkNotebookPage
+<parameter_description> a `GtkNotebookPage`
</parameter_description>
</parameter>
</parameters>
@@ -52135,11 +55474,11 @@ widget.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -52155,7 +55494,7 @@ Disables the popup menu.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
</parameters>
@@ -52164,14 +55503,15 @@ Disables the popup menu.
<function name="gtk_notebook_popup_enable">
<description>
-Enables the popup menu: if the user clicks with the right
-mouse button on the tab labels, a menu with all the pages
-will be popped up.
+Enables the popup menu.
+
+If the user clicks with the right mouse button on the tab labels,
+a menu with all the pages will be popped up.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
</parameters>
@@ -52186,11 +55526,11 @@ Prepends a page to @notebook.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to use as the contents of the page
+<parameter_description> the `GtkWidget` to use as the contents of the page
</parameter_description>
</parameter>
<parameter name="tab_label">
@@ -52213,15 +55553,15 @@ label in the popup menu.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to use as the contents of the page
+<parameter_description> the `GtkWidget` to use as the contents of the page
</parameter_description>
</parameter>
<parameter name="tab_label">
-<parameter_description> the #GtkWidget to be used as the label
+<parameter_description> the `GtkWidget` to be used as the label
for the page, or %NULL to use the default label, “page N”
</parameter_description>
</parameter>
@@ -52242,13 +55582,14 @@ page in the notebook, or -1 if function fails
<function name="gtk_notebook_prev_page">
<description>
-Switches to the previous page. Nothing happens if the current page
-is the first page.
+Switches to the previous page.
+
+Nothing happens if the current page is the first page.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
</parameters>
@@ -52263,7 +55604,7 @@ in the notebook.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="page_num">
@@ -52278,14 +55619,15 @@ from 0. If -1, the last page will be removed.
<function name="gtk_notebook_reorder_child">
<description>
Reorders the page containing @child, so that it appears in position
-@position. If @position is greater than or equal to the number of
-children in the list or negative, @child will be moved to the end
-of the list.
+@position.
+
+If @position is greater than or equal to the number of children in
+the list or negative, @child will be moved to the end of the list.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
@@ -52302,14 +55644,16 @@ of the list.
<function name="gtk_notebook_set_action_widget">
<description>
-Sets @widget as one of the action widgets. Depending on the pack type
-the widget will be placed before or after the tabs. You can use
-a #GtkBox if you need to pack more than one widget on the same side.
+Sets @widget as one of the action widgets.
+
+Depending on the pack type the widget will be placed before
+or after the tabs. You can use a `GtkBox` if you need to pack
+more than one widget on the same side.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="widget">
@@ -52336,7 +55680,7 @@ adding them to a notebook.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="page_num">
@@ -52361,7 +55705,7 @@ not be able to exchange tabs with any other notebook.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="group_name">
@@ -52380,7 +55724,7 @@ Changes the menu label for the page containing @child.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
@@ -52402,7 +55746,7 @@ Creates a new label and sets it as the menu label of @child.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
@@ -52425,7 +55769,7 @@ scrolling if there are too many tabs to fit in the area.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="scrollable">
@@ -52439,13 +55783,13 @@ scrolling if there are too many tabs to fit in the area.
<function name="gtk_notebook_set_show_border">
<description>
Sets whether a bevel will be drawn around the notebook pages.
+
This only has a visual effect when the tabs are not shown.
-See gtk_notebook_set_show_tabs().
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="show_border">
@@ -52463,7 +55807,7 @@ Sets whether to show the tabs for the notebook or not.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="show_tabs">
@@ -52479,8 +55823,8 @@ Sets whether to show the tabs for the notebook or not.
Sets whether the tab can be detached from @notebook to another
notebook or widget.
-Note that 2 notebooks must share a common group identificator
-(see gtk_notebook_set_group_name()) to allow automatic tabs
+Note that two notebooks must share a common group identificator
+(see [method@Gtk.Notebook.set_group_name]) to allow automatic tabs
interchange between them.
If you want a widget to interact with a notebook through DnD
@@ -52489,14 +55833,14 @@ destination and accept the target “GTK_NOTEBOOK_TAB”. The notebook
will fill the selection with a GtkWidget** pointing to the child
widget that corresponds to the dropped tab.
-Note that you should use gtk_notebook_detach_tab() instead of
-gtk_notebook_remove_page() if you want to remove the tab from
-the source notebook as part of accepting a drop. Otherwise,
-the source notebook will think that the dragged tab was
-removed from underneath the ongoing drag operation, and
-will initiate a drag cancel animation.
+Note that you should use [method@Gtk.Notebook.detach_tab] instead
+of [method@Gtk.Notebook.remove_page] if you want to remove the tab
+from the source notebook as part of accepting a drop. Otherwise,
+the source notebook will think that the dragged tab was removed
+from underneath the ongoing drag operation, and will initiate a
+drag cancel animation.
-|[<!-- language="C" -->
+```c
static void
on_drag_data_received (GtkWidget *widget,
GdkDrop *drop,
@@ -52516,7 +55860,7 @@ child = (void*) gtk_selection_data_get_data (data);
gtk_notebook_detach_tab (GTK_NOTEBOOK (notebook), *child);
}
-]|
+```
If you want a notebook to accept drags from other widgets,
you will have to set your own DnD code to do it.
@@ -52524,11 +55868,11 @@ you will have to set your own DnD code to do it.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> a child #GtkWidget
+<parameter_description> a child `GtkWidget`
</parameter_description>
</parameter>
<parameter name="detachable">
@@ -52542,13 +55886,14 @@ you will have to set your own DnD code to do it.
<function name="gtk_notebook_set_tab_label">
<description>
Changes the tab label for @child.
+
If %NULL is specified for @tab_label, then the page will
have the label “page N”.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
@@ -52572,7 +55917,7 @@ containing @child.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
@@ -52589,13 +55934,12 @@ containing @child.
<function name="gtk_notebook_set_tab_pos">
<description>
-Sets the edge at which the tabs for switching pages in the
-notebook are drawn.
+Sets the edge at which the tabs are drawn.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook.
+<parameter_description> a `GtkNotebook`.
</parameter_description>
</parameter>
<parameter name="pos">
@@ -52614,11 +55958,11 @@ via drag and drop or not.
</description>
<parameters>
<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter_description> a `GtkNotebook`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> a child #GtkWidget
+<parameter_description> a child `GtkWidget`
</parameter_description>
</parameter>
<parameter name="reorderable">
@@ -52631,7 +55975,9 @@ via drag and drop or not.
<function name="gtk_nothing_action_get">
<description>
-Gets the nothing action. This is an action that does nothing and where
+Gets the nothing action.
+
+This is an action that does nothing and where
activating it always fails.
@@ -52650,11 +55996,11 @@ Gets the expression that is evaluated to obtain numbers from items.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNumericSorter
+<parameter_description> a `GtkNumericSorter`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkExpression, or %NULL
+<return> a `GtkExpression`, or %NULL
</return>
</function>
@@ -52666,7 +56012,7 @@ Gets whether this sorter will sort smaller numbers first.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNumericSorter
+<parameter_description> a `GtkNumericSorter`
</parameter_description>
</parameter>
</parameters>
@@ -52679,7 +56025,7 @@ Gets whether this sorter will sort smaller numbers first.
Creates a new numeric sorter using the given @expression.
Smaller numbers will be sorted first. You can call
-gtk_numeric_sorter_set_sort_order() to change this.
+[method@Gtk.NumericSorter.set_sort_order] to change this.
</description>
@@ -52689,7 +56035,7 @@ gtk_numeric_sorter_set_sort_order() to change this.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkNumericSorter
+<return> a new `GtkNumericSorter`
</return>
</function>
@@ -52701,16 +56047,16 @@ Unless an expression is set on @self, the sorter will always
compare items as invalid.
The expression must have a return type that can be compared
-numerically, such as #G_TYPE_INT or #G_TYPE_DOUBLE.
+numerically, such as %G_TYPE_INT or %G_TYPE_DOUBLE.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNumericSorter
+<parameter_description> a `GtkNumericSorter`
</parameter_description>
</parameter>
<parameter name="expression">
-<parameter_description> a #GtkExpression, or %NULL
+<parameter_description> a `GtkExpression`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -52724,7 +56070,7 @@ Sets whether to sort smaller numbers before larger ones.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkNumericSorter
+<parameter_description> a `GtkNumericSorter`
</parameter_description>
</parameter>
<parameter name="sort_order">
@@ -52743,21 +56089,23 @@ Gets the object that the expression evaluates to.
</description>
<parameters>
<parameter name="expression">
-<parameter_description> an object #GtkExpression
+<parameter_description> an object `GtkExpression`
</parameter_description>
</parameter>
</parameters>
-<return> the object, or %NULL
+<return> the object, or `NULL`
</return>
</function>
<function name="gtk_object_expression_new">
<description>
-Creates an expression evaluating to the given @object with a weak reference.
-Once the @object is disposed, it will fail to evaluate.
+Creates an expression evaluating to the given `object` with a weak reference.
+
+Once the `object` is disposed, it will fail to evaluate.
+
This expression is meant to break reference cycles.
-If you want to keep a reference to @object, use gtk_constant_expression_new().
+If you want to keep a reference to `object`, use [ctor Gtk ConstantExpression new].
</description>
@@ -52767,13 +56115,14 @@ If you want to keep a reference to @object, use gtk_constant_expression_new().
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkExpression
+<return> a new `GtkExpression`
</return>
</function>
<function name="gtk_ordering_from_cmpfunc">
<description>
-Converts the result of a #GCompareFunc like strcmp() to a #GtkOrdering.
+Converts the result of a `GCompareFunc` like strcmp() to a
+`GtkOrdering` value.
</description>
@@ -52783,7 +56132,7 @@ Converts the result of a #GCompareFunc like strcmp() to a #GtkOrdering.
</parameter_description>
</parameter>
</parameters>
-<return> the corresponding #GtkOrdering
+<return> the corresponding `GtkOrdering`
</return>
</function>
@@ -52795,7 +56144,7 @@ Retrieves the orientation of the @orientable.
</description>
<parameters>
<parameter name="orientable">
-<parameter_description> a #GtkOrientable
+<parameter_description> a `GtkOrientable`
</parameter_description>
</parameter>
</parameters>
@@ -52810,7 +56159,7 @@ Sets the orientation of the @orientable.
</description>
<parameters>
<parameter name="orientable">
-<parameter_description> a #GtkOrientable
+<parameter_description> a `GtkOrientable`
</parameter_description>
</parameter>
<parameter name="orientation">
@@ -52826,19 +56175,20 @@ Sets the orientation of the @orientable.
Adds @widget to @overlay.
The widget will be stacked on top of the main widget
-added with gtk_overlay_set_child().
+added with [method@Gtk.Overlay.set_child].
The position at which @widget is placed is determined
-from its #GtkWidget:halign and #GtkWidget:valign properties.
+from its [property@Gtk.Widget:halign] and
+[property@Gtk.Widget:valign] properties.
</description>
<parameters>
<parameter name="overlay">
-<parameter_description> a #GtkOverlay
+<parameter_description> a `GtkOverlay`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> a #GtkWidget to be added to the container
+<parameter_description> a `GtkWidget` to be added to the container
</parameter_description>
</parameter>
</parameters>
@@ -52853,7 +56203,7 @@ Gets the child widget of @overlay.
</description>
<parameters>
<parameter name="overlay">
-<parameter_description> a #GtkOverlay
+<parameter_description> a `GtkOverlay`
</parameter_description>
</parameter>
</parameters>
@@ -52869,11 +56219,11 @@ Gets whether @widget should be clipped within the parent.
</description>
<parameters>
<parameter name="overlay">
-<parameter_description> a #GtkOverlay
+<parameter_description> a `GtkOverlay`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> an overlay child of #GtkOverlay
+<parameter_description> an overlay child of `GtkOverlay`
</parameter_description>
</parameter>
</parameters>
@@ -52890,11 +56240,11 @@ Gets whether @widget's size is included in the measurement of
</description>
<parameters>
<parameter name="overlay">
-<parameter_description> a #GtkOverlay
+<parameter_description> a `GtkOverlay`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> an overlay child of #GtkOverlay
+<parameter_description> an overlay child of `GtkOverlay`
</parameter_description>
</parameter>
</parameters>
@@ -52910,7 +56260,7 @@ Retrieves whether the child is clipped.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkOverlayLayoutChild
+<parameter_description> a `GtkOverlayLayoutChild`
</parameter_description>
</parameter>
</parameters>
@@ -52926,7 +56276,7 @@ Retrieves whether the child is measured.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkOverlayLayoutChild
+<parameter_description> a `GtkOverlayLayoutChild`
</parameter_description>
</parameter>
</parameters>
@@ -52941,7 +56291,7 @@ Sets whether to clip this child.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkOverlayLayoutChild
+<parameter_description> a `GtkOverlayLayoutChild`
</parameter_description>
</parameter>
<parameter name="clip_overlay">
@@ -52959,7 +56309,7 @@ Sets whether to measure this child.
</description>
<parameters>
<parameter name="child">
-<parameter_description> a #GtkOverlayLayoutChild
+<parameter_description> a `GtkOverlayLayoutChild`
</parameter_description>
</parameter>
<parameter name="measure">
@@ -52972,7 +56322,7 @@ Sets whether to measure this child.
<function name="gtk_overlay_layout_new">
<description>
-Creates a new #GtkOverlayLayout instance.
+Creates a new `GtkOverlayLayout` instance.
</description>
@@ -52984,13 +56334,13 @@ Creates a new #GtkOverlayLayout instance.
<function name="gtk_overlay_new">
<description>
-Creates a new #GtkOverlay.
+Creates a new `GtkOverlay`.
</description>
<parameters>
</parameters>
-<return> a new #GtkOverlay object.
+<return> a new `GtkOverlay` object.
</return>
</function>
@@ -53001,11 +56351,11 @@ Removes an overlay that was added with gtk_overlay_add_overlay().
</description>
<parameters>
<parameter name="overlay">
-<parameter_description> a #GtkOverlay
+<parameter_description> a `GtkOverlay`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> a #GtkWidget to be removed
+<parameter_description> a `GtkWidget` to be removed
</parameter_description>
</parameter>
</parameters>
@@ -53019,7 +56369,7 @@ Sets the child widget of @overlay.
</description>
<parameters>
<parameter name="overlay">
-<parameter_description> a #GtkOverlay
+<parameter_description> a `GtkOverlay`
</parameter_description>
</parameter>
<parameter name="child">
@@ -53037,11 +56387,11 @@ Sets whether @widget should be clipped within the parent.
</description>
<parameters>
<parameter name="overlay">
-<parameter_description> a #GtkOverlay
+<parameter_description> a `GtkOverlay`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> an overlay child of #GtkOverlay
+<parameter_description> an overlay child of `GtkOverlay`
</parameter_description>
</parameter>
<parameter name="clip_overlay">
@@ -53063,11 +56413,11 @@ be drawn outside of @overlay's allocation if they are too large.
</description>
<parameters>
<parameter name="overlay">
-<parameter_description> a #GtkOverlay
+<parameter_description> a `GtkOverlay`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> an overlay child of #GtkOverlay
+<parameter_description> an overlay child of `GtkOverlay`
</parameter_description>
</parameter>
<parameter name="measure">
@@ -53080,24 +56430,26 @@ be drawn outside of @overlay's allocation if they are too large.
<function name="gtk_pad_controller_new">
<description>
-Creates a new #GtkPadController that will associate events from @pad to
-actions. A %NULL pad may be provided so the controller manages all pad devices
-generically, it is discouraged to mix #GtkPadController objects with %NULL
-and non-%NULL @pad argument on the same toplevel window, as execution order
-is not guaranteed.
+Creates a new `GtkPadController` that will associate events from @pad to
+actions.
+
+A %NULL pad may be provided so the controller manages all pad devices
+generically, it is discouraged to mix `GtkPadController` objects with
+%NULL and non-%NULL @pad argument on the same toplevel window, as execution
+order is not guaranteed.
-The #GtkPadController is created with no mapped actions. In order to map pad
-events to actions, use gtk_pad_controller_set_action_entries() or
-gtk_pad_controller_set_action().
+The `GtkPadController` is created with no mapped actions. In order to
+map pad events to actions, use [method@Gtk.PadController.set_action_entries]
+or [method@Gtk.PadController.set_action].
-Be aware that pad events will only be delivered to #GtkWindows, so adding a pad
-controller to any other type of widget will not have an effect.
+Be aware that pad events will only be delivered to `GtkWindow`s, so adding
+a pad controller to any other type of widget will not have an effect.
</description>
<parameters>
<parameter name="group">
-<parameter_description> #GActionGroup to trigger actions from
+<parameter_description> `GActionGroup` to trigger actions from
</parameter_description>
</parameter>
<parameter name="pad">
@@ -53105,16 +56457,17 @@ controller to any other type of widget will not have an effect.
</parameter_description>
</parameter>
</parameters>
-<return> A newly created #GtkPadController
+<return> A newly created `GtkPadController`
</return>
</function>
<function name="gtk_pad_controller_set_action">
<description>
-Adds an individual action to @controller. This action will only be activated
-if the given button/ring/strip number in @index is interacted while
-the current mode is @mode. -1 may be used for simple cases, so the action
-is triggered on all modes.
+Adds an individual action to @controller.
+
+This action will only be activated if the given button/ring/strip number
+in @index is interacted while the current mode is @mode. -1 may be used
+for simple cases, so the action is triggered on all modes.
The given @label should be considered user-visible, so internationalization
rules apply. Some windowing systems may be able to use those for user
@@ -53123,7 +56476,7 @@ feedback.
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkPadController
+<parameter_description> a `GtkPadController`
</parameter_description>
</parameter>
<parameter name="type">
@@ -53153,13 +56506,15 @@ be deemed user-visible.
<function name="gtk_pad_controller_set_action_entries">
<description>
-This is a convenience function to add a group of action entries on
-@controller. See #GtkPadActionEntry and gtk_pad_controller_set_action().
+A convenience function to add a group of action entries on
+@controller.
+
+See [struct@Gtk.PadActionEntry] and [method@Gtk.PadController.set_action].
</description>
<parameters>
<parameter name="controller">
-<parameter_description> a #GtkPadController
+<parameter_description> a `GtkPadController`
</parameter_description>
</parameter>
<parameter name="entries">
@@ -53176,13 +56531,13 @@ This is a convenience function to add a group of action entries on
<function name="gtk_page_setup_copy">
<description>
-Copies a #GtkPageSetup.
+Copies a `GtkPageSetup`.
</description>
<parameters>
<parameter name="other">
-<parameter_description> the #GtkPageSetup to copy
+<parameter_description> the `GtkPageSetup` to copy
</parameter_description>
</parameter>
</parameters>
@@ -53198,7 +56553,7 @@ Gets the bottom margin in units of @unit.
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="unit">
@@ -53218,7 +56573,7 @@ Gets the left margin in units of @unit.
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="unit">
@@ -53232,13 +56587,13 @@ Gets the left margin in units of @unit.
<function name="gtk_page_setup_get_orientation">
<description>
-Gets the page orientation of the #GtkPageSetup.
+Gets the page orientation of the `GtkPageSetup`.
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
</parameters>
@@ -53250,15 +56605,15 @@ Gets the page orientation of the #GtkPageSetup.
<description>
Returns the page height in units of @unit.
-Note that this function takes orientation and
-margins into consideration.
-See gtk_page_setup_get_paper_height().
+Note that this function takes orientation
+and margins into consideration.
+See [method@Gtk.PageSetup.get_paper_height].
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="unit">
@@ -53274,15 +56629,15 @@ See gtk_page_setup_get_paper_height().
<description>
Returns the page width in units of @unit.
-Note that this function takes orientation and
-margins into consideration.
-See gtk_page_setup_get_paper_width().
+Note that this function takes orientation
+and margins into consideration.
+See [method@Gtk.PageSetup.get_paper_width].
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="unit">
@@ -53298,15 +56653,15 @@ See gtk_page_setup_get_paper_width().
<description>
Returns the paper height in units of @unit.
-Note that this function takes orientation, but
-not margins into consideration.
-See gtk_page_setup_get_page_height().
+Note that this function takes orientation,
+but not margins into consideration.
+See [method@Gtk.PageSetup.get_page_height].
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="unit">
@@ -53320,13 +56675,13 @@ See gtk_page_setup_get_page_height().
<function name="gtk_page_setup_get_paper_size">
<description>
-Gets the paper size of the #GtkPageSetup.
+Gets the paper size of the `GtkPageSetup`.
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
</parameters>
@@ -53338,15 +56693,15 @@ Gets the paper size of the #GtkPageSetup.
<description>
Returns the paper width in units of @unit.
-Note that this function takes orientation, but
-not margins into consideration.
-See gtk_page_setup_get_page_width().
+Note that this function takes orientation,
+but not margins into consideration.
+See [method@Gtk.PageSetup.get_page_width].
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="unit">
@@ -53366,7 +56721,7 @@ Gets the right margin in units of @unit.
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="unit">
@@ -53386,7 +56741,7 @@ Gets the top margin in units of @unit.
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="unit">
@@ -53401,13 +56756,14 @@ Gets the top margin in units of @unit.
<function name="gtk_page_setup_load_file">
<description>
Reads the page setup from the file @file_name.
-See gtk_page_setup_to_file().
+
+See [method@Gtk.PageSetup.to_file].
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="file_name">
@@ -53432,11 +56788,11 @@ Reads the page setup from the group @group_name in the key file
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="key_file">
-<parameter_description> the #GKeyFile to retrieve the page_setup from
+<parameter_description> the `GKeyFile` to retrieve the page_setup from
</parameter_description>
</parameter>
<parameter name="group_name">
@@ -53455,21 +56811,19 @@ to use the default name “Page Setup”
<function name="gtk_page_setup_new">
<description>
-Creates a new #GtkPageSetup.
+Creates a new `GtkPageSetup`.
</description>
<parameters>
</parameters>
-<return> a new #GtkPageSetup.
+<return> a new `GtkPageSetup`.
</return>
</function>
<function name="gtk_page_setup_new_from_file">
<description>
-Reads the page setup from the file @file_name. Returns a
-new #GtkPageSetup object with the restored page setup,
-or %NULL if an error occurred. See gtk_page_setup_to_file().
+Reads the page setup from the file @file_name.
</description>
@@ -53483,38 +56837,39 @@ or %NULL if an error occurred. See gtk_page_setup_to_file().
</parameter_description>
</parameter>
</parameters>
-<return> the restored #GtkPageSetup
+<return> the restored `GtkPageSetup`
</return>
</function>
<function name="gtk_page_setup_new_from_gvariant">
<description>
-Desrialize a page setup from an a{sv} variant in
-the format produced by gtk_page_setup_to_gvariant().
+Desrialize a page setup from an a{sv} variant.
+
+The variant must be in the format produced by
+[method@Gtk.PageSetup.to_gvariant].
</description>
<parameters>
<parameter name="variant">
-<parameter_description> an a{sv} #GVariant
+<parameter_description> an a{sv} `GVariant`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPageSetup object
+<return> a new `GtkPageSetup` object
</return>
</function>
<function name="gtk_page_setup_new_from_key_file">
<description>
Reads the page setup from the group @group_name in the key file
-@key_file. Returns a new #GtkPageSetup object with the restored
-page setup, or %NULL if an error occurred.
+@key_file.
</description>
<parameters>
<parameter name="key_file">
-<parameter_description> the #GKeyFile to retrieve the page_setup from
+<parameter_description> the `GKeyFile` to retrieve the page_setup from
</parameter_description>
</parameter>
<parameter name="group_name">
@@ -53527,18 +56882,18 @@ to use the default name “Page Setup”
</parameter_description>
</parameter>
</parameters>
-<return> the restored #GtkPageSetup
+<return> the restored `GtkPageSetup`
</return>
</function>
<function name="gtk_page_setup_set_bottom_margin">
<description>
-Sets the bottom margin of the #GtkPageSetup.
+Sets the bottom margin of the `GtkPageSetup`.
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="margin">
@@ -53555,12 +56910,12 @@ Sets the bottom margin of the #GtkPageSetup.
<function name="gtk_page_setup_set_left_margin">
<description>
-Sets the left margin of the #GtkPageSetup.
+Sets the left margin of the `GtkPageSetup`.
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="margin">
@@ -53577,12 +56932,12 @@ Sets the left margin of the #GtkPageSetup.
<function name="gtk_page_setup_set_orientation">
<description>
-Sets the page orientation of the #GtkPageSetup.
+Sets the page orientation of the `GtkPageSetup`.
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="orientation">
@@ -53595,18 +56950,19 @@ Sets the page orientation of the #GtkPageSetup.
<function name="gtk_page_setup_set_paper_size">
<description>
-Sets the paper size of the #GtkPageSetup without
-changing the margins. See
-gtk_page_setup_set_paper_size_and_default_margins().
+Sets the paper size of the `GtkPageSetup` without
+changing the margins.
+
+See [method@Gtk.PageSetup.set_paper_size_and_default_margins].
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="size">
-<parameter_description> a #GtkPaperSize
+<parameter_description> a #GtkPaperSize
</parameter_description>
</parameter>
</parameters>
@@ -53615,17 +56971,17 @@ gtk_page_setup_set_paper_size_and_default_margins().
<function name="gtk_page_setup_set_paper_size_and_default_margins">
<description>
-Sets the paper size of the #GtkPageSetup and modifies
+Sets the paper size of the `GtkPageSetup` and modifies
the margins according to the new paper size.
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="size">
-<parameter_description> a #GtkPaperSize
+<parameter_description> a #GtkPaperSize
</parameter_description>
</parameter>
</parameters>
@@ -53634,12 +56990,12 @@ the margins according to the new paper size.
<function name="gtk_page_setup_set_right_margin">
<description>
-Sets the right margin of the #GtkPageSetup.
+Sets the right margin of the `GtkPageSetup`.
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="margin">
@@ -53656,12 +57012,12 @@ Sets the right margin of the #GtkPageSetup.
<function name="gtk_page_setup_set_top_margin">
<description>
-Sets the top margin of the #GtkPageSetup.
+Sets the top margin of the `GtkPageSetup`.
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="margin">
@@ -53684,7 +57040,7 @@ This function saves the information from @setup to @file_name.
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="file_name">
@@ -53709,7 +57065,7 @@ Return: (transfer none): a new, floating, #GVariant
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
</parameters>
@@ -53723,11 +57079,11 @@ This function adds the page setup from @setup to @key_file.
</description>
<parameters>
<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
<parameter name="key_file">
-<parameter_description> the #GKeyFile to save the page setup to
+<parameter_description> the `GKeyFile` to save the page setup to
</parameter_description>
</parameter>
<parameter name="group_name">
@@ -53747,7 +57103,7 @@ Gets the currently selected page setup from the dialog.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPageSetupUnixDialog
+<parameter_description> a `GtkPageSetupUnixDialog`
</parameter_description>
</parameter>
</parameters>
@@ -53763,7 +57119,7 @@ Gets the current print settings from the dialog.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPageSetupUnixDialog
+<parameter_description> a `GtkPageSetupUnixDialog`
</parameter_description>
</parameter>
</parameters>
@@ -53787,23 +57143,23 @@ Creates a new page setup dialog.
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkPageSetupUnixDialog
+<return> the new `GtkPageSetupUnixDialog`
</return>
</function>
<function name="gtk_page_setup_unix_dialog_set_page_setup">
<description>
-Sets the #GtkPageSetup from which the page setup
+Sets the `GtkPageSetup` from which the page setup
dialog takes its values.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPageSetupUnixDialog
+<parameter_description> a `GtkPageSetupUnixDialog`
</parameter_description>
</parameter>
<parameter name="page_setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
</parameters>
@@ -53812,17 +57168,17 @@ dialog takes its values.
<function name="gtk_page_setup_unix_dialog_set_print_settings">
<description>
-Sets the #GtkPrintSettings from which the page setup dialog
+Sets the `GtkPrintSettings` from which the page setup dialog
takes its values.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPageSetupUnixDialog
+<parameter_description> a `GtkPageSetupUnixDialog`
</parameter_description>
</parameter>
<parameter name="print_settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -53831,15 +57187,15 @@ takes its values.
<function name="gtk_paned_get_end_child">
<description>
-Retrieves the end child of the given #GtkPaned.
+Retrieves the end child of the given `GtkPaned`.
-See also: #GtkPaned:end-child
+See also: `GtkPaned`:end-child
</description>
<parameters>
<parameter name="paned">
-<parameter_description> a #GtkPaned
+<parameter_description> a `GtkPaned`
</parameter_description>
</parameter>
</parameters>
@@ -53855,7 +57211,7 @@ Obtains the position of the divider between the two panes.
</description>
<parameters>
<parameter name="paned">
-<parameter_description> a #GtkPaned widget
+<parameter_description> a `GtkPaned` widget
</parameter_description>
</parameter>
</parameters>
@@ -53871,7 +57227,7 @@ Returns whether the end child can be resized.
</description>
<parameters>
<parameter name="paned">
-<parameter_description> a #GtkPaned
+<parameter_description> a `GtkPaned`
</parameter_description>
</parameter>
</parameters>
@@ -53887,7 +57243,7 @@ Returns whether the start child can be resized.
</description>
<parameters>
<parameter name="paned">
-<parameter_description> a #GtkPaned
+<parameter_description> a `GtkPaned`
</parameter_description>
</parameter>
</parameters>
@@ -53903,7 +57259,7 @@ Returns whether the end child can be shrunk.
</description>
<parameters>
<parameter name="paned">
-<parameter_description> a #GtkPaned
+<parameter_description> a `GtkPaned`
</parameter_description>
</parameter>
</parameters>
@@ -53919,7 +57275,7 @@ Returns whether the start child can be shrunk.
</description>
<parameters>
<parameter name="paned">
-<parameter_description> a #GtkPaned
+<parameter_description> a `GtkPaned`
</parameter_description>
</parameter>
</parameters>
@@ -53929,15 +57285,15 @@ Returns whether the start child can be shrunk.
<function name="gtk_paned_get_start_child">
<description>
-Retrieves the start child of the given #GtkPaned.
+Retrieves the start child of the given `GtkPaned`.
-See also: #GtkPaned:start-child
+See also: `GtkPaned`:start-child
</description>
<parameters>
<parameter name="paned">
-<parameter_description> a #GtkPaned
+<parameter_description> a `GtkPaned`
</parameter_description>
</parameter>
</parameters>
@@ -53947,13 +57303,13 @@ See also: #GtkPaned:start-child
<function name="gtk_paned_get_wide_handle">
<description>
-Gets the #GtkPaned:wide-handle property.
+Gets whether the separator should be wide.
</description>
<parameters>
<parameter name="paned">
-<parameter_description> a #GtkPaned
+<parameter_description> a `GtkPaned`
</parameter_description>
</parameter>
</parameters>
@@ -53963,7 +57319,7 @@ Gets the #GtkPaned:wide-handle property.
<function name="gtk_paned_new">
<description>
-Creates a new #GtkPaned widget.
+Creates a new `GtkPaned` widget.
</description>
@@ -53973,7 +57329,7 @@ Creates a new #GtkPaned widget.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPaned.
+<return> a new `GtkPaned`.
</return>
</function>
@@ -53984,7 +57340,7 @@ Sets the end child of @paned to @child.
</description>
<parameters>
<parameter name="paned">
-<parameter_description> a #GtkPaned
+<parameter_description> a `GtkPaned`
</parameter_description>
</parameter>
<parameter name="child">
@@ -54002,7 +57358,7 @@ Sets the position of the divider between the two panes.
</description>
<parameters>
<parameter name="paned">
-<parameter_description> a #GtkPaned widget
+<parameter_description> a `GtkPaned` widget
</parameter_description>
</parameter>
<parameter name="position">
@@ -54016,12 +57372,12 @@ is unset.
<function name="gtk_paned_set_resize_end_child">
<description>
-Sets the #GtkPaned:resize-end-child property
+Sets the `GtkPaned`:resize-end-child property
</description>
<parameters>
<parameter name="paned">
-<parameter_description> a #GtkPaned
+<parameter_description> a `GtkPaned`
</parameter_description>
</parameter>
<parameter name="resize">
@@ -54034,12 +57390,12 @@ Sets the #GtkPaned:resize-end-child property
<function name="gtk_paned_set_resize_start_child">
<description>
-Sets the #GtkPaned:resize-start-child property
+Sets the `GtkPaned`:resize-start-child property
</description>
<parameters>
<parameter name="paned">
-<parameter_description> a #GtkPaned
+<parameter_description> a `GtkPaned`
</parameter_description>
</parameter>
<parameter name="resize">
@@ -54052,12 +57408,12 @@ Sets the #GtkPaned:resize-start-child property
<function name="gtk_paned_set_shrink_end_child">
<description>
-Sets the #GtkPaned:shrink-end-child property
+Sets the `GtkPaned`:shrink-end-child property
</description>
<parameters>
<parameter name="paned">
-<parameter_description> a #GtkPaned
+<parameter_description> a `GtkPaned`
</parameter_description>
</parameter>
<parameter name="resize">
@@ -54070,12 +57426,12 @@ Sets the #GtkPaned:shrink-end-child property
<function name="gtk_paned_set_shrink_start_child">
<description>
-Sets the #GtkPaned:shrink-start-child property
+Sets the `GtkPaned`:shrink-start-child property
</description>
<parameters>
<parameter name="paned">
-<parameter_description> a #GtkPaned
+<parameter_description> a `GtkPaned`
</parameter_description>
</parameter>
<parameter name="resize">
@@ -54093,7 +57449,7 @@ Sets the start child of @paned to @child.
</description>
<parameters>
<parameter name="paned">
-<parameter_description> a #GtkPaned
+<parameter_description> a `GtkPaned`
</parameter_description>
</parameter>
<parameter name="child">
@@ -54106,16 +57462,16 @@ Sets the start child of @paned to @child.
<function name="gtk_paned_set_wide_handle">
<description>
-Sets the #GtkPaned:wide-handle property.
+Sets whether the separator should be wide.
</description>
<parameters>
<parameter name="paned">
-<parameter_description> a #GtkPaned
+<parameter_description> a `GtkPaned`
</parameter_description>
</parameter>
<parameter name="wide">
-<parameter_description> the new value for the #GtkPaned:wide-handle property
+<parameter_description> the new value for the [property@Gtk.Paned:wide-handle] property
</parameter_description>
</parameter>
</parameters>
@@ -54124,13 +57480,13 @@ Sets the #GtkPaned:wide-handle property.
<function name="gtk_paper_size_copy">
<description>
-Copies an existing #GtkPaperSize.
+Copies an existing `GtkPaperSize`.
</description>
<parameters>
<parameter name="other">
-<parameter_description> a #GtkPaperSize
+<parameter_description> a `GtkPaperSize`
</parameter_description>
</parameter>
</parameters>
@@ -54140,12 +57496,12 @@ Copies an existing #GtkPaperSize.
<function name="gtk_paper_size_free">
<description>
-Free the given #GtkPaperSize object.
+Free the given `GtkPaperSize` object.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GtkPaperSize
+<parameter_description> a `GtkPaperSize`
</parameter_description>
</parameter>
</parameters>
@@ -54168,13 +57524,13 @@ is owned by GTK and should not be modified.
<function name="gtk_paper_size_get_default_bottom_margin">
<description>
-Gets the default bottom margin for the #GtkPaperSize.
+Gets the default bottom margin for the `GtkPaperSize`.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter_description> a `GtkPaperSize` object
</parameter_description>
</parameter>
<parameter name="unit">
@@ -54188,13 +57544,13 @@ Gets the default bottom margin for the #GtkPaperSize.
<function name="gtk_paper_size_get_default_left_margin">
<description>
-Gets the default left margin for the #GtkPaperSize.
+Gets the default left margin for the `GtkPaperSize`.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter_description> a `GtkPaperSize` object
</parameter_description>
</parameter>
<parameter name="unit">
@@ -54208,13 +57564,13 @@ Gets the default left margin for the #GtkPaperSize.
<function name="gtk_paper_size_get_default_right_margin">
<description>
-Gets the default right margin for the #GtkPaperSize.
+Gets the default right margin for the `GtkPaperSize`.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter_description> a `GtkPaperSize` object
</parameter_description>
</parameter>
<parameter name="unit">
@@ -54228,13 +57584,13 @@ Gets the default right margin for the #GtkPaperSize.
<function name="gtk_paper_size_get_default_top_margin">
<description>
-Gets the default top margin for the #GtkPaperSize.
+Gets the default top margin for the `GtkPaperSize`.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter_description> a `GtkPaperSize` object
</parameter_description>
</parameter>
<parameter name="unit">
@@ -54248,13 +57604,13 @@ Gets the default top margin for the #GtkPaperSize.
<function name="gtk_paper_size_get_display_name">
<description>
-Gets the human-readable name of the #GtkPaperSize.
+Gets the human-readable name of the `GtkPaperSize`.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter_description> a `GtkPaperSize` object
</parameter_description>
</parameter>
</parameters>
@@ -54264,14 +57620,14 @@ Gets the human-readable name of the #GtkPaperSize.
<function name="gtk_paper_size_get_height">
<description>
-Gets the paper height of the #GtkPaperSize, in
+Gets the paper height of the `GtkPaperSize`, in
units of @unit.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter_description> a `GtkPaperSize` object
</parameter_description>
</parameter>
<parameter name="unit">
@@ -54285,13 +57641,13 @@ units of @unit.
<function name="gtk_paper_size_get_name">
<description>
-Gets the name of the #GtkPaperSize.
+Gets the name of the `GtkPaperSize`.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter_description> a `GtkPaperSize` object
</parameter_description>
</parameter>
</parameters>
@@ -54313,20 +57669,20 @@ as defined in the page setup dialog
</parameter>
</parameters>
<return> a newly allocated list of newly
-allocated #GtkPaperSize objects
+allocated `GtkPaperSize` objects
</return>
</function>
<function name="gtk_paper_size_get_ppd_name">
<description>
-Gets the PPD name of the #GtkPaperSize, which
+Gets the PPD name of the `GtkPaperSize`, which
may be %NULL.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter_description> a `GtkPaperSize` object
</parameter_description>
</parameter>
</parameters>
@@ -54336,14 +57692,14 @@ may be %NULL.
<function name="gtk_paper_size_get_width">
<description>
-Gets the paper width of the #GtkPaperSize, in
+Gets the paper width of the `GtkPaperSize`, in
units of @unit.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter_description> a `GtkPaperSize` object
</parameter_description>
</parameter>
<parameter name="unit">
@@ -54363,7 +57719,7 @@ Returns %TRUE if @size is not a standard paper size.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter_description> a `GtkPaperSize` object
</parameter_description>
</parameter>
</parameters>
@@ -54373,17 +57729,17 @@ Returns %TRUE if @size is not a standard paper size.
<function name="gtk_paper_size_is_equal">
<description>
-Compares two #GtkPaperSize objects.
+Compares two `GtkPaperSize` objects.
</description>
<parameters>
<parameter name="size1">
-<parameter_description> a #GtkPaperSize object
+<parameter_description> a `GtkPaperSize` object
</parameter_description>
</parameter>
<parameter name="size2">
-<parameter_description> another #GtkPaperSize object
+<parameter_description> another `GtkPaperSize` object
</parameter_description>
</parameter>
</parameters>
@@ -54400,7 +57756,7 @@ Returns %TRUE if @size is an IPP standard paper size.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter_description> a `GtkPaperSize` object
</parameter_description>
</parameter>
</parameters>
@@ -54410,12 +57766,12 @@ Returns %TRUE if @size is an IPP standard paper size.
<function name="gtk_paper_size_new">
<description>
-Creates a new #GtkPaperSize object by parsing a
+Creates a new `GtkPaperSize` object by parsing a
[PWG 5101.1-2002](ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf)
paper name.
If @name is %NULL, the default paper size is returned,
-see gtk_paper_size_get_default().
+see [func@Gtk.PaperSize.get_default].
</description>
@@ -54425,14 +57781,14 @@ see gtk_paper_size_get_default().
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPaperSize, use gtk_paper_size_free()
+<return> a new `GtkPaperSize`, use [method Gtk PaperSize free]
to free it
</return>
</function>
<function name="gtk_paper_size_new_custom">
<description>
-Creates a new #GtkPaperSize object with the
+Creates a new `GtkPaperSize` object with the
given parameters.
@@ -54459,36 +57815,38 @@ given parameters.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPaperSize object, use gtk_paper_size_free()
+<return> a new `GtkPaperSize` object, use [method Gtk PaperSize free]
to free it
</return>
</function>
<function name="gtk_paper_size_new_from_gvariant">
<description>
-Deserialize a paper size from an a{sv} variant in
-the format produced by gtk_paper_size_to_gvariant().
+Deserialize a paper size from a `GVariant`.
+
+The `GVariant must be in the format produced by
+[method@Gtk.PaperSize.to_gvariant].
</description>
<parameters>
<parameter name="variant">
-<parameter_description> an a{sv} #GVariant
+<parameter_description> an a{sv} `GVariant`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPaperSize object
+<return> a new `GtkPaperSize` object
</return>
</function>
<function name="gtk_paper_size_new_from_ipp">
<description>
-Creates a new #GtkPaperSize object by using
+Creates a new `GtkPaperSize` object by using
IPP information.
If @ipp_name is not a recognized paper name,
@width and @height are used to
-construct a custom #GtkPaperSize object.
+construct a custom `GtkPaperSize` object.
</description>
@@ -54506,7 +57864,7 @@ construct a custom #GtkPaperSize object.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPaperSize, use gtk_paper_size_free()
+<return> a new `GtkPaperSize`, use [method Gtk PaperSize free]
to free it
</return>
</function>
@@ -54520,7 +57878,7 @@ Reads a paper size from the group @group_name in the key file
</description>
<parameters>
<parameter name="key_file">
-<parameter_description> the #GKeyFile to retrieve the papersize from
+<parameter_description> the `GKeyFile` to retrieve the papersize from
</parameter_description>
</parameter>
<parameter name="group_name">
@@ -54533,19 +57891,19 @@ or %NULL to read the first group
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPaperSize object with the restored
+<return> a new `GtkPaperSize` object with the restored
paper size, or %NULL if an error occurred
</return>
</function>
<function name="gtk_paper_size_new_from_ppd">
<description>
-Creates a new #GtkPaperSize object by using
+Creates a new `GtkPaperSize` object by using
PPD information.
If @ppd_name is not a recognized PPD paper name,
@ppd_display_name, @width and @height are used to
-construct a custom #GtkPaperSize object.
+construct a custom `GtkPaperSize` object.
</description>
@@ -54567,7 +57925,7 @@ construct a custom #GtkPaperSize object.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPaperSize, use gtk_paper_size_free()
+<return> a new `GtkPaperSize`, use [method Gtk PaperSize free]
to free it
</return>
</function>
@@ -54579,7 +57937,7 @@ Changes the dimensions of a @size to @width x @height.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a custom #GtkPaperSize object
+<parameter_description> a custom `GtkPaperSize` object
</parameter_description>
</parameter>
<parameter name="width">
@@ -54600,17 +57958,17 @@ Changes the dimensions of a @size to @width x @height.
<function name="gtk_paper_size_to_gvariant">
<description>
-Serialize a paper size to an a{sv} variant.
+Serialize a paper size to an `a{sv}` variant.
</description>
<parameters>
<parameter name="paper_size">
-<parameter_description> a #GtkPaperSize
+<parameter_description> a `GtkPaperSize`
</parameter_description>
</parameter>
</parameters>
-<return> a new, floating, #GVariant
+<return> a new, floating, `GVariant`
</return>
</function>
@@ -54621,11 +57979,11 @@ This function adds the paper size from @size to @key_file.
</description>
<parameters>
<parameter name="size">
-<parameter_description> a #GtkPaperSize
+<parameter_description> a `GtkPaperSize`
</parameter_description>
</parameter>
<parameter name="key_file">
-<parameter_description> the #GKeyFile to save the paper size to
+<parameter_description> the `GKeyFile` to save the paper size to
</parameter_description>
</parameter>
<parameter name="group_name">
@@ -54638,9 +57996,9 @@ This function adds the paper size from @size to @key_file.
<function name="gtk_param_spec_expression">
<description>
-Creates a new #GParamSpec instance for a property holding a #GtkExpression.
+Creates a new `GParamSpec` instance for a property holding a `GtkExpression`.
-See g_param_spec_internal() for details on the property strings.
+See `g_param_spec_internal()` for details on the property strings.
</description>
@@ -54674,7 +58032,7 @@ Gets the menu model set with gtk_password_entry_set_extra_menu().
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkPasswordEntry`
</parameter_description>
</parameter>
</parameters>
@@ -54684,14 +58042,14 @@ Gets the menu model set with gtk_password_entry_set_extra_menu().
<function name="gtk_password_entry_get_show_peek_icon">
<description>
-Returns whether the entry is showing a clickable icon
-to reveal the contents of the entry in clear text.
+Returns whether the entry is showing an icon to
+reveal the contents.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkPasswordEntry
+<parameter_description> a `GtkPasswordEntry`
</parameter_description>
</parameter>
</parameters>
@@ -54701,13 +58059,13 @@ to reveal the contents of the entry in clear text.
<function name="gtk_password_entry_new">
<description>
-Creates a #GtkPasswordEntry.
+Creates a `GtkPasswordEntry`.
</description>
<parameters>
</parameters>
-<return> a new #GtkPasswordEntry
+<return> a new `GtkPasswordEntry`
</return>
</function>
@@ -54719,11 +58077,11 @@ the context menu for @entry.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkPasswordEntry
+<parameter_description> a `GtkPasswordEntry`
</parameter_description>
</parameter>
<parameter name="model">
-<parameter_description> a #GMenuModel
+<parameter_description> a `GMenuModel`
</parameter_description>
</parameter>
</parameters>
@@ -54733,14 +58091,14 @@ the context menu for @entry.
<function name="gtk_password_entry_set_show_peek_icon">
<description>
Sets whether the entry should have a clickable icon
-to show the contents of the entry in clear text.
+to reveal the contents.
Setting this to %FALSE also hides the text again.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkPasswordEntry
+<parameter_description> a `GtkPasswordEntry`
</parameter_description>
</parameter>
<parameter name="show_peek_icon">
@@ -54753,31 +58111,31 @@ Setting this to %FALSE also hides the text again.
<function name="gtk_picture_get_alternative_text">
<description>
-Gets the alternative textual description of the picture or returns %NULL if
-the picture cannot be described textually.
+Gets the alternative textual description of the picture.
+
+The returned string will be %NULL if the picture cannot be described textually.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkPicture
+<parameter_description> a `GtkPicture`
</parameter_description>
</parameter>
</parameters>
-<return> the alternative textual description
-of @self.
+<return> the alternative textual description of @self.
</return>
</function>
<function name="gtk_picture_get_can_shrink">
<description>
-Gets the value set via gtk_picture_set_can_shrink().
+Returns whether the `GtkPicture` respects its contents size.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkPicture
+<parameter_description> a `GtkPicture`
</parameter_description>
</parameter>
</parameters>
@@ -54787,31 +58145,32 @@ Gets the value set via gtk_picture_set_can_shrink().
<function name="gtk_picture_get_file">
<description>
-Gets the #GFile currently displayed if @self is displaying a file.
-If @self is not displaying a file, for example when gtk_picture_set_paintable()
-was used, then %NULL is returned.
+Gets the `GFile` currently displayed if @self is displaying a file.
+
+If @self is not displaying a file, for example when
+[method@Gtk.Picture.set_paintable] was used, then %NULL is returned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkPicture
+<parameter_description> a `GtkPicture`
</parameter_description>
</parameter>
</parameters>
-<return> The #GFile displayed by @self.
+<return> The `GFile` displayed by @self.
</return>
</function>
<function name="gtk_picture_get_keep_aspect_ratio">
<description>
-Gets the value set via gtk_picture_set_keep_aspect_ratio().
+Returns whether the `GtkPicture` preserves its contents aspect ratio.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkPicture
+<parameter_description> a `GtkPicture`
</parameter_description>
</parameter>
</parameters>
@@ -54821,13 +58180,13 @@ Gets the value set via gtk_picture_set_keep_aspect_ratio().
<function name="gtk_picture_get_paintable">
<description>
-Gets the #GdkPaintable being displayed by the #GtkPicture.
+Gets the `GdkPaintable` being displayed by the `GtkPicture`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkPicture
+<parameter_description> a `GtkPicture`
</parameter_description>
</parameter>
</parameters>
@@ -54838,42 +58197,44 @@ the picture is empty
<function name="gtk_picture_new">
<description>
-Creates a new empty #GtkPicture widget.
+Creates a new empty `GtkPicture` widget.
</description>
<parameters>
</parameters>
-<return> a newly created #GtkPicture widget.
+<return> a newly created `GtkPicture` widget.
</return>
</function>
<function name="gtk_picture_new_for_file">
<description>
-Creates a new #GtkPicture displaying the given @file. If the file
-isn’t found or can’t be loaded, the resulting #GtkPicture be empty.
+Creates a new `GtkPicture` displaying the given @file.
+
+If the file isn’t found or can’t be loaded, the resulting
+`GtkPicture` is empty.
If you need to detect failures to load the file, use
-gdk_texture_new_from_file() to load the file yourself, then create
-the #GtkPicture from the texture.
+[ctor@Gdk.Texture.new_from_file] to load the file yourself,
+then create the `GtkPicture` from the texture.
</description>
<parameters>
<parameter name="file">
-<parameter_description> a #GFile
+<parameter_description> a `GFile`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPicture
+<return> a new `GtkPicture`
</return>
</function>
<function name="gtk_picture_new_for_filename">
<description>
-Creates a new #GtkPicture displaying the file @filename.
+Creates a new `GtkPicture` displaying the file @filename.
-This is a utility function that calls gtk_picture_new_for_file().
+This is a utility function that calls [ctor@Gtk.Picture.new_for_file].
See that function for details.
@@ -54884,34 +58245,34 @@ See that function for details.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPicture
+<return> a new `GtkPicture`
</return>
</function>
<function name="gtk_picture_new_for_paintable">
<description>
-Creates a new #GtkPicture displaying @paintable.
+Creates a new `GtkPicture` displaying @paintable.
-The #GtkPicture will track changes to the @paintable and update
+The `GtkPicture` will track changes to the @paintable and update
its size and contents in response to it.
</description>
<parameters>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable, or %NULL
+<parameter_description> a `GdkPaintable`, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPicture
+<return> a new `GtkPicture`
</return>
</function>
<function name="gtk_picture_new_for_pixbuf">
<description>
-Creates a new #GtkPicture displaying @pixbuf.
+Creates a new `GtkPicture` displaying @pixbuf.
-This is a utility function that calls gtk_picture_new_for_paintable(),
+This is a utility function that calls [ctor@Gtk.Picture.new_for_paintable],
See that function for details.
The pixbuf must not be modified after passing it to this function.
@@ -54920,19 +58281,19 @@ The pixbuf must not be modified after passing it to this function.
</description>
<parameters>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf, or %NULL
+<parameter_description> a `GdkPixbuf`, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPicture
+<return> a new `GtkPicture`
</return>
</function>
<function name="gtk_picture_new_for_resource">
<description>
-Creates a new #GtkPicture displaying the file @filename.
+Creates a new `GtkPicture` displaying the resource at @resource_path.
-This is a utility function that calls gtk_picture_new_for_file().
+This is a utility function that calls [ctor@Gtk.Picture.new_for_file].
See that function for details.
@@ -54943,13 +58304,14 @@ See that function for details.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPicture
+<return> a new `GtkPicture`
</return>
</function>
<function name="gtk_picture_set_alternative_text">
<description>
Sets an alternative textual description for the picture contents.
+
It is equivalent to the "alt" attribute for images on websites.
This text will be made available to accessibility tools.
@@ -54959,7 +58321,7 @@ If the picture cannot be described textually, set this property to %NULL.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkPicture
+<parameter_description> a `GtkPicture`
</parameter_description>
</parameter>
<parameter name="alternative_text">
@@ -54973,19 +58335,20 @@ If the picture cannot be described textually, set this property to %NULL.
<function name="gtk_picture_set_can_shrink">
<description>
If set to %TRUE, the @self can be made smaller than its contents.
+
The contents will then be scaled down when rendering.
If you want to still force a minimum size manually, consider using
-gtk_widget_set_size_request().
+[method@Gtk.Widget.set_size_request].
Also of note is that a similar function for growing does not exist
because the grow behavior can be controlled via
-gtk_widget_set_halign() and gtk_widget_set_valign().
+[method@Gtk.Widget.set_halign] and [method@Gtk.Widget.set_valign].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkPicture
+<parameter_description> a `GtkPicture`
</parameter_description>
</parameter>
<parameter name="can_shrink">
@@ -55000,16 +58363,16 @@ gtk_widget_set_halign() and gtk_widget_set_valign().
<description>
Makes @self load and display @file.
-See gtk_picture_new_for_file() for details.
+See [ctor@Gtk.Picture.new_for_file] for details.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkPicture
+<parameter_description> a `GtkPicture`
</parameter_description>
</parameter>
<parameter name="file">
-<parameter_description> a %GFile or %NULL
+<parameter_description> a `GFile` or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -55020,12 +58383,12 @@ See gtk_picture_new_for_file() for details.
<description>
Makes @self load and display the given @filename.
-This is a utility function that calls gtk_picture_set_file().
+This is a utility function that calls [method@Gtk.Picture.set_file].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkPicture
+<parameter_description> a `GtkPicture`
</parameter_description>
</parameter>
<parameter name="filename">
@@ -55039,16 +58402,18 @@ This is a utility function that calls gtk_picture_set_file().
<function name="gtk_picture_set_keep_aspect_ratio">
<description>
If set to %TRUE, the @self will render its contents according to
-their aspect ratio. That means that empty space may show up at the
-top/bottom or left/right of @self.
+their aspect ratio.
-If set to %FALSE or if the contents provide no aspect ratio, the
-contents will be stretched over the picture's whole area.
+That means that empty space may show up at the top/bottom or
+left/right of @self.
+
+If set to %FALSE or if the contents provide no aspect ratio,
+the contents will be stretched over the picture's whole area.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkPicture
+<parameter_description> a `GtkPicture`
</parameter_description>
</parameter>
<parameter name="keep_aspect_ratio">
@@ -55061,19 +58426,20 @@ contents will be stretched over the picture's whole area.
<function name="gtk_picture_set_paintable">
<description>
-Makes @self display the given @paintable. If @paintable is %NULL,
-nothing will be displayed.
+Makes @self display the given @paintable.
+
+If @paintable is %NULL, nothing will be displayed.
-See gtk_picture_new_for_paintable() for details.
+See [ctor@Gtk.Picture.new_for_paintable] for details.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkPicture
+<parameter_description> a `GtkPicture`
</parameter_description>
</parameter>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable or %NULL
+<parameter_description> a `GdkPaintable` or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -55082,18 +58448,20 @@ See gtk_picture_new_for_paintable() for details.
<function name="gtk_picture_set_pixbuf">
<description>
-See gtk_picture_new_for_pixbuf() for details.
+Sets a `GtkPicture` to show a `GdkPixbuf`.
-This is a utility function that calls gtk_picture_set_paintable(),
+See [ctor@Gtk.Picture.new_for_pixbuf] for details.
+
+This is a utility function that calls [method@Gtk.Picture.set_paintable].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkPicture
+<parameter_description> a `GtkPicture`
</parameter_description>
</parameter>
<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf or %NULL
+<parameter_description> a `GdkPixbuf` or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -55105,12 +58473,12 @@ This is a utility function that calls gtk_picture_set_paintable(),
Makes @self load and display the resource at the given
@resource_path.
-This is a utility function that calls gtk_picture_set_file(),
+This is a utility function that calls [method@Gtk.Picture.set_file].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkPicture
+<parameter_description> a `GtkPicture`
</parameter_description>
</parameter>
<parameter name="resource_path">
@@ -55125,18 +58493,18 @@ This is a utility function that calls gtk_picture_set_file(),
<description>
Returns whether the popover is modal.
-See gtk_popover_set_autohide() for the
+See [method@Gtk.Popover.set_autohide] for the
implications of this.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
</parameters>
-<return> #TRUE if @popover is modal
+<return> %TRUE if @popover is modal
</return>
</function>
@@ -55148,11 +58516,11 @@ Returns whether the popover will close after a modal child is closed.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
</parameters>
-<return> #TRUE if @popover will close after a modal child.
+<return> %TRUE if @popover will close after a modal child.
</return>
</function>
@@ -55164,7 +58532,7 @@ Gets the child widget of @popover.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
</parameters>
@@ -55181,7 +58549,7 @@ pointing at the widget that it is relative to.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
</parameters>
@@ -55191,17 +58559,18 @@ pointing at the widget that it is relative to.
<function name="gtk_popover_get_mnemonics_visible">
<description>
-Gets the value of the #GtkPopover:mnemonics-visible property.
+Gets whether mnemonics are visible.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if mnemonics are supposed to be visible in this popover
+<return> %TRUE if mnemonics are supposed to be visible
+in this popover
</return>
</function>
@@ -55212,7 +58581,7 @@ Gets the offset previous set with gtk_popover_set_offset().
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
<parameter name="x_offset">
@@ -55229,16 +58598,18 @@ Gets the offset previous set with gtk_popover_set_offset().
<function name="gtk_popover_get_pointing_to">
<description>
+Gets the rectangle that the popover points to.
+
If a rectangle to point to has been set, this function will
return %TRUE and fill in @rect with such rectangle, otherwise
-it will return %FALSE and fill in @rect with the attached
+it will return %FALSE and fill in @rect with the parent
widget coordinates.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
<parameter name="rect">
@@ -55258,7 +58629,7 @@ Returns the preferred position of @popover.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
</parameters>
@@ -55270,18 +58641,18 @@ Returns the preferred position of @popover.
<description>
Adds a custom widget to a generated menu.
-For this to work, the menu model of @popover must have an
-item with a `custom` attribute that matches @id.
+For this to work, the menu model of @popover must have
+an item with a `custom` attribute that matches @id.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopoverMenu
+<parameter_description> a `GtkPopoverMenu`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to add
+<parameter_description> the `GtkWidget` to add
</parameter_description>
</parameter>
<parameter name="id">
@@ -55304,11 +58675,11 @@ item with a `custom` attribute that matches @id.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkPopoverMenuBar
+<parameter_description> a `GtkPopoverMenuBar`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to add
+<parameter_description> the `GtkWidget` to add
</parameter_description>
</parameter>
<parameter name="id">
@@ -55328,27 +58699,27 @@ Returns the model from which the contents of @bar are taken.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkPopoverMenuBar
+<parameter_description> a `GtkPopoverMenuBar`
</parameter_description>
</parameter>
</parameters>
-<return> a #GMenuModel
+<return> a `GMenuModel`
</return>
</function>
<function name="gtk_popover_menu_bar_new_from_model">
<description>
-Creates a #GtkPopoverMenuBar from a #GMenuModel.
+Creates a `GtkPopoverMenuBar` from a `GMenuModel`.
</description>
<parameters>
<parameter name="model">
-<parameter_description> a #GMenuModel, or %NULL
+<parameter_description> a `GMenuModel`, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPopoverMenuBar
+<return> a new `GtkPopoverMenuBar`
</return>
</function>
@@ -55361,7 +58732,7 @@ gtk_popover_menu_bar_add_child().
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkPopoverMenuBar
+<parameter_description> a `GtkPopoverMenuBar`
</parameter_description>
</parameter>
<parameter name="child">
@@ -55381,11 +58752,11 @@ its contents.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkPopoverMenuBar
+<parameter_description> a `GtkPopoverMenuBar`
</parameter_description>
</parameter>
<parameter name="model">
-<parameter_description> a #GMenuModel, or %NULL
+<parameter_description> a `GMenuModel`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -55400,7 +58771,7 @@ Returns the menu model used to populate the popover.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopoverMenu
+<parameter_description> a `GtkPopoverMenu`
</parameter_description>
</parameter>
</parameters>
@@ -55416,59 +58787,57 @@ Creates a new popover menu.
</description>
<parameters>
</parameters>
-<return> a new #GtkPopoverMenu
+<return> a new `GtkPopoverMenu`
</return>
</function>
<function name="gtk_popover_menu_new_from_model">
<description>
-Creates a #GtkPopoverMenu and populates it according to
-@model.
+Creates a `GtkPopoverMenu` and populates it according to @model.
The created buttons are connected to actions found in the
-#GtkApplicationWindow to which the popover belongs - typically
+`GtkApplicationWindow` to which the popover belongs - typically
by means of being attached to a widget that is contained within
-the #GtkApplicationWindows widget hierarchy.
+the `GtkApplicationWindow`s widget hierarchy.
-Actions can also be added using gtk_widget_insert_action_group()
+Actions can also be added using [method@Gtk.Widget.insert_action_group]
on the menus attach widget or on any of its parent widgets.
This function creates menus with sliding submenus.
-See gtk_popover_menu_new_from_model_full() for a way
+See [ctor@Gtk.PopoverMenu.new_from_model_full] for a way
to control this.
</description>
<parameters>
<parameter name="model">
-<parameter_description> a #GMenuModel, or %NULL
+<parameter_description> a `GMenuModel`, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkPopoverMenu
+<return> the new `GtkPopoverMenu`
</return>
</function>
<function name="gtk_popover_menu_new_from_model_full">
<description>
-Creates a #GtkPopoverMenu and populates it according to
-@model.
+Creates a `GtkPopoverMenu` and populates it according to @model.
The created buttons are connected to actions found in the
action groups that are accessible from the parent widget.
-This includes the #GtkApplicationWindow to which the popover
-belongs. Actions can also be added using gtk_widget_insert_action_group()
+This includes the `GtkApplicationWindow` to which the popover
+belongs. Actions can also be added using [method@Gtk.Widget.insert_action_group]
on the parent widget or on any of its parent widgets.
The only flag that is supported currently is
-#GTK_POPOVER_MENU_NESTED, which makes GTK create traditional,
+%GTK_POPOVER_MENU_NESTED, which makes GTK create traditional,
nested submenus instead of the default sliding submenus.
</description>
<parameters>
<parameter name="model">
-<parameter_description> a #GMenuModel
+<parameter_description> a `GMenuModel`
</parameter_description>
</parameter>
<parameter name="flags">
@@ -55476,7 +58845,7 @@ nested submenus instead of the default sliding submenus.
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkPopoverMenu
+<return> the new `GtkPopoverMenu`
</return>
</function>
@@ -55489,11 +58858,11 @@ gtk_popover_menu_add_child().
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopoverMenu
+<parameter_description> a `GtkPopoverMenu`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to remove
+<parameter_description> the `GtkWidget` to remove
</parameter_description>
</parameter>
</parameters>
@@ -55512,11 +58881,11 @@ to @model.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopoverMenu
+<parameter_description> a `GtkPopoverMenu`
</parameter_description>
</parameter>
<parameter name="model">
-<parameter_description> a #GMenuModel, or %NULL
+<parameter_description> a `GMenuModel`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -55525,26 +58894,29 @@ to @model.
<function name="gtk_popover_new">
<description>
-Creates a new popover.
+Creates a new `GtkPopover`.
</description>
<parameters>
</parameters>
-<return> the new popover
+<return> the new `GtkPopover`
</return>
</function>
<function name="gtk_popover_popdown">
<description>
-Pops @popover down.This is different than a gtk_widget_hide() call
-in that it shows the popover with a transition. If you want to hide
-the popover without a transition, use gtk_widget_hide().
+Pops @popover down.
+
+This is different from a [method Gtk Widget hide] call
+in that it may show the popover with a transition. If
+you want to hide the popover without a transition, just
+use [method Gtk Widget hide].
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
</parameters>
@@ -55553,14 +58925,17 @@ the popover without a transition, use gtk_widget_hide().
<function name="gtk_popover_popup">
<description>
-Pops @popover up. This is different than a gtk_widget_show() call
-in that it shows the popover with a transition. If you want to show
-the popover without a transition, use gtk_widget_show().
+Pops @popover up.
+
+This is different from a [method Gtk Widget show() call
+in that it may show the popover with a transition. If
+you want to show the popover without a transition, just
+use [method Gtk Widget show].
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
</parameters>
@@ -55574,7 +58949,7 @@ Presents the popover to the user.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
</parameters>
@@ -55586,20 +58961,21 @@ Presents the popover to the user.
Sets whether @popover is modal.
A modal popover will grab the keyboard focus on it when being
-displayed. Clicking outside the popover area or pressing Esc will
-dismiss the popover.
+displayed. Clicking outside the popover area or pressing Esc
+will dismiss the popover.
-Called this function on an already showing popup with a new autohide value
-different from the current one, will cause the popup to be hidden.
+Called this function on an already showing popup with a new
+autohide value different from the current one, will cause the
+popup to be hidden.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
<parameter name="autohide">
-<parameter_description> #TRUE to dismiss the popover on outside clicks
+<parameter_description> %TRUE to dismiss the popover on outside clicks
</parameter_description>
</parameter>
</parameters>
@@ -55608,17 +58984,19 @@ different from the current one, will cause the popup to be hidden.
<function name="gtk_popover_set_cascade_popdown">
<description>
-If @cascade_popdown is #TRUE, the popover will be closed when a child
-modal popover is closed. If #FALSE, @popover will stay visible.
+If @cascade_popdown is %TRUE, the popover will be
+closed when a child modal popover is closed.
+
+If %FALSE, @popover will stay visible.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> A #GtkPopover
+<parameter_description> A `GtkPopover`
</parameter_description>
</parameter>
<parameter name="cascade_popdown">
-<parameter_description> #TRUE if the popover should follow a child closing
+<parameter_description> %TRUE if the popover should follow a child closing
</parameter_description>
</parameter>
</parameters>
@@ -55632,7 +59010,7 @@ Sets the child widget of @popover.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
<parameter name="child">
@@ -55645,14 +59023,16 @@ Sets the child widget of @popover.
<function name="gtk_popover_set_default_widget">
<description>
+Sets the default widget of a `GtkPopover`.
+
The default widget is the widget that’s activated when the user
presses Enter in a dialog (for example). This function sets or
-unsets the default widget for a #GtkPopover.
+unsets the default widget for a `GtkPopover`.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
<parameter name="widget">
@@ -55672,7 +59052,7 @@ pointing at the widget it is relative to.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
<parameter name="has_arrow">
@@ -55685,12 +59065,12 @@ pointing at the widget it is relative to.
<function name="gtk_popover_set_mnemonics_visible">
<description>
-Sets the #GtkPopover:mnemonics-visible property.
+Sets whether mnemonics should be visible.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
<parameter name="mnemonics_visible">
@@ -55703,15 +59083,16 @@ Sets the #GtkPopover:mnemonics-visible property.
<function name="gtk_popover_set_offset">
<description>
-Sets the offset to use when calculating the position of the popover.
+Sets the offset to use when calculating the position
+of the popover.
-These values are used when preparing the #GtkPopupLayout for positioning
-the popover.
+These values are used when preparing the [struct@Gdk.PopupLayout]
+for positioning the popover.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
<parameter name="x_offset">
@@ -55728,13 +59109,14 @@ the popover.
<function name="gtk_popover_set_pointing_to">
<description>
-Sets the rectangle that @popover will point to, in the
-coordinate space of the @popover parent.
+Sets the rectangle that @popover points to.
+
+This is in the coordinate space of the @popover parent.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
<parameter name="rect">
@@ -55747,17 +59129,19 @@ coordinate space of the @popover parent.
<function name="gtk_popover_set_position">
<description>
-Sets the preferred position for @popover to appear. If the @popover
-is currently visible, it will be immediately updated.
+Sets the preferred position for @popover to appear.
+
+If the @popover is currently visible, it will be immediately
+updated.
This preference will be respected where possible, although
on lack of space (eg. if close to the window edges), the
-#GtkPopover may choose to appear on the opposite side
+`GtkPopover` may choose to appear on the opposite side.
</description>
<parameters>
<parameter name="popover">
-<parameter_description> a #GtkPopover
+<parameter_description> a `GtkPopover`
</parameter_description>
</parameter>
<parameter name="position">
@@ -55794,14 +59178,14 @@ with g_list_free().
<function name="gtk_print_context_create_pango_context">
<description>
-Creates a new #PangoContext that can be used with the
-#GtkPrintContext.
+Creates a new `PangoContext` that can be used with the
+`GtkPrintContext`.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter_description> a `GtkPrintContext`
</parameter_description>
</parameter>
</parameters>
@@ -55811,14 +59195,14 @@ Creates a new #PangoContext that can be used with the
<function name="gtk_print_context_create_pango_layout">
<description>
-Creates a new #PangoLayout that is suitable for use
-with the #GtkPrintContext.
+Creates a new `PangoLayout` that is suitable for use
+with the `GtkPrintContext`.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter_description> a `GtkPrintContext`
</parameter_description>
</parameter>
</parameters>
@@ -55829,13 +59213,13 @@ with the #GtkPrintContext.
<function name="gtk_print_context_get_cairo_context">
<description>
Obtains the cairo context that is associated with the
-#GtkPrintContext.
+`GtkPrintContext`.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter_description> a `GtkPrintContext`
</parameter_description>
</parameter>
</parameters>
@@ -55845,14 +59229,14 @@ Obtains the cairo context that is associated with the
<function name="gtk_print_context_get_dpi_x">
<description>
-Obtains the horizontal resolution of the #GtkPrintContext,
+Obtains the horizontal resolution of the `GtkPrintContext`,
in dots per inch.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter_description> a `GtkPrintContext`
</parameter_description>
</parameter>
</parameters>
@@ -55862,14 +59246,14 @@ in dots per inch.
<function name="gtk_print_context_get_dpi_y">
<description>
-Obtains the vertical resolution of the #GtkPrintContext,
+Obtains the vertical resolution of the `GtkPrintContext`,
in dots per inch.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter_description> a `GtkPrintContext`
</parameter_description>
</parameter>
</parameters>
@@ -55879,13 +59263,14 @@ in dots per inch.
<function name="gtk_print_context_get_hard_margins">
<description>
-Obtains the hardware printer margins of the #GtkPrintContext, in units.
+Obtains the hardware printer margins of the `GtkPrintContext`,
+in units.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter_description> a `GtkPrintContext`
</parameter_description>
</parameter>
<parameter name="top">
@@ -55911,13 +59296,13 @@ Obtains the hardware printer margins of the #GtkPrintContext, in units.
<function name="gtk_print_context_get_height">
<description>
-Obtains the height of the #GtkPrintContext, in pixels.
+Obtains the height of the `GtkPrintContext`, in pixels.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter_description> a `GtkPrintContext`
</parameter_description>
</parameter>
</parameters>
@@ -55927,14 +59312,14 @@ Obtains the height of the #GtkPrintContext, in pixels.
<function name="gtk_print_context_get_page_setup">
<description>
-Obtains the #GtkPageSetup that determines the page
-dimensions of the #GtkPrintContext.
+Obtains the `GtkPageSetup` that determines the page
+dimensions of the `GtkPrintContext`.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter_description> a `GtkPrintContext`
</parameter_description>
</parameter>
</parameters>
@@ -55944,14 +59329,14 @@ dimensions of the #GtkPrintContext.
<function name="gtk_print_context_get_pango_fontmap">
<description>
-Returns a #PangoFontMap that is suitable for use
-with the #GtkPrintContext.
+Returns a `PangoFontMap` that is suitable for use
+with the `GtkPrintContext`.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter_description> a `GtkPrintContext`
</parameter_description>
</parameter>
</parameters>
@@ -55961,13 +59346,13 @@ with the #GtkPrintContext.
<function name="gtk_print_context_get_width">
<description>
-Obtains the width of the #GtkPrintContext, in pixels.
+Obtains the width of the `GtkPrintContext`, in pixels.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter_description> a `GtkPrintContext`
</parameter_description>
</parameter>
</parameters>
@@ -55977,7 +59362,7 @@ Obtains the width of the #GtkPrintContext, in pixels.
<function name="gtk_print_context_set_cairo_context">
<description>
-Sets a new cairo context on a print context.
+Sets a new cairo context on a print context.
This function is intended to be used when implementing
an internal print preview, it is not needed for printing,
@@ -55987,7 +59372,7 @@ case.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter_description> a `GtkPrintContext`
</parameter_description>
</parameter>
<parameter name="cr">
@@ -56008,12 +59393,12 @@ case.
<function name="gtk_print_context_set_hard_margins">
<description>
-set the hard margins in pixel coordinates
+Sets the hard margins in pixels.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter_description> a `GtkPrintContext`
</parameter_description>
</parameter>
<parameter name="top">
@@ -56038,13 +59423,13 @@ set the hard margins in pixel coordinates
<function name="gtk_print_error_quark">
<description>
-Registers an error quark for #GtkPrintOperation if necessary.
+Registers an error quark for `GtkPrintOperation` if necessary.
</description>
<parameters>
</parameters>
-<return> The error quark used for #GtkPrintOperation errors.
+<return> The error quark used for `GtkPrintOperation` errors.
</return>
</function>
@@ -56056,7 +59441,7 @@ Gets whether this job is printed collated.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
</parameters>
@@ -56072,7 +59457,7 @@ Gets the n-up setting for this job.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
</parameters>
@@ -56088,7 +59473,7 @@ Gets the n-up layout setting for this job.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
</parameters>
@@ -56104,7 +59489,7 @@ Gets the number of copies of this job.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
</parameters>
@@ -56120,7 +59505,7 @@ Gets the page ranges for this job.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
<parameter name="n_ranges">
@@ -56129,51 +59514,51 @@ Gets the page ranges for this job.
</parameter>
</parameters>
<return> a pointer to an
-array of #GtkPageRange structs
+array of `GtkPageRange` structs
</return>
</function>
<function name="gtk_print_job_get_page_set">
<description>
-Gets the #GtkPageSet setting for this job.
+Gets the `GtkPageSet` setting for this job.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkPageSet setting
+<return> the `GtkPageSet` setting
</return>
</function>
<function name="gtk_print_job_get_pages">
<description>
-Gets the #GtkPrintPages setting for this job.
+Gets the `GtkPrintPages` setting for this job.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkPrintPages setting
+<return> the `GtkPrintPages` setting
</return>
</function>
<function name="gtk_print_job_get_printer">
<description>
-Gets the #GtkPrinter of the print job.
+Gets the `GtkPrinter` of the print job.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
</parameters>
@@ -56189,7 +59574,7 @@ Gets whether this job is printed reversed.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
</parameters>
@@ -56205,7 +59590,7 @@ Gets whether the job is printed rotated.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
</parameters>
@@ -56215,13 +59600,13 @@ Gets whether the job is printed rotated.
<function name="gtk_print_job_get_scale">
<description>
-Gets the scale for this job (where 1.0 means unscaled).
+Gets the scale for this job.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
</parameters>
@@ -56231,13 +59616,13 @@ Gets the scale for this job (where 1.0 means unscaled).
<function name="gtk_print_job_get_settings">
<description>
-Gets the #GtkPrintSettings of the print job.
+Gets the `GtkPrintSettings` of the print job.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
</parameters>
@@ -56253,7 +59638,7 @@ Gets the status of the print job.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
</parameters>
@@ -56270,7 +59655,7 @@ the print job should be rendered.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
<parameter name="error">
@@ -56290,7 +59675,7 @@ Gets the job title.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
</parameters>
@@ -56301,13 +59686,14 @@ Gets the job title.
<function name="gtk_print_job_get_track_print_status">
<description>
Returns whether jobs will be tracked after printing.
-For details, see gtk_print_job_set_track_print_status().
+
+For details, see [method@Gtk.PrintJob.set_track_print_status].
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
</parameters>
@@ -56317,7 +59703,7 @@ For details, see gtk_print_job_set_track_print_status().
<function name="gtk_print_job_new">
<description>
-Creates a new #GtkPrintJob.
+Creates a new `GtkPrintJob`.
</description>
@@ -56327,30 +59713,30 @@ Creates a new #GtkPrintJob.
</parameter_description>
</parameter>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="page_setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPrintJob
+<return> a new `GtkPrintJob`
</return>
</function>
<function name="gtk_print_job_send">
<description>
-Sends the print job off to the printer.
+Sends the print job off to the printer.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
<parameter name="callback">
@@ -56376,7 +59762,7 @@ Sets whether this job is printed collated.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
<parameter name="collate">
@@ -56394,7 +59780,7 @@ Sets the n-up setting for this job.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
<parameter name="n_up">
@@ -56412,7 +59798,7 @@ Sets the n-up layout setting for this job.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
<parameter name="layout">
@@ -56430,7 +59816,7 @@ Sets the number of copies for this job.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
<parameter name="num_copies">
@@ -56448,12 +59834,12 @@ Sets the page ranges for this job.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
<parameter name="ranges">
<parameter_description> pointer to an array of
-#GtkPageRange structs
+`GtkPageRange` structs
</parameter_description>
</parameter>
<parameter name="n_ranges">
@@ -56466,16 +59852,16 @@ Sets the page ranges for this job.
<function name="gtk_print_job_set_page_set">
<description>
-Sets the #GtkPageSet setting for this job.
+Sets the `GtkPageSet` setting for this job.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
<parameter name="page_set">
-<parameter_description> a #GtkPageSet setting
+<parameter_description> a `GtkPageSet` setting
</parameter_description>
</parameter>
</parameters>
@@ -56484,16 +59870,16 @@ Sets the #GtkPageSet setting for this job.
<function name="gtk_print_job_set_pages">
<description>
-Sets the #GtkPrintPages setting for this job.
+Sets the `GtkPrintPages` setting for this job.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
<parameter name="pages">
-<parameter_description> the #GtkPrintPages setting
+<parameter_description> the `GtkPrintPages` setting
</parameter_description>
</parameter>
</parameters>
@@ -56507,7 +59893,7 @@ Sets whether this job is printed reversed.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
<parameter name="reverse">
@@ -56525,7 +59911,7 @@ Sets whether this job is printed rotated.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
<parameter name="rotate">
@@ -56538,12 +59924,14 @@ Sets whether this job is printed rotated.
<function name="gtk_print_job_set_scale">
<description>
-Sets the scale for this job (where 1.0 means unscaled).
+Sets the scale for this job.
+
+1.0 means unscaled.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
<parameter name="scale">
@@ -56556,13 +59944,15 @@ Sets the scale for this job (where 1.0 means unscaled).
<function name="gtk_print_job_set_source_fd">
<description>
-Make the #GtkPrintJob send an existing document to the
-printing system. The file can be in any format understood
-by the platforms printing system (typically PostScript,
-but on many platforms PDF may work too). See
-gtk_printer_accepts_pdf() and gtk_printer_accepts_ps().
+Make the `GtkPrintJob` send an existing document to the
+printing system.
+
+The file can be in any format understood by the platforms
+printing system (typically PostScript, but on many platforms
+PDF may work too). See [method@Gtk.Printer.accepts_pdf] and
+[method@Gtk.Printer.accepts_ps].
-This is similar to gtk_print_job_set_source_file(),
+This is similar to [method@Gtk.PrintJob.set_source_file],
but takes expects an open file descriptor for the file,
instead of a filename.
@@ -56570,7 +59960,7 @@ instead of a filename.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
<parameter name="fd">
@@ -56588,17 +59978,19 @@ instead of a filename.
<function name="gtk_print_job_set_source_file">
<description>
-Make the #GtkPrintJob send an existing document to the
-printing system. The file can be in any format understood
-by the platforms printing system (typically PostScript,
-but on many platforms PDF may work too). See
-gtk_printer_accepts_pdf() and gtk_printer_accepts_ps().
+Make the `GtkPrintJob` send an existing document to the
+printing system.
+
+The file can be in any format understood by the platforms
+printing system (typically PostScript, but on many platforms
+PDF may work too). See [method@Gtk.Printer.accepts_pdf] and
+[method@Gtk.Printer.accepts_ps].
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
<parameter name="filename">
@@ -56617,17 +60009,18 @@ gtk_printer_accepts_pdf() and gtk_printer_accepts_ps().
<function name="gtk_print_job_set_track_print_status">
<description>
If track_status is %TRUE, the print job will try to continue report
-on the status of the print job in the printer queues and printer. This
-can allow your application to show things like “out of paper” issues,
-and when the print job actually reaches the printer.
+on the status of the print job in the printer queues and printer.
-This function is often implemented using some form of polling, so it should
-not be enabled unless needed.
+This can allow your application to show things like “out of paper”
+issues, and when the print job actually reaches the printer.
+
+This function is often implemented using some form of polling,
+so it should not be enabled unless needed.
</description>
<parameters>
<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter_description> a `GtkPrintJob`
</parameter_description>
</parameter>
<parameter name="track_status">
@@ -56640,16 +60033,16 @@ not be enabled unless needed.
<function name="gtk_print_operation_cancel">
<description>
-Cancels a running print operation. This function may
-be called from a #GtkPrintOperation::begin-print,
-#GtkPrintOperation::paginate or #GtkPrintOperation::draw-page
-signal handler to stop the currently running print
-operation.
+Cancels a running print operation.
+
+This function may be called from a [signal@Gtk.PrintOperation::begin-print],
+[signal@Gtk.PrintOperation::paginate] or [signal@Gtk.PrintOperation::draw-page]
+signal handler to stop the currently running print operation.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
</parameters>
@@ -56658,18 +60051,17 @@ operation.
<function name="gtk_print_operation_draw_page_finish">
<description>
-Signalize that drawing of particular page is complete.
+Signal that drawing of particular page is complete.
-It is called after completion of page drawing (e.g. drawing in another
-thread).
-If gtk_print_operation_set_defer_drawing() was called before, then this function
-has to be called by application. In another case it is called by the library
-itself.
+It is called after completion of page drawing (e.g. drawing
+in another thread). If [method@Gtk.PrintOperation.set_defer_drawing]
+was called before, then this function has to be called by application.
+Otherwise it is called by GTK itself.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
</parameters>
@@ -56678,14 +60070,13 @@ itself.
<function name="gtk_print_operation_get_default_page_setup">
<description>
-Returns the default page setup, see
-gtk_print_operation_set_default_page_setup().
+Returns the default page setup.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
</parameters>
@@ -56695,13 +60086,13 @@ gtk_print_operation_set_default_page_setup().
<function name="gtk_print_operation_get_embed_page_setup">
<description>
-Gets the value of #GtkPrintOperation:embed-page-setup property.
+Gets whether page setup selection combos are embedded
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
</parameters>
@@ -56712,14 +60103,18 @@ Gets the value of #GtkPrintOperation:embed-page-setup property.
<function name="gtk_print_operation_get_error">
<description>
Call this when the result of a print operation is
-%GTK_PRINT_OPERATION_RESULT_ERROR, either as returned by
-gtk_print_operation_run(), or in the #GtkPrintOperation::done signal
-handler. The returned #GError will contain more details on what went wrong.
+%GTK_PRINT_OPERATION_RESULT_ERROR.
+
+It can be called either after [method Gtk PrintOperation run]
+returns, or in the [signal@Gtk.PrintOperation::done] signal
+handler.
+
+The returned `GError` will contain more details on what went wrong.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="error">
@@ -56732,13 +60127,13 @@ handler. The returned #GError will contain more details on what went wrong.
<function name="gtk_print_operation_get_has_selection">
<description>
-Gets the value of #GtkPrintOperation:has-selection property.
+Gets whether there is a selection.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
</parameters>
@@ -56753,16 +60148,17 @@ Returns the number of pages that will be printed.
Note that this value is set during print preparation phase
(%GTK_PRINT_STATUS_PREPARING), so this function should never be
called before the data generation phase (%GTK_PRINT_STATUS_GENERATING_DATA).
-You can connect to the #GtkPrintOperation::status-changed signal
-and call gtk_print_operation_get_n_pages_to_print() when
+You can connect to the [signal@Gtk.PrintOperation::status-changed]
+signal and call gtk_print_operation_get_n_pages_to_print() when
print status is %GTK_PRINT_STATUS_GENERATING_DATA.
+
This is typically used to track the progress of print operation.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
</parameters>
@@ -56775,14 +60171,14 @@ This is typically used to track the progress of print operation.
Returns the current print settings.
Note that the return value is %NULL until either
-gtk_print_operation_set_print_settings() or
-gtk_print_operation_run() have been called.
+[method@Gtk.PrintOperation.set_print_settings] or
+[method Gtk PrintOperation run] have been called.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
</parameters>
@@ -56792,14 +60188,15 @@ gtk_print_operation_run() have been called.
<function name="gtk_print_operation_get_status">
<description>
-Returns the status of the print operation.
-Also see gtk_print_operation_get_status_string().
+Returns the status of the print operation.
+
+Also see [method@Gtk.PrintOperation.get_status_string].
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
</parameters>
@@ -56809,18 +60206,20 @@ Also see gtk_print_operation_get_status_string().
<function name="gtk_print_operation_get_status_string">
<description>
-Returns a string representation of the status of the
-print operation. The string is translated and suitable
-for displaying the print status e.g. in a #GtkStatusbar.
+Returns a string representation of the status of the
+print operation.
-Use gtk_print_operation_get_status() to obtain a status
-value that is suitable for programmatic use.
+The string is translated and suitable for displaying
+the print status e.g. in a `GtkStatusbar`.
+
+Use [method@Gtk.PrintOperation.get_status] to obtain
+a status value that is suitable for programmatic use.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
</parameters>
@@ -56831,13 +60230,13 @@ of the print operation
<function name="gtk_print_operation_get_support_selection">
<description>
-Gets the value of #GtkPrintOperation:support-selection property.
+Gets whether the application supports print of selection
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
</parameters>
@@ -56848,8 +60247,10 @@ Gets the value of #GtkPrintOperation:support-selection property.
<function name="gtk_print_operation_is_finished">
<description>
A convenience function to find out if the print operation
-is finished, either successfully (%GTK_PRINT_STATUS_FINISHED)
-or unsuccessfully (%GTK_PRINT_STATUS_FINISHED_ABORTED).
+is finished.
+
+a print operation is finished if its status is either
+%GTK_PRINT_STATUS_FINISHED or %GTK_PRINT_STATUS_FINISHED_ABORTED.
Note: when you enable print status tracking the print operation
can be in a non-finished state even after done has been called, as
@@ -56859,7 +60260,7 @@ the operation status then tracks the print job status on the printer.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
</parameters>
@@ -56869,26 +60270,26 @@ the operation status then tracks the print job status on the printer.
<function name="gtk_print_operation_new">
<description>
-Creates a new #GtkPrintOperation.
+Creates a new `GtkPrintOperation`.
</description>
<parameters>
</parameters>
-<return> a new #GtkPrintOperation
+<return> a new `GtkPrintOperation`
</return>
</function>
<function name="gtk_print_operation_preview_end_preview">
<description>
-Ends a preview.
+Ends a preview.
This function must be called to finish a custom print preview.
</description>
<parameters>
<parameter name="preview">
-<parameter_description> a #GtkPrintOperationPreview
+<parameter_description> a `GtkPrintOperationPreview`
</parameter_description>
</parameter>
</parameters>
@@ -56904,7 +60305,7 @@ have been selected for printing.
</description>
<parameters>
<parameter name="preview">
-<parameter_description> a #GtkPrintOperationPreview
+<parameter_description> a `GtkPrintOperationPreview`
</parameter_description>
</parameter>
<parameter name="page_nr">
@@ -56918,20 +60319,22 @@ have been selected for printing.
<function name="gtk_print_operation_preview_render_page">
<description>
-Renders a page to the preview, using the print context that
-was passed to the #GtkPrintOperation::preview handler together
+Renders a page to the preview.
+
+This is using the print context that was passed to the
+[signal@Gtk.PrintOperation::preview] handler together
with @preview.
-A custom iprint preview should use this function in its ::expose
-handler to render the currently selected page.
+A custom print preview should use this function to render
+the currently selected page.
-Note that this function requires a suitable cairo context to
-be associated with the print context.
+Note that this function requires a suitable cairo context to
+be associated with the print context.
</description>
<parameters>
<parameter name="preview">
-<parameter_description> a #GtkPrintOperationPreview
+<parameter_description> a `GtkPrintOperationPreview`
</parameter_description>
</parameter>
<parameter name="page_nr">
@@ -56944,36 +60347,36 @@ be associated with the print context.
<function name="gtk_print_operation_run">
<description>
-Runs the print operation, by first letting the user modify
-print settings in the print dialog, and then print the document.
+Runs the print operation.
+
+Normally that this function does not return until the rendering
+of all pages is complete. You can connect to the
+[signal@Gtk.PrintOperation::status-changed] signal on @op to obtain
+some information about the progress of the print operation.
-Normally that this function does not return until the rendering of all
-pages is complete. You can connect to the
-#GtkPrintOperation::status-changed signal on @op to obtain some
-information about the progress of the print operation.
Furthermore, it may use a recursive mainloop to show the print dialog.
-If you call gtk_print_operation_set_allow_async() or set the
-#GtkPrintOperation:allow-async property the operation will run
-asynchronously if this is supported on the platform. The
-#GtkPrintOperation::done signal will be emitted with the result of the
-operation when the it is done (i.e. when the dialog is canceled, or when
-the print succeeds or fails).
-|[<!-- language="C" -->
+If you set the [Gtk.PrintOperation:allow-async] property, the operation
+will run asynchronously if this is supported on the platform. The
+[signal@Gtk.PrintOperation::done] signal will be emitted with the result
+of the operation when the it is done (i.e. when the dialog is canceled,
+or when the print succeeds or fails).
+
+```c
if (settings != NULL)
gtk_print_operation_set_print_settings (print, settings);
if (page_setup != NULL)
gtk_print_operation_set_default_page_setup (print, page_setup);
-g_signal_connect (print, "begin-print",
+g_signal_connect (print, "begin-print",
G_CALLBACK (begin_print), &data);
-g_signal_connect (print, "draw-page",
+g_signal_connect (print, "draw-page",
G_CALLBACK (draw_page), &data);
-res = gtk_print_operation_run (print,
-GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
-parent,
+res = gtk_print_operation_run (print,
+GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
+parent,
&error);
if (res == GTK_PRINT_OPERATION_RESULT_ERROR)
@@ -56984,7 +60387,7 @@ GTK_MESSAGE_ERROR,
GTK_BUTTONS_CLOSE,
"Error printing file:\n%s",
error->message);
-g_signal_connect (error_dialog, "response",
+g_signal_connect (error_dialog, "response",
G_CALLBACK (gtk_window_destroy), NULL);
gtk_widget_show (error_dialog);
g_error_free (error);
@@ -56995,16 +60398,16 @@ if (settings != NULL)
g_object_unref (settings);
settings = g_object_ref (gtk_print_operation_get_print_settings (print));
}
-]|
+```
Note that gtk_print_operation_run() can only be called once on a
-given #GtkPrintOperation.
+given `GtkPrintOperation`.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="action">
@@ -57020,27 +60423,30 @@ given #GtkPrintOperation.
</parameter_description>
</parameter>
</parameters>
-<return> the result of the print operation. A return value of
+<return> the result of the print operation. A return value of
%GTK_PRINT_OPERATION_RESULT_APPLY indicates that the printing was
-completed successfully. In this case, it is a good idea to obtain
-the used print settings with gtk_print_operation_get_print_settings()
+completed successfully. In this case, it is a good idea to obtain
+the used print settings with
+[method@Gtk.PrintOperation.get_print_settings]
and store them for reuse with the next print operation. A value of
%GTK_PRINT_OPERATION_RESULT_IN_PROGRESS means the operation is running
-asynchronously, and will emit the #GtkPrintOperation::done signal when
-done.
+asynchronously, and will emit the [signal@Gtk.PrintOperation::done]
+signal when done.
</return>
</function>
<function name="gtk_print_operation_set_allow_async">
<description>
-Sets whether the gtk_print_operation_run() may return
-before the print operation is completed. Note that
-some platforms may not allow asynchronous operation.
+Sets whether gtk_print_operation_run() may return
+before the print operation is completed.
+
+Note that some platforms may not allow asynchronous
+operation.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="allow_async">
@@ -57055,7 +60461,7 @@ some platforms may not allow asynchronous operation.
<description>
Sets the current page.
-If this is called before gtk_print_operation_run(),
+If this is called before [method Gtk PrintOperation run],
the user will be able to select to print only the current page.
Note that this only makes sense for pre-paginated documents.
@@ -57063,7 +60469,7 @@ Note that this only makes sense for pre-paginated documents.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="current_page">
@@ -57081,7 +60487,7 @@ Sets the label for the tab holding custom widgets.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="label">
@@ -57096,18 +60502,18 @@ Sets the label for the tab holding custom widgets.
<description>
Makes @default_page_setup the default page setup for @op.
-This page setup will be used by gtk_print_operation_run(),
+This page setup will be used by [method Gtk PrintOperation run],
but it can be overridden on a per-page basis by connecting
-to the #GtkPrintOperation::request-page-setup signal.
+to the [signal@Gtk.PrintOperation::request-page-setup] signal.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="default_page_setup">
-<parameter_description> a #GtkPageSetup, or %NULL
+<parameter_description> a `GtkPageSetup`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -57116,16 +60522,18 @@ to the #GtkPrintOperation::request-page-setup signal.
<function name="gtk_print_operation_set_defer_drawing">
<description>
-Sets up the #GtkPrintOperation to wait for calling of
-gtk_print_operation_draw_page_finish() from application. It can
-be used for drawing page in another thread.
+Sets up the `GtkPrintOperation` to wait for calling of
+[method@Gtk.PrintOperation.draw_page_finish from application.
-This function must be called in the callback of “draw-page” signal.
+This can be used for drawing page in another thread.
+
+This function must be called in the callback of the
+[signal@Gtk.PrintOperation::draw-page] signal.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
</parameters>
@@ -57135,16 +60543,17 @@ This function must be called in the callback of “draw-page” signal.
<function name="gtk_print_operation_set_embed_page_setup">
<description>
Embed page size combo box and orientation combo box into page setup page.
-Selected page setup is stored as default page setup in #GtkPrintOperation.
+
+Selected page setup is stored as default page setup in `GtkPrintOperation`.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="embed">
-<parameter_description> %TRUE to embed page setup selection in the #GtkPrintUnixDialog
+<parameter_description> %TRUE to embed page setup selection in the `GtkPrintUnixDialog`
</parameter_description>
</parameter>
</parameters>
@@ -57153,10 +60562,12 @@ Selected page setup is stored as default page setup in #GtkPrintOperation.
<function name="gtk_print_operation_set_export_filename">
<description>
-Sets up the #GtkPrintOperation to generate a file instead
-of showing the print dialog. The intended use of this function
-is for implementing “Export to PDF” actions. Currently, PDF
-is the only supported format.
+Sets up the `GtkPrintOperation` to generate a file instead
+of showing the print dialog.
+
+The intended use of this function is for implementing
+“Export to PDF” actions. Currently, PDF is the only supported
+format.
“Print to PDF” support is independent of this and is done
by letting the user pick the “Print to PDF” item from the list
@@ -57165,7 +60576,7 @@ of printers in the print dialog.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="filename">
@@ -57181,13 +60592,13 @@ of printers in the print dialog.
Sets whether there is a selection to print.
Application has to set number of pages to which the selection
-will draw by gtk_print_operation_set_n_pages() in a callback of
-#GtkPrintOperation::begin-print.
+will draw by [method@Gtk.PrintOperation.set_n_pages] in a handler
+for the [signal@Gtk.PrintOperation::begin-print] signal.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="has_selection">
@@ -57200,16 +60611,18 @@ will draw by gtk_print_operation_set_n_pages() in a callback of
<function name="gtk_print_operation_set_job_name">
<description>
-Sets the name of the print job. The name is used to identify
-the job (e.g. in monitoring applications like eggcups).
+Sets the name of the print job.
-If you don’t set a job name, GTK picks a default one by
+The name is used to identify the job (e.g. in monitoring
+applications like eggcups).
+
+If you don’t set a job name, GTK picks a default one by
numbering successive print jobs.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="job_name">
@@ -57222,22 +60635,22 @@ numbering successive print jobs.
<function name="gtk_print_operation_set_n_pages">
<description>
-Sets the number of pages in the document.
+Sets the number of pages in the document.
-This must be set to a positive number
-before the rendering starts. It may be set in a
-#GtkPrintOperation::begin-print signal handler.
+This must be set to a positive number before the rendering
+starts. It may be set in a [signal@Gtk.PrintOperation::begin-print]
+signal handler.
-Note that the page numbers passed to the
-#GtkPrintOperation::request-page-setup
-and #GtkPrintOperation::draw-page signals are 0-based, i.e. if
-the user chooses to print all pages, the last ::draw-page signal
+Note that the page numbers passed to the
+[signal@Gtk.PrintOperation::request-page-setup]
+and [signal@Gtk.PrintOperation::draw-page] signals are 0-based, i.e.
+if the user chooses to print all pages, the last ::draw-page signal
will be for page @n_pages - 1.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="n_pages">
@@ -57250,18 +60663,19 @@ will be for page @n_pages - 1.
<function name="gtk_print_operation_set_print_settings">
<description>
-Sets the print settings for @op. This is typically used to
-re-establish print settings from a previous print operation,
-see gtk_print_operation_run().
+Sets the print settings for @op.
+
+This is typically used to re-establish print settings
+from a previous print operation, see [method Gtk PrintOperation run].
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="print_settings">
-<parameter_description> #GtkPrintSettings
+<parameter_description> `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57270,13 +60684,13 @@ see gtk_print_operation_run().
<function name="gtk_print_operation_set_show_progress">
<description>
-If @show_progress is %TRUE, the print operation will show a
-progress dialog during the print operation.
+If @show_progress is %TRUE, the print operation will show
+a progress dialog during the print operation.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="show_progress">
@@ -57289,12 +60703,12 @@ progress dialog during the print operation.
<function name="gtk_print_operation_set_support_selection">
<description>
-Sets whether selection is supported by #GtkPrintOperation.
+Sets whether selection is supported by `GtkPrintOperation`.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="support_selection">
@@ -57307,18 +60721,19 @@ Sets whether selection is supported by #GtkPrintOperation.
<function name="gtk_print_operation_set_track_print_status">
<description>
-If track_status is %TRUE, the print operation will try to continue report
-on the status of the print job in the printer queues and printer. This
-can allow your application to show things like “out of paper” issues,
-and when the print job actually reaches the printer.
+If track_status is %TRUE, the print operation will try to continue
+report on the status of the print job in the printer queues and printer.
-This function is often implemented using some form of polling, so it should
-not be enabled unless needed.
+This can allow your application to show things like “out of paper”
+issues, and when the print job actually reaches the printer.
+
+This function is often implemented using some form of polling,
+so it should not be enabled unless needed.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="track_status">
@@ -57332,13 +60747,13 @@ not be enabled unless needed.
<function name="gtk_print_operation_set_unit">
<description>
Sets up the transformation for the cairo context obtained from
-#GtkPrintContext in such a way that distances are measured in
+`GtkPrintContext` in such a way that distances are measured in
units of @unit.
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="unit">
@@ -57351,21 +60766,22 @@ units of @unit.
<function name="gtk_print_operation_set_use_full_page">
<description>
-If @full_page is %TRUE, the transformation for the cairo context
-obtained from #GtkPrintContext puts the origin at the top left
-corner of the page (which may not be the top left corner of the
-sheet, depending on page orientation and the number of pages per
-sheet). Otherwise, the origin is at the top left corner of the
-imageable area (i.e. inside the margins).
+If @full_page is %TRUE, the transformation for the cairo context
+obtained from `GtkPrintContext` puts the origin at the top left
+corner of the page.
+
+This may not be the top left corner of the sheet, depending on page
+orientation and the number of pages per sheet). Otherwise, the origin
+is at the top left corner of the imageable area (i.e. inside the margins).
</description>
<parameters>
<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter_description> a `GtkPrintOperation`
</parameter_description>
</parameter>
<parameter name="full_page">
-<parameter_description> %TRUE to set up the #GtkPrintContext for the full page
+<parameter_description> %TRUE to set up the `GtkPrintContext` for the full page
</parameter_description>
</parameter>
</parameters>
@@ -57440,13 +60856,13 @@ the modified page setup
<function name="gtk_print_settings_copy">
<description>
-Copies a #GtkPrintSettings object.
+Copies a `GtkPrintSettings` object.
</description>
<parameters>
<parameter name="other">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57461,7 +60877,7 @@ Calls @func for each key-value pair of @settings.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="func">
@@ -57484,7 +60900,7 @@ Looks up the string value associated with @key.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key">
@@ -57499,16 +60915,16 @@ Looks up the string value associated with @key.
<function name="gtk_print_settings_get_bool">
<description>
Returns the boolean represented by the value
-that is associated with @key.
+that is associated with @key.
-The string “true” represents %TRUE, any other
+The string “true” represents %TRUE, any other
string %FALSE.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key">
@@ -57533,7 +60949,7 @@ The string “true” represents %TRUE, the string
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key">
@@ -57557,7 +60973,7 @@ Gets the value of %GTK_PRINT_SETTINGS_COLLATE.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57573,7 +60989,7 @@ Gets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57589,7 +61005,7 @@ Gets the value of %GTK_PRINT_SETTINGS_DITHER.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57605,7 +61021,7 @@ Returns the double value associated with @key, or 0.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key">
@@ -57619,7 +61035,7 @@ Returns the double value associated with @key, or 0.
<function name="gtk_print_settings_get_double_with_default">
<description>
-Returns the floating point number represented by
+Returns the floating point number represented by
the value that is associated with @key, or @default_val
if the value does not represent a floating point number.
@@ -57629,7 +61045,7 @@ Floating point numbers are parsed with g_ascii_strtod().
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key">
@@ -57653,7 +61069,7 @@ Gets the value of %GTK_PRINT_SETTINGS_DUPLEX.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57669,7 +61085,7 @@ Gets the value of %GTK_PRINT_SETTINGS_FINISHINGS.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57685,7 +61101,7 @@ Returns the integer value of @key, or 0.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key">
@@ -57693,7 +61109,7 @@ Returns the integer value of @key, or 0.
</parameter_description>
</parameter>
</parameters>
-<return> the integer value of @key
+<return> the integer value of @key
</return>
</function>
@@ -57706,7 +61122,7 @@ an integer, or the default value.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key">
@@ -57725,13 +61141,15 @@ an integer, or the default value.
<function name="gtk_print_settings_get_length">
<description>
Returns the value associated with @key, interpreted
-as a length. The returned value is converted to @units.
+as a length.
+
+The returned value is converted to @units.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key">
@@ -57757,7 +61175,7 @@ The set of media types is defined in PWG 5101.1-2002 PWG.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57773,7 +61191,7 @@ Gets the value of %GTK_PRINT_SETTINGS_N_COPIES.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57789,7 +61207,7 @@ Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57805,7 +61223,7 @@ Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57815,14 +61233,14 @@ Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.
<function name="gtk_print_settings_get_orientation">
<description>
-Get the value of %GTK_PRINT_SETTINGS_ORIENTATION,
-converted to a #GtkPageOrientation.
+Get the value of %GTK_PRINT_SETTINGS_ORIENTATION,
+converted to a `GtkPageOrientation`.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57838,7 +61256,7 @@ Gets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57854,7 +61272,7 @@ Gets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="num_ranges">
@@ -57863,7 +61281,7 @@ Gets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES.
</parameter>
</parameters>
<return> an array
-of #GtkPageRanges. Use g_free() to free the array when
+of `GtkPageRange`s. Use g_free() to free the array when
it is no longer needed.
</return>
</function>
@@ -57876,7 +61294,7 @@ Gets the value of %GTK_PRINT_SETTINGS_PAGE_SET.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57887,13 +61305,13 @@ Gets the value of %GTK_PRINT_SETTINGS_PAGE_SET.
<function name="gtk_print_settings_get_paper_height">
<description>
Gets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT,
-converted to @unit.
+converted to @unit.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="unit">
@@ -57907,14 +61325,14 @@ converted to @unit.
<function name="gtk_print_settings_get_paper_size">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT,
-converted to a #GtkPaperSize.
+Gets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT,
+converted to a `GtkPaperSize`.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57925,13 +61343,13 @@ converted to a #GtkPaperSize.
<function name="gtk_print_settings_get_paper_width">
<description>
Gets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH,
-converted to @unit.
+converted to @unit.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="unit">
@@ -57951,7 +61369,7 @@ Gets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57961,14 +61379,14 @@ Gets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES.
<function name="gtk_print_settings_get_printer">
<description>
-Convenience function to obtain the value of
+Convenience function to obtain the value of
%GTK_PRINT_SETTINGS_PRINTER.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -57984,7 +61402,7 @@ Gets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -58000,7 +61418,7 @@ Gets the value of %GTK_PRINT_SETTINGS_QUALITY.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -58016,7 +61434,7 @@ Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -58032,7 +61450,7 @@ Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_X.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -58048,7 +61466,7 @@ Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_Y.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -58064,7 +61482,7 @@ Gets the value of %GTK_PRINT_SETTINGS_REVERSE.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -58080,7 +61498,7 @@ Gets the value of %GTK_PRINT_SETTINGS_SCALE.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -58096,7 +61514,7 @@ Gets the value of %GTK_PRINT_SETTINGS_USE_COLOR.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
@@ -58112,7 +61530,7 @@ Returns %TRUE, if a value is associated with @key.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key">
@@ -58126,15 +61544,18 @@ Returns %TRUE, if a value is associated with @key.
<function name="gtk_print_settings_load_file">
<description>
-Reads the print settings from @file_name. If the file could not be loaded
-then error is set to either a #GFileError or #GKeyFileError.
-See gtk_print_settings_to_file().
+Reads the print settings from @file_name.
+
+If the file could not be loaded then error is set to either
+a `GFileError` or `GKeyFileError`.
+
+See [method@Gtk.PrintSettings.to_file].
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="file_name">
@@ -58152,24 +61573,25 @@ See gtk_print_settings_to_file().
<function name="gtk_print_settings_load_key_file">
<description>
-Reads the print settings from the group @group_name in @key_file. If the
-file could not be loaded then error is set to either a #GFileError or
-#GKeyFileError.
+Reads the print settings from the group @group_name in @key_file.
+
+If the file could not be loaded then error is set to either a
+`GFileError` or `GKeyFileError`.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key_file">
-<parameter_description> the #GKeyFile to retrieve the settings from
+<parameter_description> the `GKeyFile` to retrieve the settings from
</parameter_description>
</parameter>
<parameter name="group_name">
-<parameter_description> the name of the group to use, or %NULL to use the default
-“Print Settings”
+<parameter_description> the name of the group to use, or %NULL
+to use the default “Print Settings”
</parameter_description>
</parameter>
<parameter name="error">
@@ -58183,22 +61605,19 @@ file could not be loaded then error is set to either a #GFileError or
<function name="gtk_print_settings_new">
<description>
-Creates a new #GtkPrintSettings object.
+Creates a new `GtkPrintSettings` object.
</description>
<parameters>
</parameters>
-<return> a new #GtkPrintSettings object
+<return> a new `GtkPrintSettings` object
</return>
</function>
<function name="gtk_print_settings_new_from_file">
<description>
-Reads the print settings from @file_name. Returns a new #GtkPrintSettings
-object with the restored settings, or %NULL if an error occurred. If the
-file could not be loaded then error is set to either a #GFileError or
-#GKeyFileError. See gtk_print_settings_to_file().
+Reads the print settings from @file_name.
</description>
@@ -58212,39 +61631,38 @@ file could not be loaded then error is set to either a #GFileError or
</parameter_description>
</parameter>
</parameters>
-<return> the restored #GtkPrintSettings
+<return> the restored `GtkPrintSettings`
</return>
</function>
<function name="gtk_print_settings_new_from_gvariant">
<description>
-Deserialize print settings from an a{sv} variant in
-the format produced by gtk_print_settings_to_gvariant().
+Deserialize print settings from an a{sv} variant.
+
+The variant must be in the format produced by
+[method@Gtk.PrintSettings.to_gvariant].
</description>
<parameters>
<parameter name="variant">
-<parameter_description> an a{sv} #GVariant
+<parameter_description> an a{sv} `GVariant`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPrintSettings object
+<return> a new `GtkPrintSettings` object
</return>
</function>
<function name="gtk_print_settings_new_from_key_file">
<description>
-Reads the print settings from the group @group_name in @key_file. Returns a
-new #GtkPrintSettings object with the restored settings, or %NULL if an
-error occurred. If the file could not be loaded then error is set to either
-a #GFileError or #GKeyFileError.
+Reads the print settings from the group @group_name in @key_file.
</description>
<parameters>
<parameter name="key_file">
-<parameter_description> the #GKeyFile to retrieve the settings from
+<parameter_description> the `GKeyFile` to retrieve the settings from
</parameter_description>
</parameter>
<parameter name="group_name">
@@ -58257,7 +61675,7 @@ the default “Print Settings”
</parameter_description>
</parameter>
</parameters>
-<return> the restored #GtkPrintSettings
+<return> the restored `GtkPrintSettings`
</return>
</function>
@@ -58268,7 +61686,7 @@ Associates @value with @key.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key">
@@ -58290,7 +61708,7 @@ Sets @key to a boolean value.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key">
@@ -58312,7 +61730,7 @@ Sets the value of %GTK_PRINT_SETTINGS_COLLATE.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="collate">
@@ -58330,7 +61748,7 @@ Sets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="default_source">
@@ -58348,7 +61766,7 @@ Sets the value of %GTK_PRINT_SETTINGS_DITHER.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="dither">
@@ -58366,11 +61784,11 @@ Sets @key to a double value.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key">
-<parameter_description> a key
+<parameter_description> a key
</parameter_description>
</parameter>
<parameter name="value">
@@ -58388,7 +61806,7 @@ Sets the value of %GTK_PRINT_SETTINGS_DUPLEX.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="duplex">
@@ -58406,7 +61824,7 @@ Sets the value of %GTK_PRINT_SETTINGS_FINISHINGS.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="finishings">
@@ -58424,7 +61842,7 @@ Sets @key to an integer value.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key">
@@ -58432,7 +61850,7 @@ Sets @key to an integer value.
</parameter_description>
</parameter>
<parameter name="value">
-<parameter_description> an integer
+<parameter_description> an integer
</parameter_description>
</parameter>
</parameters>
@@ -58446,7 +61864,7 @@ Associates a length in units of @unit with @key.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key">
@@ -58474,7 +61892,7 @@ The set of media types is defined in PWG 5101.1-2002 PWG.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="media_type">
@@ -58492,11 +61910,11 @@ Sets the value of %GTK_PRINT_SETTINGS_N_COPIES.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="num_copies">
-<parameter_description> the number of copies
+<parameter_description> the number of copies
</parameter_description>
</parameter>
</parameters>
@@ -58510,11 +61928,11 @@ Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="number_up">
-<parameter_description> the number of pages per sheet
+<parameter_description> the number of pages per sheet
</parameter_description>
</parameter>
</parameters>
@@ -58528,7 +61946,7 @@ Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="number_up_layout">
@@ -58546,7 +61964,7 @@ Sets the value of %GTK_PRINT_SETTINGS_ORIENTATION.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="orientation">
@@ -58564,7 +61982,7 @@ Sets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="output_bin">
@@ -58582,11 +62000,11 @@ Sets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="page_ranges">
-<parameter_description> an array of #GtkPageRanges
+<parameter_description> an array of `GtkPageRange`s
</parameter_description>
</parameter>
<parameter name="num_ranges">
@@ -58604,7 +62022,7 @@ Sets the value of %GTK_PRINT_SETTINGS_PAGE_SET.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="page_set">
@@ -58622,7 +62040,7 @@ Sets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="height">
@@ -58646,7 +62064,7 @@ Sets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT,
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="paper_size">
@@ -58664,7 +62082,7 @@ Sets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="width">
@@ -58686,7 +62104,7 @@ Sets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="pages">
@@ -58705,7 +62123,7 @@ to @printer.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="printer">
@@ -58723,7 +62141,7 @@ Sets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="lpi">
@@ -58741,7 +62159,7 @@ Sets the value of %GTK_PRINT_SETTINGS_QUALITY.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="quality">
@@ -58755,13 +62173,13 @@ Sets the value of %GTK_PRINT_SETTINGS_QUALITY.
<function name="gtk_print_settings_set_resolution">
<description>
Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION,
-%GTK_PRINT_SETTINGS_RESOLUTION_X and
+%GTK_PRINT_SETTINGS_RESOLUTION_X and
%GTK_PRINT_SETTINGS_RESOLUTION_Y.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="resolution">
@@ -58781,7 +62199,7 @@ Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION,
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="resolution_x">
@@ -58803,7 +62221,7 @@ Sets the value of %GTK_PRINT_SETTINGS_REVERSE.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="reverse">
@@ -58821,7 +62239,7 @@ Sets the value of %GTK_PRINT_SETTINGS_SCALE.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="scale">
@@ -58839,7 +62257,7 @@ Sets the value of %GTK_PRINT_SETTINGS_USE_COLOR.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="use_color">
@@ -58852,15 +62270,16 @@ Sets the value of %GTK_PRINT_SETTINGS_USE_COLOR.
<function name="gtk_print_settings_to_file">
<description>
-This function saves the print settings from @settings to @file_name. If the
-file could not be loaded then error is set to either a #GFileError or
-#GKeyFileError.
+This function saves the print settings from @settings to @file_name.
+
+If the file could not be written then error is set to either a
+`GFileError` or `GKeyFileError`.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="file_name">
@@ -58884,11 +62303,11 @@ Serialize print settings to an a{sv} variant.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
</parameters>
-<return> a new, floating, #GVariant
+<return> a new, floating, `GVariant`
</return>
</function>
@@ -58899,11 +62318,11 @@ This function adds the print settings from @settings to @key_file.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key_file">
-<parameter_description> the #GKeyFile to save the print settings to
+<parameter_description> the `GKeyFile` to save the print settings to
</parameter_description>
</parameter>
<parameter name="group_name">
@@ -58917,13 +62336,14 @@ This function adds the print settings from @settings to @key_file.
<function name="gtk_print_settings_unset">
<description>
-Removes any value associated with @key.
+Removes any value associated with @key.
+
This has the same effect as setting the value to %NULL.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a `GtkPrintSettings`
</parameter_description>
</parameter>
<parameter name="key">
@@ -58941,7 +62361,7 @@ Adds a custom tab to the print dialog.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
<parameter name="child">
@@ -58958,13 +62378,13 @@ Adds a custom tab to the print dialog.
<function name="gtk_print_unix_dialog_get_current_page">
<description>
-Gets the current page of the #GtkPrintUnixDialog.
+Gets the current page of the `GtkPrintUnixDialog`.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
</parameters>
@@ -58974,29 +62394,29 @@ Gets the current page of the #GtkPrintUnixDialog.
<function name="gtk_print_unix_dialog_get_embed_page_setup">
<description>
-Gets the value of #GtkPrintUnixDialog:embed-page-setup property.
+Gets whether to embed the page setup.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
</parameters>
-<return> whether there is a selection
+<return> whether to embed the page setup
</return>
</function>
<function name="gtk_print_unix_dialog_get_has_selection">
<description>
-Gets the value of #GtkPrintUnixDialog:has-selection property.
+Gets whether there is a selection.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
</parameters>
@@ -59006,13 +62426,13 @@ Gets the value of #GtkPrintUnixDialog:has-selection property.
<function name="gtk_print_unix_dialog_get_manual_capabilities">
<description>
-Gets the value of #GtkPrintUnixDialog:manual-capabilities property.
+Gets the capabilities that have been set on this `GtkPrintUnixDialog`.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
</parameters>
@@ -59022,13 +62442,13 @@ Gets the value of #GtkPrintUnixDialog:manual-capabilities property.
<function name="gtk_print_unix_dialog_get_page_setup">
<description>
-Gets the page setup that is used by the #GtkPrintUnixDialog.
+Gets the page setup that is used by the `GtkPrintUnixDialog`.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
</parameters>
@@ -59038,13 +62458,13 @@ Gets the page setup that is used by the #GtkPrintUnixDialog.
<function name="gtk_print_unix_dialog_get_page_setup_set">
<description>
-Gets the page setup that is used by the #GtkPrintUnixDialog.
+Gets whether a page setup was set by the user.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
</parameters>
@@ -59060,7 +62480,7 @@ Gets the currently selected printer.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
</parameters>
@@ -59070,32 +62490,33 @@ Gets the currently selected printer.
<function name="gtk_print_unix_dialog_get_settings">
<description>
-Gets a new #GtkPrintSettings object that represents the
-current values in the print dialog. Note that this creates a
-new object, and you need to unref it
-if don’t want to keep it.
+Gets a new `GtkPrintSettings` object that represents the
+current values in the print dialog.
+
+Note that this creates a new object, and you need to unref
+it if don’t want to keep it.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPrintSettings object with the values from @dialog
+<return> a new `GtkPrintSettings` object with the values from @dialog
</return>
</function>
<function name="gtk_print_unix_dialog_get_support_selection">
<description>
-Gets the value of #GtkPrintUnixDialog:support-selection property.
+Gets whether the print dialog allows user to print a selection.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
</parameters>
@@ -59105,7 +62526,7 @@ Gets the value of #GtkPrintUnixDialog:support-selection property.
<function name="gtk_print_unix_dialog_new">
<description>
-Creates a new #GtkPrintUnixDialog.
+Creates a new `GtkPrintUnixDialog`.
</description>
@@ -59119,19 +62540,21 @@ Creates a new #GtkPrintUnixDialog.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPrintUnixDialog
+<return> a new `GtkPrintUnixDialog`
</return>
</function>
<function name="gtk_print_unix_dialog_set_current_page">
<description>
-Sets the current page number. If @current_page is not -1, this enables
-the current page choice for the range of pages to print.
+Sets the current page number.
+
+If @current_page is not -1, this enables the current page choice
+for the range of pages to print.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
<parameter name="current_page">
@@ -59149,7 +62572,7 @@ Embed page size combo box and orientation combo box into page setup page.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
<parameter name="embed">
@@ -59167,7 +62590,7 @@ Sets whether a selection exists.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
<parameter name="has_selection">
@@ -59181,15 +62604,17 @@ Sets whether a selection exists.
<function name="gtk_print_unix_dialog_set_manual_capabilities">
<description>
This lets you specify the printing capabilities your application
-supports. For instance, if you can handle scaling the output then
-you pass #GTK_PRINT_CAPABILITY_SCALE. If you don’t pass that, then
-the dialog will only let you select the scale if the printing
-system automatically handles scaling.
+supports.
+
+For instance, if you can handle scaling the output then you pass
+%GTK_PRINT_CAPABILITY_SCALE. If you don’t pass that, then the dialog
+will only let you select the scale if the printing system automatically
+handles scaling.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
<parameter name="capabilities">
@@ -59202,16 +62627,16 @@ system automatically handles scaling.
<function name="gtk_print_unix_dialog_set_page_setup">
<description>
-Sets the page setup of the #GtkPrintUnixDialog.
+Sets the page setup of the `GtkPrintUnixDialog`.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
<parameter name="page_setup">
-<parameter_description> a #GtkPageSetup
+<parameter_description> a `GtkPageSetup`
</parameter_description>
</parameter>
</parameters>
@@ -59220,18 +62645,20 @@ Sets the page setup of the #GtkPrintUnixDialog.
<function name="gtk_print_unix_dialog_set_settings">
<description>
-Sets the #GtkPrintSettings for the #GtkPrintUnixDialog. Typically,
-this is used to restore saved print settings from a previous print
-operation before the print dialog is shown.
+Sets the `GtkPrintSettings` for the `GtkPrintUnixDialog`.
+
+Typically, this is used to restore saved print settings
+from a previous print operation before the print dialog
+is shown.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings, or %NULL
+<parameter_description> a `GtkPrintSettings`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -59245,7 +62672,7 @@ Sets whether the print dialog allows user to print a selection.
</description>
<parameters>
<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter_description> a `GtkPrintUnixDialog`
</parameter_description>
</parameter>
<parameter name="support_selection">
@@ -59259,13 +62686,13 @@ Sets whether the print dialog allows user to print a selection.
<function name="gtk_printer_accepts_pdf">
<description>
Returns whether the printer accepts input in
-PDF format.
+PDF format.
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
@@ -59276,13 +62703,13 @@ PDF format.
<function name="gtk_printer_accepts_ps">
<description>
Returns whether the printer accepts input in
-PostScript format.
+PostScript format.
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
@@ -59298,15 +62725,15 @@ Compares two printers.
</description>
<parameters>
<parameter name="a">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
<parameter name="b">
-<parameter_description> another #GtkPrinter
+<parameter_description> another `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
-<return> 0 if the printer match, a negative value if @a < @b,
+<return> 0 if the printer match, a negative value if @a < @b,
or a positive value if @a > @b
</return>
</function>
@@ -59319,7 +62746,7 @@ Returns the backend of the printer.
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
@@ -59331,18 +62758,19 @@ Returns the backend of the printer.
<description>
Returns the printer’s capabilities.
-This is useful when you’re using #GtkPrintUnixDialog’s manual-capabilities
-setting and need to know which settings the printer can handle and which
-you must handle yourself.
+This is useful when you’re using `GtkPrintUnixDialog`’s
+manual-capabilities setting and need to know which settings
+the printer can handle and which you must handle yourself.
-This will return 0 unless the printer’s details are available, see
-gtk_printer_has_details() and gtk_printer_request_details().
+This will return 0 unless the printer’s details are
+available, see [method@Gtk.Printer.has_details] and
+[method@Gtk.Printer.request_details].
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
@@ -59358,11 +62786,12 @@ Returns default page size of @printer.
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated #GtkPageSetup with default page size of the printer.
+<return> a newly allocated `GtkPageSetup` with default page size
+of the printer.
</return>
</function>
@@ -59384,17 +62813,20 @@ Gets the description of the printer.
<function name="gtk_printer_get_hard_margins">
<description>
-Retrieve the hard margins of @printer, i.e. the margins that define
-the area at the borders of the paper that the printer cannot print to.
+Retrieve the hard margins of @printer.
+
+These are the margins that define the area at the borders
+of the paper that the printer cannot print to.
-Note: This will not succeed unless the printer’s details are available,
-see gtk_printer_has_details() and gtk_printer_request_details().
+Note: This will not succeed unless the printer’s details are
+available, see [method@Gtk.Printer.has_details] and
+[method@Gtk.Printer.request_details].
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
<parameter name="top">
@@ -59420,22 +62852,24 @@ see gtk_printer_has_details() and gtk_printer_request_details().
<function name="gtk_printer_get_hard_margins_for_paper_size">
<description>
-Retrieve the hard margins of @printer for @paper_size, i.e. the
-margins that define the area at the borders of the paper that the
-printer cannot print to.
+Retrieve the hard margins of @printer for @paper_size.
+
+These are the margins that define the area at the borders
+of the paper that the printer cannot print to.
-Note: This will not succeed unless the printer's details are available,
-see gtk_printer_has_details() and gtk_printer_request_details().
+Note: This will not succeed unless the printer’s details are
+available, see [method@Gtk.Printer.has_details] and
+[method@Gtk.Printer.request_details].
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
<parameter name="paper_size">
-<parameter_description> a #GtkPaperSize
+<parameter_description> a `GtkPaperSize`
</parameter_description>
</parameter>
<parameter name="top">
@@ -59467,7 +62901,7 @@ Gets the name of the icon to use for the printer.
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
@@ -59483,7 +62917,7 @@ Gets the number of jobs currently queued on the printer.
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
@@ -59499,7 +62933,7 @@ Returns a description of the location of the printer.
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
@@ -59515,7 +62949,7 @@ Returns the name of the printer.
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
@@ -59532,7 +62966,7 @@ of the printer.
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
@@ -59548,7 +62982,7 @@ Returns whether the printer details are available.
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
@@ -59564,7 +62998,7 @@ Returns whether the printer is accepting jobs
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
@@ -59574,14 +63008,14 @@ Returns whether the printer is accepting jobs
<function name="gtk_printer_is_active">
<description>
-Returns whether the printer is currently active (i.e.
+Returns whether the printer is currently active (i.e.
accepts new jobs).
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
@@ -59597,7 +63031,7 @@ Returns whether the printer is the default printer.
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
@@ -59608,6 +63042,7 @@ Returns whether the printer is the default printer.
<function name="gtk_printer_is_paused">
<description>
Returns whether the printer is currently paused.
+
A paused printer still accepts jobs, but it is not
printing them.
@@ -59615,7 +63050,7 @@ printing them.
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
@@ -59626,14 +63061,14 @@ printing them.
<function name="gtk_printer_is_virtual">
<description>
Returns whether the printer is virtual (i.e. does not
-represent actual printer hardware, but something like
+represent actual printer hardware, but something like
a CUPS class).
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
@@ -59644,24 +63079,27 @@ a CUPS class).
<function name="gtk_printer_list_papers">
<description>
Lists all the paper sizes @printer supports.
-This will return and empty list unless the printer’s details are
-available, see gtk_printer_has_details() and gtk_printer_request_details().
+
+This will return and empty list unless the printer’s details
+are available, see [method@Gtk.Printer.has_details] and
+[method@Gtk.Printer.request_details].
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated list of newly allocated #GtkPageSetup s.
+<return> a newly
+allocated list of newly allocated `GtkPageSetup`s.
</return>
</function>
<function name="gtk_printer_new">
<description>
-Creates a new #GtkPrinter.
+Creates a new `GtkPrinter`.
</description>
@@ -59671,7 +63109,7 @@ Creates a new #GtkPrinter.
</parameter_description>
</parameter>
<parameter name="backend">
-<parameter_description> a #GtkPrintBackend
+<parameter_description> a `GtkPrintBackend`
</parameter_description>
</parameter>
<parameter name="virtual_">
@@ -59679,7 +63117,7 @@ Creates a new #GtkPrinter.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPrinter
+<return> a new `GtkPrinter`
</return>
</function>
@@ -59701,13 +63139,16 @@ Gets the groups in this set.
<function name="gtk_printer_request_details">
<description>
-Requests the printer details. When the details are available,
-the #GtkPrinter::details-acquired signal will be emitted on @printer.
+Requests the printer details.
+
+When the details are available, the
+[signal@Gtk.Printer::details-acquired] signal
+will be emitted on @printer.
</description>
<parameters>
<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter_description> a `GtkPrinter`
</parameter_description>
</parameter>
</parameters>
@@ -59717,17 +63158,18 @@ the #GtkPrinter::details-acquired signal will be emitted on @printer.
<function name="gtk_progress_bar_get_ellipsize">
<description>
Returns the ellipsizing position of the progress bar.
-See gtk_progress_bar_set_ellipsize().
+
+See [method@Gtk.ProgressBar.set_ellipsize].
</description>
<parameters>
<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter_description> a `GtkProgressBar`
</parameter_description>
</parameter>
</parameters>
-<return> #PangoEllipsizeMode
+<return> `PangoEllipsizeMode`
</return>
</function>
@@ -59739,7 +63181,7 @@ Returns the current fraction of the task that’s been completed.
</description>
<parameters>
<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter_description> a `GtkProgressBar`
</parameter_description>
</parameter>
</parameters>
@@ -59749,13 +63191,13 @@ Returns the current fraction of the task that’s been completed.
<function name="gtk_progress_bar_get_inverted">
<description>
-Gets the value set by gtk_progress_bar_set_inverted().
+Returns whether the progress bar is inverted.
</description>
<parameters>
<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter_description> a `GtkProgressBar`
</parameter_description>
</parameter>
</parameters>
@@ -59765,13 +63207,15 @@ Gets the value set by gtk_progress_bar_set_inverted().
<function name="gtk_progress_bar_get_pulse_step">
<description>
-Retrieves the pulse step set with gtk_progress_bar_set_pulse_step().
+Retrieves the pulse step.
+
+See [method@Gtk.ProgressBar.set_pulse_step].
</description>
<parameters>
<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter_description> a `GtkProgressBar`
</parameter_description>
</parameter>
</parameters>
@@ -59781,14 +63225,15 @@ Retrieves the pulse step set with gtk_progress_bar_set_pulse_step().
<function name="gtk_progress_bar_get_show_text">
<description>
-Gets the value of the #GtkProgressBar:show-text property.
-See gtk_progress_bar_set_show_text().
+Returns whether the `GtkProgressBar` shows text.
+
+See [method@Gtk.ProgressBar.set_show_text].
</description>
<parameters>
<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter_description> a `GtkProgressBar`
</parameter_description>
</parameter>
</parameters>
@@ -59798,16 +63243,16 @@ See gtk_progress_bar_set_show_text().
<function name="gtk_progress_bar_get_text">
<description>
-Retrieves the text that is displayed with the progress bar,
-if any, otherwise %NULL. The return value is a reference
-to the text, not a copy of it, so will become invalid
-if you change the text in the progress bar.
+Retrieves the text that is displayed with the progress bar.
+
+The return value is a reference to the text, not a copy of it,
+so will become invalid if you change the text in the progress bar.
</description>
<parameters>
<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter_description> a `GtkProgressBar`
</parameter_description>
</parameter>
</parameters>
@@ -59818,28 +63263,29 @@ and should not be modified or freed.
<function name="gtk_progress_bar_new">
<description>
-Creates a new #GtkProgressBar.
+Creates a new `GtkProgressBar`.
</description>
<parameters>
</parameters>
-<return> a #GtkProgressBar.
+<return> a `GtkProgressBar`.
</return>
</function>
<function name="gtk_progress_bar_pulse">
<description>
Indicates that some progress has been made, but you don’t know how much.
+
Causes the progress bar to enter “activity mode,” where a block
-bounces back and forth. Each call to gtk_progress_bar_pulse()
+bounces back and forth. Each call to [method@Gtk.ProgressBar.pulse]
causes the block to move by a little bit (the amount of movement
-per pulse is determined by gtk_progress_bar_set_pulse_step()).
+per pulse is determined by [method@Gtk.ProgressBar.set_pulse_step]).
</description>
<parameters>
<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter_description> a `GtkProgressBar`
</parameter_description>
</parameter>
</parameters>
@@ -59848,17 +63294,19 @@ per pulse is determined by gtk_progress_bar_set_pulse_step()).
<function name="gtk_progress_bar_set_ellipsize">
<description>
-Sets the mode used to ellipsize (add an ellipsis: "...") the
-text if there is not enough space to render the entire string.
+Sets the mode used to ellipsize the text.
+
+The text is ellipsized if there is not enough space
+to render the entire string.
</description>
<parameters>
<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter_description> a `GtkProgressBar`
</parameter_description>
</parameter>
<parameter name="mode">
-<parameter_description> a #PangoEllipsizeMode
+<parameter_description> a `PangoEllipsizeMode`
</parameter_description>
</parameter>
</parameters>
@@ -59868,13 +63316,14 @@ text if there is not enough space to render the entire string.
<function name="gtk_progress_bar_set_fraction">
<description>
Causes the progress bar to “fill in” the given fraction
-of the bar. The fraction should be between 0.0 and 1.0,
-inclusive.
+of the bar.
+
+The fraction should be between 0.0 and 1.0, inclusive.
</description>
<parameters>
<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter_description> a `GtkProgressBar`
</parameter_description>
</parameter>
<parameter name="fraction">
@@ -59887,13 +63336,15 @@ inclusive.
<function name="gtk_progress_bar_set_inverted">
<description>
+Sets whether the progress bar is inverted.
+
Progress bars normally grow from top to bottom or left to right.
Inverted progress bars grow in the opposite direction.
</description>
<parameters>
<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter_description> a `GtkProgressBar`
</parameter_description>
</parameter>
<parameter name="inverted">
@@ -59907,12 +63358,15 @@ Inverted progress bars grow in the opposite direction.
<function name="gtk_progress_bar_set_pulse_step">
<description>
Sets the fraction of total progress bar length to move the
-bouncing block for each call to gtk_progress_bar_pulse().
+bouncing block.
+
+The bouncing block is moved when [method@Gtk.ProgressBar.pulse]
+is called.
</description>
<parameters>
<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter_description> a `GtkProgressBar`
</parameter_description>
</parameter>
<parameter name="fraction">
@@ -59926,18 +63380,19 @@ bouncing block for each call to gtk_progress_bar_pulse().
<function name="gtk_progress_bar_set_show_text">
<description>
Sets whether the progress bar will show text next to the bar.
-The shown text is either the value of the #GtkProgressBar:text
-property or, if that is %NULL, the #GtkProgressBar:fraction value,
+
+The shown text is either the value of the [property@Gtk.ProgressBar:text]
+property or, if that is %NULL, the [property@Gtk.ProgressBar:fraction] value,
as a percentage.
To make a progress bar that is styled and sized suitably for containing
-text (even if the actual text is blank), set #GtkProgressBar:show-text to
-%TRUE and #GtkProgressBar:text to the empty string (not %NULL).
+text (even if the actual text is blank), set [property@Gtk.ProgressBar:show-text]
+to %TRUE and [property@Gtk.ProgressBar:text] to the empty string (not %NULL).
</description>
<parameters>
<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter_description> a `GtkProgressBar`
</parameter_description>
</parameter>
<parameter name="show_text">
@@ -59952,19 +63407,20 @@ text (even if the actual text is blank), set #GtkProgressBar:show-text to
<description>
Causes the given @text to appear next to the progress bar.
-If @text is %NULL and #GtkProgressBar:show-text is %TRUE, the current
-value of #GtkProgressBar:fraction will be displayed as a percentage.
+If @text is %NULL and [property@Gtk.ProgressBar:show-text] is %TRUE,
+the current value of [property@Gtk.ProgressBar:fraction] will be displayed
+as a percentage.
-If @text is non-%NULL and #GtkProgressBar:show-text is %TRUE, the text
-will be displayed. In this case, it will not display the progress
+If @text is non-%NULL and [property@Gtk.ProgressBar:show-text] is %TRUE,
+the text will be displayed. In this case, it will not display the progress
percentage. If @text is the empty string, the progress bar will still
be styled and sized suitably for containing text, as long as
-#GtkProgressBar:show-text is %TRUE.
+[property@Gtk.ProgressBar:show-text] is %TRUE.
</description>
<parameters>
<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter_description> a `GtkProgressBar`
</parameter_description>
</parameter>
<parameter name="text">
@@ -60212,7 +63668,7 @@ a property expression.
</description>
<parameters>
<parameter name="expression">
-<parameter_description> a property #GtkExpression
+<parameter_description> a property `GtkExpression`
</parameter_description>
</parameter>
</parameters>
@@ -60222,32 +63678,32 @@ a property expression.
<function name="gtk_property_expression_get_pspec">
<description>
-Gets the #GParamSpec specifying the property of
+Gets the `GParamSpec` specifying the property of
a property expression.
</description>
<parameters>
<parameter name="expression">
-<parameter_description> a property #GtkExpression
+<parameter_description> a property `GtkExpression`
</parameter_description>
</parameter>
</parameters>
-<return> the #GParamSpec
+<return> the `GParamSpec` for the property
</return>
</function>
<function name="gtk_property_expression_new">
<description>
Creates an expression that looks up a property via the
-given @expression or the `this` argument when @expression
-is %NULL.
+given `expression` or the `this` argument when `expression`
+is `NULL`.
-If the resulting object conforms to @this_type, its property
-named @property_name will be queried.
-Otherwise, this expression's evaluation will fail.
+If the resulting object conforms to `this_type`, its property named
+`property_name` will be queried. Otherwise, this expression's
+evaluation will fail.
-The given @this_type must have a property with @property_name.
+The given `this_type` must have a property with `property_name`.
</description>
@@ -60258,7 +63714,7 @@ The given @this_type must have a property with @property_name.
</parameter>
<parameter name="expression">
<parameter_description> Expression to
-evaluate to get the object to query or %NULL to
+evaluate to get the object to query or `NULL` to
query the `this` object
</parameter_description>
</parameter>
@@ -60267,18 +63723,18 @@ query the `this` object
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkExpression
+<return> a new `GtkExpression`
</return>
</function>
<function name="gtk_property_expression_new_for_pspec">
<description>
Creates an expression that looks up a property via the
-given @expression or the `this` argument when @expression
-is %NULL.
+given `expression` or the `this` argument when `expression`
+is `NULL`.
-If the resulting object conforms to @this_type, its
-property specified by @pspec will be queried.
+If the resulting object conforms to `this_type`, its
+property specified by `pspec` will be queried.
Otherwise, this expression's evaluation will fail.
@@ -60286,35 +63742,32 @@ Otherwise, this expression's evaluation will fail.
<parameters>
<parameter name="expression">
<parameter_description> Expression to
-evaluate to get the object to query or %NULL to
+evaluate to get the object to query or `NULL` to
query the `this` object
</parameter_description>
</parameter>
<parameter name="pspec">
-<parameter_description> the #GParamSpec for the property to query
+<parameter_description> the `GParamSpec` for the property to query
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkExpression
+<return> a new `GtkExpression`
</return>
</function>
<function name="gtk_range_get_adjustment">
<description>
-Get the #GtkAdjustment which is the “model” object for #GtkRange.
-See gtk_range_set_adjustment() for details.
-The return value does not have a reference added, so should not
-be unreferenced.
+Get the adjustment which is the “model” object for `GtkRange`.
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkAdjustment
+<return> a `GtkAdjustment`
</return>
</function>
@@ -60326,7 +63779,7 @@ Gets the current position of the fill level indicator.
</description>
<parameters>
<parameter name="range">
-<parameter_description> A #GtkRange
+<parameter_description> A `GtkRange`
</parameter_description>
</parameter>
</parameters>
@@ -60336,13 +63789,15 @@ Gets the current position of the fill level indicator.
<function name="gtk_range_get_flippable">
<description>
-Gets the value set by gtk_range_set_flippable().
+Gets whether the `GtkRange` respects text direction.
+
+See [method@Gtk.Range.set_flippable].
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
</parameters>
@@ -60352,13 +63807,15 @@ Gets the value set by gtk_range_set_flippable().
<function name="gtk_range_get_inverted">
<description>
-Gets the value set by gtk_range_set_inverted().
+Gets whether the range is inverted.
+
+See [method@Gtk.Range.set_inverted].
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
</parameters>
@@ -60371,12 +63828,12 @@ Gets the value set by gtk_range_set_inverted().
This function returns the area that contains the range’s trough,
in coordinates relative to @range's origin.
-This function is useful mainly for #GtkRange subclasses.
+This function is useful mainly for `GtkRange` subclasses.
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
<parameter name="range_rect">
@@ -60395,7 +63852,7 @@ Gets whether the range is restricted to the fill level.
</description>
<parameters>
<parameter name="range">
-<parameter_description> A #GtkRange
+<parameter_description> A `GtkRange`
</parameter_description>
</parameter>
</parameters>
@@ -60406,13 +63863,15 @@ Gets whether the range is restricted to the fill level.
<function name="gtk_range_get_round_digits">
<description>
Gets the number of digits to round the value to when
-it changes. See #GtkRange::change-value.
+it changes.
+
+See [signal@Gtk.Range::change-value].
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
</parameters>
@@ -60428,7 +63887,7 @@ Gets whether the range displays the fill level graphically.
</description>
<parameters>
<parameter name="range">
-<parameter_description> A #GtkRange
+<parameter_description> A `GtkRange`
</parameter_description>
</parameter>
</parameters>
@@ -60441,12 +63900,12 @@ Gets whether the range displays the fill level graphically.
This function returns sliders range along the long dimension,
in widget->window coordinates.
-This function is useful mainly for #GtkRange subclasses.
+This function is useful mainly for `GtkRange` subclasses.
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
<parameter name="slider_start">
@@ -60465,15 +63924,15 @@ end, or %NULL
<function name="gtk_range_get_slider_size_fixed">
<description>
-This function is useful mainly for #GtkRange subclasses.
+This function is useful mainly for `GtkRange` subclasses.
-See gtk_range_set_slider_size_fixed().
+See [method@Gtk.Range.set_slider_size_fixed].
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
</parameters>
@@ -60489,7 +63948,7 @@ Gets the current value of the range.
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
</parameters>
@@ -60499,22 +63958,24 @@ Gets the current value of the range.
<function name="gtk_range_set_adjustment">
<description>
-Sets the adjustment to be used as the “model” object for this range
-widget. The adjustment indicates the current range value, the
-minimum and maximum range values, the step/page increments used
-for keybindings and scrolling, and the page size. The page size
-is normally 0 for #GtkScale and nonzero for #GtkScrollbar, and
-indicates the size of the visible area of the widget being scrolled.
+Sets the adjustment to be used as the “model” object for the `GtkRange`
+
+The adjustment indicates the current range value, the minimum and
+maximum range values, the step/page increments used for keybindings
+and scrolling, and the page size.
+
+The page size is normally 0 for `GtkScale` and nonzero for `GtkScrollbar`,
+and indicates the size of the visible area of the widget being scrolled.
The page size affects the size of the scrollbar slider.
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
</parameters>
@@ -60533,18 +63994,18 @@ be the position up to which the file/stream has been downloaded.
This amount of prebuffering can be displayed on the range’s trough
and is themeable separately from the trough. To enable fill level
-display, use gtk_range_set_show_fill_level(). The range defaults
+display, use [method@Gtk.Range.set_show_fill_level]. The range defaults
to not showing the fill level.
Additionally, it’s possible to restrict the range’s slider position
-to values which are smaller than the fill level. This is controller
-by gtk_range_set_restrict_to_fill_level() and is by default
+to values which are smaller than the fill level. This is controlled
+by [method@Gtk.Range.set_restrict_to_fill_level] and is by default
enabled.
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
<parameter name="fill_level">
@@ -60557,15 +64018,17 @@ enabled.
<function name="gtk_range_set_flippable">
<description>
-If a range is flippable, it will switch its direction if it is
-horizontal and its direction is %GTK_TEXT_DIR_RTL.
+Sets whether the `GtkRange` respects text direction.
+
+If a range is flippable, it will switch its direction
+if it is horizontal and its direction is %GTK_TEXT_DIR_RTL.
-See gtk_widget_get_direction().
+See [method@Gtk.Widget.get_direction].
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
<parameter name="flippable">
@@ -60579,14 +64042,15 @@ See gtk_widget_get_direction().
<function name="gtk_range_set_increments">
<description>
Sets the step and page sizes for the range.
-The step size is used when the user clicks the #GtkScrollbar
-arrows or moves #GtkScale via arrow keys. The page size
+
+The step size is used when the user clicks the `GtkScrollbar`
+arrows or moves a `GtkScale` via arrow keys. The page size
is used for example when moving via Page Up or Page Down keys.
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
<parameter name="step">
@@ -60603,15 +64067,17 @@ is used for example when moving via Page Up or Page Down keys.
<function name="gtk_range_set_inverted">
<description>
+Sets whether to invert the range.
+
Ranges normally move from lower to higher values as the
slider moves from top to bottom or left to right. Inverted
-ranges have higher values at the top or on the right rather than
-on the bottom or left.
+ranges have higher values at the top or on the right rather
+than on the bottom or left.
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -60624,14 +64090,16 @@ on the bottom or left.
<function name="gtk_range_set_range">
<description>
-Sets the allowable values in the #GtkRange, and clamps the range
-value to be between @min and @max. (If the range has a non-zero
-page size, it is clamped between @min and @max - page-size.)
+Sets the allowable values in the `GtkRange`.
+
+The range value is clamped to be between @min and @max.
+(If the range has a non-zero page size, it is clamped
+between @min and @max - page-size.)
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
<parameter name="min">
@@ -60648,14 +64116,15 @@ page size, it is clamped between @min and @max - page-size.)
<function name="gtk_range_set_restrict_to_fill_level">
<description>
-Sets whether the slider is restricted to the fill level. See
-gtk_range_set_fill_level() for a general description of the fill
-level concept.
+Sets whether the slider is restricted to the fill level.
+
+See [method@Gtk.Range.set_fill_level] for a general description
+of the fill level concept.
</description>
<parameters>
<parameter name="range">
-<parameter_description> A #GtkRange
+<parameter_description> A `GtkRange`
</parameter_description>
</parameter>
<parameter name="restrict_to_fill_level">
@@ -60669,12 +64138,14 @@ level concept.
<function name="gtk_range_set_round_digits">
<description>
Sets the number of digits to round the value to when
-it changes. See #GtkRange::change-value.
+it changes.
+
+See [signal@Gtk.Range::change-value].
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
<parameter name="round_digits">
@@ -60687,14 +64158,15 @@ it changes. See #GtkRange::change-value.
<function name="gtk_range_set_show_fill_level">
<description>
-Sets whether a graphical fill level is show on the trough. See
-gtk_range_set_fill_level() for a general description of the fill
-level concept.
+Sets whether a graphical fill level is show on the trough.
+
+See [method@Gtk.Range.set_fill_level] for a general description
+of the fill level concept.
</description>
<parameters>
<parameter name="range">
-<parameter_description> A #GtkRange
+<parameter_description> A `GtkRange`
</parameter_description>
</parameter>
<parameter name="show_fill_level">
@@ -60710,12 +64182,12 @@ level concept.
Sets whether the range’s slider has a fixed size, or a size that
depends on its adjustment’s page size.
-This function is useful mainly for #GtkRange subclasses.
+This function is useful mainly for `GtkRange` subclasses.
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
<parameter name="size_fixed">
@@ -60728,15 +64200,16 @@ This function is useful mainly for #GtkRange subclasses.
<function name="gtk_range_set_value">
<description>
-Sets the current value of the range; if the value is outside the
-minimum or maximum range values, it will be clamped to fit inside
-them. The range emits the #GtkRange::value-changed signal if the
-value changes.
+Sets the current value of the range.
+
+If the value is outside the minimum or maximum range values,
+it will be clamped to fit inside them. The range emits the
+[signal@Gtk.Range::value-changed] signal if the value changes.
</description>
<parameters>
<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter_description> a `GtkRange`
</parameter_description>
</parameter>
<parameter name="value">
@@ -60749,18 +64222,18 @@ value changes.
<function name="gtk_recent_info_create_app_info">
<description>
-Creates a #GAppInfo for the specified #GtkRecentInfo
+Creates a `GAppInfo` for the specified `GtkRecentInfo`
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
<parameter name="app_name">
<parameter_description> the name of the application that should
-be mapped to a #GAppInfo; if %NULL is used then the default
+be mapped to a `GAppInfo`; if %NULL is used then the default
application for the MIME type is used
</parameter_description>
</parameter>
@@ -60769,8 +64242,8 @@ application for the MIME type is used
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GAppInfo, or %NULL.
-In case of error, @error will be set either with a
+<return> the newly created `GAppInfo`,
+or %NULL. In case of error, @error will be set either with a
%GTK_RECENT_MANAGER_ERROR or a %G_IO_ERROR
</return>
</function>
@@ -60785,7 +64258,7 @@ to local files.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -60802,7 +64275,7 @@ was added to the recently used resources list.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -60820,7 +64293,7 @@ of the resource pointed by @info.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -60841,7 +64314,7 @@ storage specification, they will be expanded.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
<parameter name="app_name">
@@ -60865,7 +64338,7 @@ registered for this application
</parameters>
<return> %TRUE if an application with @app_name has registered this
resource inside the recently used list, or %FALSE otherwise. The
-@app_exec string is owned by the #GtkRecentInfo and should not be
+@app_exec string is owned by the `GtkRecentInfo` and should not be
modified or freed
</return>
</function>
@@ -60878,7 +64351,7 @@ Retrieves the list of applications that have registered this resource.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
<parameter name="length">
@@ -60886,9 +64359,8 @@ Retrieves the list of applications that have registered this resource.
</parameter_description>
</parameter>
</parameters>
-<return>
-a newly allocated %NULL-terminated array of strings.
-Use g_strfreev() to free it.
+<return> a newly
+allocated %NULL-terminated array of strings. Use g_strfreev() to free it.
</return>
</function>
@@ -60900,7 +64372,7 @@ Gets the (short) description of the resource.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -60911,14 +64383,16 @@ is owned by the recent manager, and should not be freed.
<function name="gtk_recent_info_get_display_name">
<description>
-Gets the name of the resource. If none has been defined, the basename
+Gets the name of the resource.
+
+If none has been defined, the basename
of the resource is obtained.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -60935,7 +64409,7 @@ Retrieves the icon associated to the resource MIME type.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -60947,6 +64421,7 @@ Use g_object_unref() when finished using the icon
<function name="gtk_recent_info_get_groups">
<description>
Returns all groups registered for the recently used item @info.
+
The array of returned group names will be %NULL terminated, so
length might optionally be %NULL.
@@ -60954,7 +64429,7 @@ length might optionally be %NULL.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
<parameter name="length">
@@ -60976,7 +64451,7 @@ Gets the MIME type of the resource.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -60994,7 +64469,7 @@ for the resource was last modified.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -61005,15 +64480,17 @@ when the resource was last modified
<function name="gtk_recent_info_get_private_hint">
<description>
-Gets the value of the “private” flag. Resources in the recently used
-list that have this flag set to %TRUE should only be displayed by the
-applications that have registered them.
+Gets the value of the “private” flag.
+
+Resources in the recently used list that have this flag
+set to %TRUE should only be displayed by the applications
+that have registered them.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -61024,15 +64501,16 @@ applications that have registered them.
<function name="gtk_recent_info_get_short_name">
<description>
Computes a valid UTF-8 string that can be used as the
-name of the item in a menu or list. For example, calling
-this function on an item that refers to
-“file:///foo/bar.txt” will yield “bar.txt”.
+name of the item in a menu or list.
+
+For example, calling this function on an item that refers
+to “file:///foo/bar.txt” will yield “bar.txt”.
</description>
<parameters>
<parameter name="info">
-<parameter_description> an #GtkRecentInfo
+<parameter_description> an `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -61049,7 +64527,7 @@ Gets the URI of the resource.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `tkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -61060,15 +64538,17 @@ owned by the recent manager, and should not be freed.
<function name="gtk_recent_info_get_uri_display">
<description>
-Gets a displayable version of the resource’s URI. If the resource
-is local, it returns a local path; if the resource is not local,
-it returns the UTF-8 encoded content of gtk_recent_info_get_uri().
+Gets a displayable version of the resource’s URI.
+
+If the resource is local, it returns a local path; if the
+resource is not local, it returns the UTF-8 encoded content
+of [method@Gtk.RecentInfo.get_uri].
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -61086,7 +64566,7 @@ for the resource was last visited.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -61103,7 +64583,7 @@ Checks whether an application registered this resource using @app_name.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
<parameter name="app_name">
@@ -61125,7 +64605,7 @@ registered for the recently used item @info.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
<parameter name="group_name">
@@ -61146,7 +64626,7 @@ scheme of its URI.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -61163,7 +64643,7 @@ recently used resource represented by @info.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -61173,21 +64653,21 @@ recently used resource represented by @info.
<function name="gtk_recent_info_match">
<description>
-Checks whether two #GtkRecentInfo point to the same resource.
+Checks whether two `GtkRecentInfo` point to the same resource.
</description>
<parameters>
<parameter name="info_a">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
<parameter name="info_b">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if both #GtkRecentInfo point to the same
+<return> %TRUE if both `GtkRecentInfo` point to the same
resource, %FALSE otherwise
</return>
</function>
@@ -61200,7 +64680,7 @@ Increases the reference count of @recent_info by one.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -61211,13 +64691,15 @@ increased by one
<function name="gtk_recent_info_unref">
<description>
-Decreases the reference count of @info by one. If the reference
-count reaches zero, @info is deallocated, and the memory freed.
+Decreases the reference count of @info by one.
+
+If the reference count reaches zero, @info is
+deallocated, and the memory freed.
</description>
<parameters>
<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter_description> a `GtkRecentInfo`
</parameter_description>
</parameter>
</parameters>
@@ -61228,19 +64710,19 @@ count reaches zero, @info is deallocated, and the memory freed.
<description>
Adds a new resource, pointed by @uri, into the recently used
resources list, using the metadata specified inside the
-#GtkRecentData passed in @recent_data.
+`GtkRecentData` passed in @recent_data.
The passed URI will be used to identify this resource inside the
list.
In order to register the new recently used resource, metadata about
the resource must be passed as well as the URI; the metadata is
-stored in a #GtkRecentData, which must contain the MIME
+stored in a `GtkRecentData`, which must contain the MIME
type of the resource pointed by the URI; the name of the application
that is registering the item, and a command line to be used when
launching the item.
-Optionally, a #GtkRecentData might contain a UTF-8 string
+Optionally, a `GtkRecentData` might contain a UTF-8 string
to be used when viewing the item instead of the last component of
the URI; a short description of the item; whether the item should
be considered private - that is, should be displayed only by the
@@ -61250,7 +64732,7 @@ applications that have registered it.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GtkRecentManager
+<parameter_description> a `GtkRecentManager`
</parameter_description>
</parameter>
<parameter name="uri">
@@ -61274,16 +64756,16 @@ resources list.
This function automatically retrieves some of the needed
metadata and setting other metadata to common default values;
-it then feeds the data to gtk_recent_manager_add_full().
+it then feeds the data to [method@Gtk.RecentManager.add_full].
-See gtk_recent_manager_add_full() if you want to explicitly
+See [method@Gtk.RecentManager.add_full] if you want to explicitly
define the metadata for the resource pointed by @uri.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GtkRecentManager
+<parameter_description> a `GtkRecentManager`
</parameter_description>
</parameter>
<parameter name="uri">
@@ -61298,14 +64780,14 @@ to the recently used resources list
<function name="gtk_recent_manager_get_default">
<description>
-Gets a unique instance of #GtkRecentManager, that you can share
+Gets a unique instance of `GtkRecentManager` that you can share
in your application without caring about memory management.
</description>
<parameters>
</parameters>
-<return> A unique #GtkRecentManager. Do not ref or
+<return> A unique `GtkRecentManager`. Do not ref or
unref it.
</return>
</function>
@@ -61318,13 +64800,13 @@ Gets the list of recently used resources.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GtkRecentManager
+<parameter_description> a `GtkRecentManager`
</parameter_description>
</parameter>
</parameters>
<return> a list of
-newly allocated #GtkRecentInfo objects. Use
-gtk_recent_info_unref() on each item inside the list, and then
+newly allocated `GtkRecentInfo objects`. Use
+[method@Gtk.RecentInfo.unref] on each item inside the list, and then
free the list itself using g_list_free().
</return>
</function>
@@ -61338,7 +64820,7 @@ with @uri inside the recent manager.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GtkRecentManager
+<parameter_description> a `GtkRecentManager`
</parameter_description>
</parameter>
<parameter name="uri">
@@ -61353,14 +64835,14 @@ with @uri inside the recent manager.
<function name="gtk_recent_manager_lookup_item">
<description>
Searches for a URI inside the recently used resources list, and
-returns a #GtkRecentInfo containing information about the resource
+returns a `GtkRecentInfo` containing information about the resource
like its MIME type, or its display name.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GtkRecentManager
+<parameter_description> a `GtkRecentManager`
</parameter_description>
</parameter>
<parameter name="uri">
@@ -61372,10 +64854,10 @@ like its MIME type, or its display name.
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkRecentInfo containing information
+<return> a `GtkRecentInfo` containing information
about the resource pointed by @uri, or %NULL if the URI was
not registered in the recently used resources list. Free with
-gtk_recent_info_unref().
+[method@Gtk.RecentInfo.unref].
</return>
</function>
@@ -61390,7 +64872,7 @@ by the URIs, but only the URI used in the recently used resources list.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GtkRecentManager
+<parameter_description> a `GtkRecentManager`
</parameter_description>
</parameter>
<parameter name="uri">
@@ -61413,19 +64895,22 @@ by the URIs, but only the URI used in the recently used resources list.
<function name="gtk_recent_manager_new">
<description>
-Creates a new recent manager object. Recent manager objects are used to
-handle the list of recently used resources. A #GtkRecentManager object
-monitors the recently used resources list, and emits the “changed” signal
-each time something inside the list changes.
+Creates a new recent manager object.
-#GtkRecentManager objects are expensive: be sure to create them only when
-needed. You should use gtk_recent_manager_get_default() instead.
+Recent manager objects are used to handle the list of recently used
+resources. A `GtkRecentManager` object monitors the recently used
+resources list, and emits the [signal@Gtk.RecentManager::changed]
+signal each time something inside the list changes.
+
+`GtkRecentManager` objects are expensive: be sure to create them
+only when needed. You should use [type_func@Gtk.RecentManager.get_default]
+instead.
</description>
<parameters>
</parameters>
-<return> A newly created #GtkRecentManager object
+<return> A newly created `GtkRecentManager` object
</return>
</function>
@@ -61437,7 +64922,7 @@ Purges every item from the recently used resources list.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GtkRecentManager
+<parameter_description> a `GtkRecentManager`
</parameter_description>
</parameter>
<parameter name="error">
@@ -61459,7 +64944,7 @@ list handled by a recent manager.
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #GtkRecentManager
+<parameter_description> a `GtkRecentManager`
</parameter_description>
</parameter>
<parameter name="uri">
@@ -61929,13 +65414,13 @@ Typical option mark rendering:
<function name="gtk_requisition_copy">
<description>
-Copies a #GtkRequisition.
+Copies a `GtkRequisition`.
</description>
<parameters>
<parameter name="requisition">
-<parameter_description> a #GtkRequisition
+<parameter_description> a `GtkRequisition`
</parameter_description>
</parameter>
</parameters>
@@ -61945,12 +65430,12 @@ Copies a #GtkRequisition.
<function name="gtk_requisition_free">
<description>
-Frees a #GtkRequisition.
+Frees a `GtkRequisition`.
</description>
<parameters>
<parameter name="requisition">
-<parameter_description> a #GtkRequisition
+<parameter_description> a `GtkRequisition`
</parameter_description>
</parameter>
</parameters>
@@ -61959,14 +65444,17 @@ Frees a #GtkRequisition.
<function name="gtk_requisition_new">
<description>
-Allocates a new #GtkRequisition-struct and initializes its elements to zero.
+Allocates a new `GtkRequisition`.
+
+The struct is initialized to zero.
</description>
<parameters>
</parameters>
-<return> a new empty #GtkRequisition. The newly allocated #GtkRequisition should
-be freed with gtk_requisition_free().
+<return> a new empty `GtkRequisition`. The newly
+allocated `GtkRequisition` should be freed with
+[method Gtk Requisition free]
</return>
</function>
@@ -61978,7 +65466,7 @@ Gets the child widget of @revealer.
</description>
<parameters>
<parameter name="revealer">
-<parameter_description> a #GtkRevealer
+<parameter_description> a `GtkRevealer`
</parameter_description>
</parameter>
</parameters>
@@ -61988,14 +65476,16 @@ Gets the child widget of @revealer.
<function name="gtk_revealer_get_child_revealed">
<description>
-Returns whether the child is fully revealed, in other words whether
-the transition to the revealed state is completed.
+Returns whether the child is fully revealed.
+
+In other words, this returns whether the transition
+to the revealed state is completed.
</description>
<parameters>
<parameter name="revealer">
-<parameter_description> a #GtkRevealer
+<parameter_description> a `GtkRevealer`
</parameter_description>
</parameter>
</parameters>
@@ -62005,19 +65495,18 @@ the transition to the revealed state is completed.
<function name="gtk_revealer_get_reveal_child">
<description>
-Returns whether the child is currently
-revealed. See gtk_revealer_set_reveal_child().
+Returns whether the child is currently revealed.
This function returns %TRUE as soon as the transition
is to the revealed state is started. To learn whether
the child is fully revealed (ie the transition is completed),
-use gtk_revealer_get_child_revealed().
+use [method@Gtk.Revealer.get_child_revealed].
</description>
<parameters>
<parameter name="revealer">
-<parameter_description> a #GtkRevealer
+<parameter_description> a `GtkRevealer`
</parameter_description>
</parameter>
</parameters>
@@ -62034,7 +65523,7 @@ transitions will take.
</description>
<parameters>
<parameter name="revealer">
-<parameter_description> a #GtkRevealer
+<parameter_description> a `GtkRevealer`
</parameter_description>
</parameter>
</parameters>
@@ -62051,7 +65540,7 @@ for transitions in @revealer.
</description>
<parameters>
<parameter name="revealer">
-<parameter_description> a #GtkRevealer
+<parameter_description> a `GtkRevealer`
</parameter_description>
</parameter>
</parameters>
@@ -62061,13 +65550,13 @@ for transitions in @revealer.
<function name="gtk_revealer_new">
<description>
-Creates a new #GtkRevealer.
+Creates a new `GtkRevealer`.
</description>
<parameters>
</parameters>
-<return> a newly created #GtkRevealer
+<return> a newly created `GtkRevealer`
</return>
</function>
@@ -62078,7 +65567,7 @@ Sets the child widget of @revealer.
</description>
<parameters>
<parameter name="revealer">
-<parameter_description> a #GtkRevealer
+<parameter_description> a `GtkRevealer`
</parameter_description>
</parameter>
<parameter name="child">
@@ -62091,7 +65580,7 @@ Sets the child widget of @revealer.
<function name="gtk_revealer_set_reveal_child">
<description>
-Tells the #GtkRevealer to reveal or conceal its child.
+Tells the `GtkRevealer` to reveal or conceal its child.
The transition will be animated with the current
transition type of @revealer.
@@ -62099,7 +65588,7 @@ transition type of @revealer.
</description>
<parameters>
<parameter name="revealer">
-<parameter_description> a #GtkRevealer
+<parameter_description> a `GtkRevealer`
</parameter_description>
</parameter>
<parameter name="reveal_child">
@@ -62117,7 +65606,7 @@ Sets the duration that transitions will take.
</description>
<parameters>
<parameter name="revealer">
-<parameter_description> a #GtkRevealer
+<parameter_description> a `GtkRevealer`
</parameter_description>
</parameter>
<parameter name="duration">
@@ -62131,13 +65620,14 @@ Sets the duration that transitions will take.
<function name="gtk_revealer_set_transition_type">
<description>
Sets the type of animation that will be used for
-transitions in @revealer. Available types include
-various kinds of fades and slides.
+transitions in @revealer.
+
+Available types include various kinds of fades and slides.
</description>
<parameters>
<parameter name="revealer">
-<parameter_description> a #GtkRevealer
+<parameter_description> a `GtkRevealer`
</parameter_description>
</parameter>
<parameter name="transition">
@@ -62187,13 +65677,13 @@ output values will be in the same range.
<function name="gtk_root_get_display">
<description>
-Returns the display that this GtkRoot is on.
+Returns the display that this `GtkRoot` is on.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkRoot
+<parameter_description> a `GtkRoot`
</parameter_description>
</parameter>
</parameters>
@@ -62214,28 +65704,30 @@ widget.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkRoot
+<parameter_description> a `GtkRoot`
</parameter_description>
</parameter>
</parameters>
-<return> the currently focused widget,
-or %NULL if there is none.
+<return> the currently focused
+widget, or %NULL if there is none.
</return>
</function>
<function name="gtk_root_set_focus">
<description>
If @focus is not the current focus widget, and is focusable, sets
-it as the focus widget for the root. If @focus is %NULL, unsets
-the focus widget for the root.
+it as the focus widget for the root.
+
+If @focus is %NULL, unsets the focus widget for the root.
To set the focus to a particular widget in the root, it is usually
-more convenient to use gtk_widget_grab_focus() instead of this function.
+more convenient to use [method@Gtk.Widget.grab_focus] instead of
+this function.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkRoot
+<parameter_description> a `GtkRoot`
</parameter_description>
</parameter>
<parameter name="focus">
@@ -62257,12 +65749,12 @@ marks value.
If @markup is not %NULL, text is shown next to the tick mark.
-To remove marks from a scale, use gtk_scale_clear_marks().
+To remove marks from a scale, use [method@Gtk.Scale.clear_marks].
</description>
<parameters>
<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter_description> a `GtkScale`
</parameter_description>
</parameter>
<parameter name="value">
@@ -62278,7 +65770,8 @@ the left of the scale, anything else to the right.
</parameter_description>
</parameter>
<parameter name="markup">
-<parameter_description> Text to be shown at the mark, using [Pango markup][PangoMarkupFormat], or %NULL
+<parameter_description> Text to be shown at the mark, using
+Pango markup, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -62287,14 +65780,15 @@ the left of the scale, anything else to the right.
<function name="gtk_scale_button_get_adjustment">
<description>
-Gets the #GtkAdjustment associated with the #GtkScaleButton’s scale.
-See gtk_range_get_adjustment() for details.
+Gets the `GtkAdjustment` associated with the `GtkScaleButton`’s scale.
+
+See [method@Gtk.Range.get_adjustment] for details.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkScaleButton
+<parameter_description> a `GtkScaleButton`
</parameter_description>
</parameter>
</parameters>
@@ -62304,49 +65798,51 @@ See gtk_range_get_adjustment() for details.
<function name="gtk_scale_button_get_minus_button">
<description>
-Retrieves the minus button of the #GtkScaleButton.
+Retrieves the minus button of the `GtkScaleButton`.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkScaleButton
+<parameter_description> a `GtkScaleButton`
</parameter_description>
</parameter>
</parameters>
-<return> the minus button of the #GtkScaleButton as a #GtkButton
+<return> the minus button
+of the `GtkScaleButton`
</return>
</function>
<function name="gtk_scale_button_get_plus_button">
<description>
-Retrieves the plus button of the #GtkScaleButton.
+Retrieves the plus button of the `GtkScaleButton.`
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkScaleButton
+<parameter_description> a `GtkScaleButton`
</parameter_description>
</parameter>
</parameters>
-<return> the plus button of the #GtkScaleButton as a #GtkButton
+<return> the plus button
+of the `GtkScaleButton`
</return>
</function>
<function name="gtk_scale_button_get_popup">
<description>
-Retrieves the popup of the #GtkScaleButton.
+Retrieves the popup of the `GtkScaleButton`.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkScaleButton
+<parameter_description> a `GtkScaleButton`
</parameter_description>
</parameter>
</parameters>
-<return> the popup of the #GtkScaleButton
+<return> the popup of the `GtkScaleButton`
</return>
</function>
@@ -62358,7 +65854,7 @@ Gets the current value of the scale button.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkScaleButton
+<parameter_description> a `GtkScaleButton`
</parameter_description>
</parameter>
</parameters>
@@ -62368,8 +65864,10 @@ Gets the current value of the scale button.
<function name="gtk_scale_button_new">
<description>
-Creates a #GtkScaleButton, with a range between @min and @max, with
-a stepping of @step.
+Creates a `GtkScaleButton`.
+
+The new scale button has a range between @min and @max,
+with a stepping of @step.
</description>
@@ -62394,24 +65892,25 @@ later with gtk_scale_button_set_icons()
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkScaleButton
+<return> a new `GtkScaleButton`
</return>
</function>
<function name="gtk_scale_button_set_adjustment">
<description>
-Sets the #GtkAdjustment to be used as a model
-for the #GtkScaleButton’s scale.
-See gtk_range_set_adjustment() for details.
+Sets the `GtkAdjustment` to be used as a model
+for the `GtkScaleButton`’s scale.
+
+See [method@Gtk.Range.set_adjustment] for details.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkScaleButton
+<parameter_description> a `GtkScaleButton`
</parameter_description>
</parameter>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
</parameters>
@@ -62421,12 +65920,11 @@ See gtk_range_set_adjustment() for details.
<function name="gtk_scale_button_set_icons">
<description>
Sets the icons to be used by the scale button.
-For details, see the #GtkScaleButton:icons property.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkScaleButton
+<parameter_description> a `GtkScaleButton`
</parameter_description>
</parameter>
<parameter name="icons">
@@ -62439,15 +65937,18 @@ For details, see the #GtkScaleButton:icons property.
<function name="gtk_scale_button_set_value">
<description>
-Sets the current value of the scale; if the value is outside
-the minimum or maximum range values, it will be clamped to fit
-inside them. The scale button emits the #GtkScaleButton::value-changed
+Sets the current value of the scale.
+
+If the value is outside the minimum or maximum range values,
+it will be clamped to fit inside them.
+
+The scale button emits the [signal@Gtk.ScaleButton::value-changed]
signal if the value changes.
</description>
<parameters>
<parameter name="button">
-<parameter_description> a #GtkScaleButton
+<parameter_description> a `GtkScaleButton`
</parameter_description>
</parameter>
<parameter name="value">
@@ -62460,12 +65961,12 @@ signal if the value changes.
<function name="gtk_scale_clear_marks">
<description>
-Removes any marks that have been added with gtk_scale_add_mark().
+Removes any marks that have been added.
</description>
<parameters>
<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter_description> a `GtkScale`
</parameter_description>
</parameter>
</parameters>
@@ -62480,7 +65981,7 @@ Gets the number of decimal places that are displayed in the value.
</description>
<parameters>
<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter_description> a `GtkScale`
</parameter_description>
</parameter>
</parameters>
@@ -62490,14 +65991,14 @@ Gets the number of decimal places that are displayed in the value.
<function name="gtk_scale_get_draw_value">
<description>
-Returns whether the current value is displayed as a string
+Returns whether the current value is displayed as a string
next to the slider.
</description>
<parameters>
<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter_description> a `GtkScale`
</parameter_description>
</parameter>
</parameters>
@@ -62513,7 +66014,7 @@ Returns whether the scale has an origin.
</description>
<parameters>
<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter_description> a `GtkScale`
</parameter_description>
</parameter>
</parameters>
@@ -62523,31 +66024,34 @@ Returns whether the scale has an origin.
<function name="gtk_scale_get_layout">
<description>
-Gets the #PangoLayout used to display the scale. The returned
-object is owned by the scale so does not need to be freed by
-the caller.
+Gets the `PangoLayout` used to display the scale.
+
+The returned object is owned by the scale so does not need
+to be freed by the caller.
</description>
<parameters>
<parameter name="scale">
-<parameter_description> A #GtkScale
+<parameter_description> A `GtkScale`
</parameter_description>
</parameter>
</parameters>
-<return> the #PangoLayout for this scale,
-or %NULL if the #GtkScale:draw-value property is %FALSE.
+<return> the [class@Pango.Layout]
+for this scale, or %NULL if the [property@GtkScale:draw-value]
+property is %FALSE.
</return>
</function>
<function name="gtk_scale_get_layout_offsets">
<description>
-Obtains the coordinates where the scale will draw the
-#PangoLayout representing the text in the scale. Remember
-when using the #PangoLayout function you need to convert to
-and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
+Obtains the coordinates where the scale will draw the
+`PangoLayout` representing the text in the scale.
-If the #GtkScale:draw-value property is %FALSE, the return
+Remember when using the `PangoLayout` function you need to
+convert to and from pixels using `PANGO_PIXELS()` or `PANGO_SCALE`.
+
+If the [property@GtkScale:draw-value] property is %FALSE, the return
values are undefined.
</description>
@@ -62576,7 +66080,7 @@ Gets the position in which the current value is displayed.
</description>
<parameters>
<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter_description> a `GtkScale`
</parameter_description>
</parameter>
</parameters>
@@ -62586,7 +66090,7 @@ Gets the position in which the current value is displayed.
<function name="gtk_scale_new">
<description>
-Creates a new #GtkScale.
+Creates a new `GtkScale`.
</description>
@@ -62596,26 +66100,28 @@ Creates a new #GtkScale.
</parameter_description>
</parameter>
<parameter name="adjustment">
-<parameter_description> the #GtkAdjustment which sets the range
-of the scale, or %NULL to create a new adjustment.
+<parameter_description> the [class@Gtk.Adjustment] which sets
+the range of the scale, or %NULL to create a new adjustment.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkScale
+<return> a new `GtkScale`
</return>
</function>
<function name="gtk_scale_new_with_range">
<description>
-Creates a new scale widget with the given orientation that lets the
+Creates a new scale widget with a range from @min to @max.
+
+The returns scale will have the given orientation and will let the
user input a number between @min and @max (including @min and @max)
-with the increment @step. @step must be nonzero; it’s the distance
+with the increment @step. @step must be nonzero; it’s the distance
the slider moves when using the arrow keys to adjust the scale
value.
-Note that the way in which the precision is derived works best if @step
-is a power of ten. If the resulting precision is not suitable for your
-needs, use gtk_scale_set_digits() to correct it.
+Note that the way in which the precision is derived works best if
+@step is a power of ten. If the resulting precision is not suitable
+for your needs, use [method@Gtk.Scale.set_digits] to correct it.
</description>
@@ -62643,21 +66149,23 @@ needs, use gtk_scale_set_digits() to correct it.
<function name="gtk_scale_set_digits">
<description>
-Sets the number of decimal places that are displayed in the value. Also
-causes the value of the adjustment to be rounded to this number of digits,
-so the retrieved value matches the displayed one, if #GtkScale:draw-value is
-%TRUE when the value changes. If you want to enforce rounding the value when
-#GtkScale:draw-value is %FALSE, you can set #GtkRange:round-digits instead.
+Sets the number of decimal places that are displayed in the value.
+
+Also causes the value of the adjustment to be rounded to this number
+of digits, so the retrieved value matches the displayed one, if
+[property@GtkScale:draw-value] is %TRUE when the value changes. If
+you want to enforce rounding the value when [property@GtkScale:draw-value]
+is %FALSE, you can set [property@GtkRange:round-digits] instead.
Note that rounding to a small number of digits can interfere with
-the smooth autoscrolling that is built into #GtkScale. As an alternative,
-you can use gtk_scale_set_format_value_func() to format the displayed
+the smooth autoscrolling that is built into `GtkScale`. As an alternative,
+you can use [method@Gtk.Scale.set_format_value_func] to format the displayed
value yourself.
</description>
<parameters>
<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter_description> a `GtkScale`
</parameter_description>
</parameter>
<parameter name="digits">
@@ -62671,7 +66179,7 @@ e.g. use 1 to display 1.0, 2 to display 1.00, etc
<function name="gtk_scale_set_draw_value">
<description>
-Specifies whether the current value is displayed as a string next
+Specifies whether the current value is displayed as a string next
to the slider.
</description>
@@ -62690,17 +66198,19 @@ to the slider.
<function name="gtk_scale_set_format_value_func">
<description>
-@func allows you to change how the scale value is displayed. The given
-function will return an allocated string representing @value.
-That string will then be used to display the scale's value.
+@func allows you to change how the scale value is displayed.
+
+The given function will return an allocated string representing
+@value. That string will then be used to display the scale's value.
If #NULL is passed as @func, the value will be displayed on
-its own, rounded according to the value of the #GtkScale:digits property.
+its own, rounded according to the value of the
+[property@GtkScale:digits] property.
</description>
<parameters>
<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter_description> a `GtkScale`
</parameter_description>
</parameter>
<parameter name="func">
@@ -62721,14 +66231,16 @@ its own, rounded according to the value of the #GtkScale:digits property.
<function name="gtk_scale_set_has_origin">
<description>
-If #GtkScale:has-origin is set to %TRUE (the default), the scale will
-highlight the part of the trough between the origin (bottom or left side)
-and the current value.
+Sets whether the scale has an origin.
+
+If [property@GtkScale:has-origin] is set to %TRUE (the default),
+the scale will highlight the part of the trough between the origin
+(bottom or left side) and the current value.
</description>
<parameters>
<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter_description> a `GtkScale`
</parameter_description>
</parameter>
<parameter name="has_origin">
@@ -62746,7 +66258,7 @@ Sets the position in which the current value is displayed.
</description>
<parameters>
<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter_description> a `GtkScale`
</parameter_description>
</parameter>
<parameter name="pos">
@@ -62760,16 +66272,17 @@ Sets the position in which the current value is displayed.
<function name="gtk_scrollable_get_border">
<description>
Returns the size of a non-scrolling border around the
-outside of the scrollable. An example for this would
-be treeview headers. GTK can use this information to
-display overlaid graphics, like the overshoot indication,
-at the right position.
+outside of the scrollable.
+
+An example for this would be treeview headers. GTK can use
+this information to display overlaid graphics, like the
+overshoot indication, at the right position.
</description>
<parameters>
<parameter name="scrollable">
-<parameter_description> a #GtkScrollable
+<parameter_description> a `GtkScrollable`
</parameter_description>
</parameter>
<parameter name="border">
@@ -62783,80 +66296,80 @@ at the right position.
<function name="gtk_scrollable_get_hadjustment">
<description>
-Retrieves the #GtkAdjustment used for horizontal scrolling.
+Retrieves the `GtkAdjustment` used for horizontal scrolling.
</description>
<parameters>
<parameter name="scrollable">
-<parameter_description> a #GtkScrollable
+<parameter_description> a `GtkScrollable`
</parameter_description>
</parameter>
</parameters>
-<return> horizontal #GtkAdjustment.
+<return> horizontal `GtkAdjustment`.
</return>
</function>
<function name="gtk_scrollable_get_hscroll_policy">
<description>
-Gets the horizontal #GtkScrollablePolicy.
+Gets the horizontal `GtkScrollablePolicy`.
</description>
<parameters>
<parameter name="scrollable">
-<parameter_description> a #GtkScrollable
+<parameter_description> a `GtkScrollable`
</parameter_description>
</parameter>
</parameters>
-<return> The horizontal #GtkScrollablePolicy.
+<return> The horizontal `GtkScrollablePolicy`.
</return>
</function>
<function name="gtk_scrollable_get_vadjustment">
<description>
-Retrieves the #GtkAdjustment used for vertical scrolling.
+Retrieves the `GtkAdjustment` used for vertical scrolling.
</description>
<parameters>
<parameter name="scrollable">
-<parameter_description> a #GtkScrollable
+<parameter_description> a `GtkScrollable`
</parameter_description>
</parameter>
</parameters>
-<return> vertical #GtkAdjustment.
+<return> vertical `GtkAdjustment`.
</return>
</function>
<function name="gtk_scrollable_get_vscroll_policy">
<description>
-Gets the vertical #GtkScrollablePolicy.
+Gets the vertical `GtkScrollablePolicy`.
</description>
<parameters>
<parameter name="scrollable">
-<parameter_description> a #GtkScrollable
+<parameter_description> a `GtkScrollable`
</parameter_description>
</parameter>
</parameters>
-<return> The vertical #GtkScrollablePolicy.
+<return> The vertical `GtkScrollablePolicy`.
</return>
</function>
<function name="gtk_scrollable_set_hadjustment">
<description>
-Sets the horizontal adjustment of the #GtkScrollable.
+Sets the horizontal adjustment of the `GtkScrollable`.
</description>
<parameters>
<parameter name="scrollable">
-<parameter_description> a #GtkScrollable
+<parameter_description> a `GtkScrollable`
</parameter_description>
</parameter>
<parameter name="hadjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
</parameters>
@@ -62865,18 +66378,19 @@ Sets the horizontal adjustment of the #GtkScrollable.
<function name="gtk_scrollable_set_hscroll_policy">
<description>
-Sets the #GtkScrollablePolicy to determine whether
-horizontal scrolling should start below the minimum width or
-below the natural width.
+Sets the `GtkScrollablePolicy`.
+
+The policy determines whether horizontal scrolling should start
+below the minimum width or below the natural width.
</description>
<parameters>
<parameter name="scrollable">
-<parameter_description> a #GtkScrollable
+<parameter_description> a `GtkScrollable`
</parameter_description>
</parameter>
<parameter name="policy">
-<parameter_description> the horizontal #GtkScrollablePolicy
+<parameter_description> the horizontal `GtkScrollablePolicy`
</parameter_description>
</parameter>
</parameters>
@@ -62885,16 +66399,16 @@ below the natural width.
<function name="gtk_scrollable_set_vadjustment">
<description>
-Sets the vertical adjustment of the #GtkScrollable.
+Sets the vertical adjustment of the `GtkScrollable`.
</description>
<parameters>
<parameter name="scrollable">
-<parameter_description> a #GtkScrollable
+<parameter_description> a `GtkScrollable`
</parameter_description>
</parameter>
<parameter name="vadjustment">
-<parameter_description> a #GtkAdjustment
+<parameter_description> a `GtkAdjustment`
</parameter_description>
</parameter>
</parameters>
@@ -62903,18 +66417,19 @@ Sets the vertical adjustment of the #GtkScrollable.
<function name="gtk_scrollable_set_vscroll_policy">
<description>
-Sets the #GtkScrollablePolicy to determine whether
-vertical scrolling should start below the minimum height or
-below the natural height.
+Sets the `GtkScrollablePolicy`.
+
+The policy determines whether vertical scrolling should start
+below the minimum height or below the natural height.
</description>
<parameters>
<parameter name="scrollable">
-<parameter_description> a #GtkScrollable
+<parameter_description> a `GtkScrollable`
</parameter_description>
</parameter>
<parameter name="policy">
-<parameter_description> the vertical #GtkScrollablePolicy
+<parameter_description> the vertical `GtkScrollablePolicy`
</parameter_description>
</parameter>
</parameters>
@@ -62929,7 +66444,7 @@ Returns the scrollbar's adjustment.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkScrollbar
+<parameter_description> a `GtkScrollbar`
</parameter_description>
</parameter>
</parameters>
@@ -62949,11 +66464,12 @@ Creates a new scrollbar with the given orientation.
</parameter_description>
</parameter>
<parameter name="adjustment">
-<parameter_description> the #GtkAdjustment to use, or %NULL to create a new adjustment.
+<parameter_description> the [class@Gtk.Adjustment] to use, or %NULL
+to create a new adjustment.
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkScrollbar.
+<return> the new `GtkScrollbar`.
</return>
</function>
@@ -62964,7 +66480,7 @@ Makes the scrollbar use the given adjustment.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkScrollbar
+<parameter_description> a `GtkScrollbar`
</parameter_description>
</parameter>
<parameter name="adjustment">
@@ -62983,7 +66499,7 @@ Gets the child widget of @scrolled_window.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
</parameters>
@@ -62993,32 +66509,32 @@ Gets the child widget of @scrolled_window.
<function name="gtk_scrolled_window_get_hadjustment">
<description>
-Returns the horizontal scrollbar’s adjustment, used to connect the
-horizontal scrollbar to the child widget’s horizontal scroll
-functionality.
+Returns the horizontal scrollbar’s adjustment.
+
+This is the adjustment used to connect the horizontal scrollbar
+to the child widget’s horizontal scroll functionality.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
</parameters>
-<return> the horizontal #GtkAdjustment
+<return> the horizontal `GtkAdjustment`
</return>
</function>
<function name="gtk_scrolled_window_get_has_frame">
<description>
Gets whether the scrolled window draws a frame.
-See gtk_scrolled_window_set_has_frame().
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
</parameters>
@@ -63034,7 +66550,7 @@ Returns the horizontal scrollbar of @scrolled_window.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
</parameters>
@@ -63050,7 +66566,7 @@ Returns the specified kinetic scrolling behavior.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
</parameters>
@@ -63066,7 +66582,7 @@ Returns the maximum content height set.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
</parameters>
@@ -63082,7 +66598,7 @@ Returns the maximum content width set.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
</parameters>
@@ -63092,13 +66608,13 @@ Returns the maximum content width set.
<function name="gtk_scrolled_window_get_min_content_height">
<description>
-Gets the minimal content height of @scrolled_window, or -1 if not set.
+Gets the minimal content height of @scrolled_window.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
</parameters>
@@ -63108,13 +66624,13 @@ Gets the minimal content height of @scrolled_window, or -1 if not set.
<function name="gtk_scrolled_window_get_min_content_width">
<description>
-Gets the minimum content width of @scrolled_window, or -1 if not set.
+Gets the minimum content width of @scrolled_window.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
</parameters>
@@ -63130,7 +66646,7 @@ Returns whether overlay scrolling is enabled for this scrolled window.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
</parameters>
@@ -63140,33 +66656,31 @@ Returns whether overlay scrolling is enabled for this scrolled window.
<function name="gtk_scrolled_window_get_placement">
<description>
-Gets the placement of the contents with respect to the scrollbars
-for the scrolled window. See gtk_scrolled_window_set_placement().
+Gets the placement of the contents with respect to the scrollbars.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
</parameters>
<return> the current placement value.
-
-See also gtk_scrolled_window_set_placement() and
-gtk_scrolled_window_unset_placement().
</return>
</function>
<function name="gtk_scrolled_window_get_policy">
<description>
Retrieves the current policy values for the horizontal and vertical
-scrollbars. See gtk_scrolled_window_set_policy().
+scrollbars.
+
+See [method@Gtk.ScrolledWindow.set_policy].
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="hscrollbar_policy">
@@ -63185,14 +66699,14 @@ for the vertical scrollbar, or %NULL
<function name="gtk_scrolled_window_get_propagate_natural_height">
<description>
-Reports whether the natural height of the child will be calculated and propagated
-through the scrolled window’s requested natural height.
+Reports whether the natural height of the child will be calculated
+and propagated through the scrolled window’s requested natural height.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
</parameters>
@@ -63202,14 +66716,14 @@ through the scrolled window’s requested natural height.
<function name="gtk_scrolled_window_get_propagate_natural_width">
<description>
-Reports whether the natural width of the child will be calculated and propagated
-through the scrolled window’s requested natural width.
+Reports whether the natural width of the child will be calculated
+and propagated through the scrolled window’s requested natural width.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
</parameters>
@@ -63219,18 +66733,20 @@ through the scrolled window’s requested natural width.
<function name="gtk_scrolled_window_get_vadjustment">
<description>
-Returns the vertical scrollbar’s adjustment, used to connect the
-vertical scrollbar to the child widget’s vertical scroll functionality.
+Returns the vertical scrollbar’s adjustment.
+
+This is the adjustment used to connect the vertical
+scrollbar to the child widget’s vertical scroll functionality.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
</parameters>
-<return> the vertical #GtkAdjustment
+<return> the vertical `GtkAdjustment`
</return>
</function>
@@ -63242,7 +66758,7 @@ Returns the vertical scrollbar of @scrolled_window.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
</parameters>
@@ -63269,7 +66785,7 @@ Sets the child widget of @scrolled_window.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="child">
@@ -63282,16 +66798,16 @@ Sets the child widget of @scrolled_window.
<function name="gtk_scrolled_window_set_hadjustment">
<description>
-Sets the #GtkAdjustment for the horizontal scrollbar.
+Sets the `GtkAdjustment` for the horizontal scrollbar.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="hadjustment">
-<parameter_description> the #GtkAdjustment to use, or %NULL to create a new one
+<parameter_description> the `GtkAdjustment` to use, or %NULL to create a new one
</parameter_description>
</parameter>
</parameters>
@@ -63305,7 +66821,7 @@ Changes the frame drawn around the contents of @scrolled_window.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="has_frame">
@@ -63319,13 +66835,14 @@ Changes the frame drawn around the contents of @scrolled_window.
<function name="gtk_scrolled_window_set_kinetic_scrolling">
<description>
Turns kinetic scrolling on or off.
+
Kinetic scrolling only applies to devices with source
%GDK_SOURCE_TOUCHSCREEN.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="kinetic_scrolling">
@@ -63338,17 +66855,18 @@ Kinetic scrolling only applies to devices with source
<function name="gtk_scrolled_window_set_max_content_height">
<description>
-Sets the maximum height that @scrolled_window should keep visible. The
-@scrolled_window will grow up to this height before it starts scrolling
-the content.
+Sets the maximum height that @scrolled_window should keep visible.
+
+The @scrolled_window will grow up to this height before it starts
+scrolling the content.
It is a programming error to set the maximum content height to a value
-smaller than #GtkScrolledWindow:min-content-height.
+smaller than [property@Gtk.ScrolledWindow:min-content-height].
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="height">
@@ -63361,17 +66879,18 @@ smaller than #GtkScrolledWindow:min-content-height.
<function name="gtk_scrolled_window_set_max_content_width">
<description>
-Sets the maximum width that @scrolled_window should keep visible. The
-@scrolled_window will grow up to this width before it starts scrolling
-the content.
+Sets the maximum width that @scrolled_window should keep visible.
+
+The @scrolled_window will grow up to this width before it starts
+scrolling the content.
-It is a programming error to set the maximum content width to a value
-smaller than #GtkScrolledWindow:min-content-width.
+It is a programming error to set the maximum content width to a
+value smaller than [property@Gtk.ScrolledWindow:min-content-width].
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="width">
@@ -63385,16 +66904,17 @@ smaller than #GtkScrolledWindow:min-content-width.
<function name="gtk_scrolled_window_set_min_content_height">
<description>
Sets the minimum height that @scrolled_window should keep visible.
+
Note that this can and (usually will) be smaller than the minimum
size of the content.
It is a programming error to set the minimum content height to a
-value greater than #GtkScrolledWindow:max-content-height.
+value greater than [property@Gtk.ScrolledWindow:max-content-height].
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="height">
@@ -63408,16 +66928,17 @@ value greater than #GtkScrolledWindow:max-content-height.
<function name="gtk_scrolled_window_set_min_content_width">
<description>
Sets the minimum width that @scrolled_window should keep visible.
+
Note that this can and (usually will) be smaller than the minimum
size of the content.
It is a programming error to set the minimum content width to a
-value greater than #GtkScrolledWindow:max-content-width.
+value greater than [property@Gtk.ScrolledWindow:max-content-width].
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="width">
@@ -63435,7 +66956,7 @@ Enables or disables overlay scrolling for this scrolled window.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="overlay_scrolling">
@@ -63453,16 +66974,16 @@ for the scrolled window.
The default is %GTK_CORNER_TOP_LEFT, meaning the child is
in the top left, with the scrollbars underneath and to the right.
-Other values in #GtkCornerType are %GTK_CORNER_TOP_RIGHT,
+Other values in [enum@Gtk.CornerType] are %GTK_CORNER_TOP_RIGHT,
%GTK_CORNER_BOTTOM_LEFT, and %GTK_CORNER_BOTTOM_RIGHT.
-See also gtk_scrolled_window_get_placement() and
-gtk_scrolled_window_unset_placement().
+See also [method@Gtk.ScrolledWindow.get_placement] and
+[method@Gtk.ScrolledWindow.unset_placement].
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="window_placement">
@@ -63478,7 +66999,7 @@ gtk_scrolled_window_unset_placement().
Sets the scrollbar policy for the horizontal and vertical scrollbars.
The policy determines when the scrollbar should appear; it is a value
-from the #GtkPolicyType enumeration. If %GTK_POLICY_ALWAYS, the
+from the [enum@Gtk.PolicyType] enumeration. If %GTK_POLICY_ALWAYS, the
scrollbar is always present; if %GTK_POLICY_NEVER, the scrollbar is
never present; if %GTK_POLICY_AUTOMATIC, the scrollbar is present only
if needed (that is, if the slider part of the bar would be smaller
@@ -63487,7 +67008,7 @@ than the trough — the display is larger than the page size).
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="hscrollbar_policy">
@@ -63504,13 +67025,13 @@ than the trough — the display is larger than the page size).
<function name="gtk_scrolled_window_set_propagate_natural_height">
<description>
-Sets whether the natural height of the child should be calculated and propagated
-through the scrolled window’s requested natural height.
+Sets whether the natural height of the child should be calculated
+and propagated through the scrolled window’s requested natural height.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="propagate">
@@ -63523,13 +67044,13 @@ through the scrolled window’s requested natural height.
<function name="gtk_scrolled_window_set_propagate_natural_width">
<description>
-Sets whether the natural width of the child should be calculated and propagated
-through the scrolled window’s requested natural width.
+Sets whether the natural width of the child should be calculated
+and propagated through the scrolled window’s requested natural width.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="propagate">
@@ -63542,16 +67063,16 @@ through the scrolled window’s requested natural width.
<function name="gtk_scrolled_window_set_vadjustment">
<description>
-Sets the #GtkAdjustment for the vertical scrollbar.
+Sets the `GtkAdjustment` for the vertical scrollbar.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
<parameter name="vadjustment">
-<parameter_description> the #GtkAdjustment to use, or %NULL to create a new one
+<parameter_description> the `GtkAdjustment` to use, or %NULL to create a new one
</parameter_description>
</parameter>
</parameters>
@@ -63560,17 +67081,15 @@ Sets the #GtkAdjustment for the vertical scrollbar.
<function name="gtk_scrolled_window_unset_placement">
<description>
-Unsets the placement of the contents with respect to the scrollbars
-for the scrolled window. If no window placement is set for a scrolled
-window, it defaults to %GTK_CORNER_TOP_LEFT.
+Unsets the placement of the contents with respect to the scrollbars.
-See also gtk_scrolled_window_set_placement() and
-gtk_scrolled_window_get_placement().
+If no window placement is set for a scrolled window,
+it defaults to %GTK_CORNER_TOP_LEFT.
</description>
<parameters>
<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter_description> a `GtkScrolledWindow`
</parameter_description>
</parameter>
</parameters>
@@ -63579,19 +67098,21 @@ gtk_scrolled_window_get_placement().
<function name="gtk_search_bar_connect_entry">
<description>
-Connects the #GtkEntry widget passed as the one to be used in
-this search bar. The entry should be a descendant of the search bar.
-This is only required if the entry isn’t the direct child of the
-search bar (as in our main example).
+Connects the `GtkEditable widget passed as the one to be used in
+this search bar.
+
+The entry should be a descendant of the search bar. Calling this
+function manually is only required if the entry isn’t the direct
+child of the search bar (as in our main example).
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkSearchBar
+<parameter_description> a `GtkSearchBar`
</parameter_description>
</parameter>
<parameter name="entry">
-<parameter_description> a #GtkEditable
+<parameter_description> a `GtkEditable`
</parameter_description>
</parameter>
</parameters>
@@ -63606,7 +67127,7 @@ Gets the child widget of @bar.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkSearchBar
+<parameter_description> a `GtkSearchBar`
</parameter_description>
</parameter>
</parameters>
@@ -63622,7 +67143,7 @@ Gets the widget that @bar is capturing key events from.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkSearchBar
+<parameter_description> a `GtkSearchBar`
</parameter_description>
</parameter>
</parameters>
@@ -63638,7 +67159,7 @@ Returns whether the search mode is on or off.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkSearchBar
+<parameter_description> a `GtkSearchBar`
</parameter_description>
</parameter>
</parameters>
@@ -63654,7 +67175,7 @@ Returns whether the close button is shown.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkSearchBar
+<parameter_description> a `GtkSearchBar`
</parameter_description>
</parameter>
</parameters>
@@ -63664,15 +67185,16 @@ Returns whether the close button is shown.
<function name="gtk_search_bar_new">
<description>
-Creates a #GtkSearchBar. You will need to tell it about
-which widget is going to be your text entry using
-gtk_search_bar_connect_entry().
+Creates a `GtkSearchBar`.
+
+You will need to tell it about which widget is going to be your text
+entry using [method@Gtk.SearchBar.connect_entry].
</description>
<parameters>
</parameters>
-<return> a new #GtkSearchBar
+<return> a new `GtkSearchBar`
</return>
</function>
@@ -63683,7 +67205,7 @@ Sets the child widget of @bar.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkSearchBar
+<parameter_description> a `GtkSearchBar`
</parameter_description>
</parameter>
<parameter name="child">
@@ -63696,19 +67218,27 @@ Sets the child widget of @bar.
<function name="gtk_search_bar_set_key_capture_widget">
<description>
-Sets @widget as the widget that @bar will capture key events from.
+Sets @widget as the widget that @bar will capture key events
+from.
If key events are handled by the search bar, the bar will
be shown, and the entry populated with the entered text.
+Note that despite the name of this function, the events
+are only 'captured' in the bubble phase, which means that
+editable child widgets of @widget will receive text input
+before it gets captured. If that is not desired, you can
+capture and forward the events yourself with
+[method@Gtk.EventControllerKey.forward].
+
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkSearchBar
+<parameter_description> a `GtkSearchBar`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -63722,7 +67252,7 @@ Switches the search mode on or off.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkSearchBar
+<parameter_description> a `GtkSearchBar`
</parameter_description>
</parameter>
<parameter name="search_mode">
@@ -63735,15 +67265,16 @@ Switches the search mode on or off.
<function name="gtk_search_bar_set_show_close_button">
<description>
-Shows or hides the close button. Applications that
-already have a “search” toggle button should not show a close
-button in their search bar, as it duplicates the role of the
-toggle button.
+Shows or hides the close button.
+
+Applications that already have a “search” toggle button should not
+show a close button in their search bar, as it duplicates the role
+of the toggle button.
</description>
<parameters>
<parameter name="bar">
-<parameter_description> a #GtkSearchBar
+<parameter_description> a `GtkSearchBar`
</parameter_description>
</parameter>
<parameter name="visible">
@@ -63762,7 +67293,7 @@ Gets the widget that @entry is capturing key events from.
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkSearchEntry
+<parameter_description> a `GtkSearchEntry`
</parameter_description>
</parameter>
</parameters>
@@ -63772,32 +67303,40 @@ Gets the widget that @entry is capturing key events from.
<function name="gtk_search_entry_new">
<description>
-Creates a #GtkSearchEntry, with a find icon when the search field is
-empty, and a clear icon when it isn't.
+Creates a `GtkSearchEntry`.
</description>
<parameters>
</parameters>
-<return> a new #GtkSearchEntry
+<return> a new `GtkSearchEntry`
</return>
</function>
<function name="gtk_search_entry_set_key_capture_widget">
<description>
-Sets @widget as the widget that @entry will capture key events from.
+Sets @widget as the widget that @entry will capture key
+events from.
Key events are consumed by the search entry to start or
continue a search.
-If the entry is part of a #GtkSearchBar, it is preferable
-to call gtk_search_bar_set_key_capture_widget() instead, which
-will reveal the entry in addition to triggering the search entry.
+If the entry is part of a `GtkSearchBar`, it is preferable
+to call [method@Gtk.SearchBar.set_key_capture_widget] instead,
+which will reveal the entry in addition to triggering the
+search entry.
+
+Note that despite the name of this function, the events
+are only 'captured' in the bubble phase, which means that
+editable child widgets of @widget will receive text input
+before it gets captured. If that is not desired, you can
+capture and forward the events yourself with
+[method@Gtk.EventControllerKey.forward].
</description>
<parameters>
<parameter name="entry">
-<parameter_description> a #GtkSearchEntry
+<parameter_description> a `GtkSearchEntry`
</parameter_description>
</parameter>
<parameter name="widget">
@@ -63816,7 +67355,7 @@ Gets the model currently filtered or %NULL if none.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSelectionFilterModel
+<parameter_description> a `GtkSelectionFilterModel`
</parameter_description>
</parameter>
</parameters>
@@ -63826,7 +67365,7 @@ Gets the model currently filtered or %NULL if none.
<function name="gtk_selection_filter_model_new">
<description>
-Creates a new #GtkSelectionFilterModel that will include the
+Creates a new `GtkSelectionFilterModel` that will include the
selected items from the underlying selection model.
@@ -63837,7 +67376,7 @@ selected items from the underlying selection model.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkSelectionFilterModel
+<return> a new `GtkSelectionFilterModel`
</return>
</function>
@@ -63853,7 +67392,7 @@ types match.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSelectionFilterModel
+<parameter_description> a `GtkSelectionFilterModel`
</parameter_description>
</parameter>
<parameter name="model">
@@ -63869,18 +67408,18 @@ types match.
Gets the set containing all currently selected items in the model.
This function may be slow, so if you are only interested in single item,
-consider using gtk_selection_model_is_selected() or if you are only
-interested in a few consider gtk_selection_model_get_selection_in_range().
+consider using [method@Gtk.SelectionModel.is_selected] or if you are only
+interested in a few, consider [method@Gtk.SelectionModel.get_selection_in_range].
</description>
<parameters>
<parameter name="model">
-<parameter_description> a #GtkSelectionModel
+<parameter_description> a `GtkSelectionModel`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkBitset containing all the values currently
+<return> a `GtkBitset` containing all the values currently
selected in @model. If no items are selected, the bitset is empty.
The bitset must not be modified.
</return>
@@ -63888,19 +67427,19 @@ The bitset must not be modified.
<function name="gtk_selection_model_get_selection_in_range">
<description>
-Gets a set containing a set where the values in the range `[position,
-position + n_items)` match the selected state of the items in that range.
-All values outside that range are undefined.
+Gets the set of selected items in a range.
-This function is an optimization for gtk_selection_model_get_selection() when
-you are only interested in part of the model's selected state. A common use
-case is in response to the #GtkSelectionModel::selection-changed signal.
+This function is an optimization for
+[method@Gtk.SelectionModel.get_selection] when you are only
+interested in part of the model's selected state. A common use
+case is in response to the [signal@Gtk.SelectionModel::selection-changed]
+signal.
</description>
<parameters>
<parameter name="model">
-<parameter_description> a #GtkSelectionModel
+<parameter_description> a `GtkSelectionModel`
</parameter_description>
</parameter>
<parameter name="position">
@@ -63912,8 +67451,8 @@ case is in response to the #GtkSelectionModel::selection-changed signal.
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkBitset that matches the selection state for the given state
-with all other values being undefined.
+<return> A `GtkBitset` that matches the selection state
+for the given range with all other values being undefined.
The bitset must not be modified.
</return>
</function>
@@ -63926,7 +67465,7 @@ Checks if the given item is selected.
</description>
<parameters>
<parameter name="model">
-<parameter_description> a #GtkSelectionModel
+<parameter_description> a `GtkSelectionModel`
</parameter_description>
</parameter>
<parameter name="position">
@@ -63946,7 +67485,7 @@ Requests to select all items in the model.
</description>
<parameters>
<parameter name="model">
-<parameter_description> a #GtkSelectionModel
+<parameter_description> a `GtkSelectionModel`
</parameter_description>
</parameter>
</parameters>
@@ -63963,7 +67502,7 @@ Requests to select an item in the model.
</description>
<parameters>
<parameter name="model">
-<parameter_description> a #GtkSelectionModel
+<parameter_description> a `GtkSelectionModel`
</parameter_description>
</parameter>
<parameter name="position">
@@ -63988,7 +67527,7 @@ Requests to select a range of items in the model.
</description>
<parameters>
<parameter name="model">
-<parameter_description> a #GtkSelectionModel
+<parameter_description> a `GtkSelectionModel`
</parameter_description>
</parameter>
<parameter name="position">
@@ -64011,14 +67550,15 @@ tried. This does not mean the range was selected.
<function name="gtk_selection_model_selection_changed">
<description>
-Helper function for implementations of #GtkSelectionModel.
+Helper function for implementations of `GtkSelectionModel`.
+
Call this when a the selection changes to emit the
-#GtkSelectionModel::selection-changed signal.
+[signal@Gtk.SelectionModel::selection-changed] signal.
</description>
<parameters>
<parameter name="model">
-<parameter_description> a #GtkSelectionModel
+<parameter_description> a `GtkSelectionModel`
</parameter_description>
</parameter>
<parameter name="position">
@@ -64035,17 +67575,19 @@ Call this when a the selection changes to emit the
<function name="gtk_selection_model_set_selection">
<description>
+Make selection changes.
+
This is the most advanced selection updating method that allows
-the most fine-grained control over selection changes.
-If you can, you should try the simpler versions, as implementations
-are more likely to implement support for those.
+the most fine-grained control over selection changes. If you can,
+you should try the simpler versions, as implementations are more
+likely to implement support for those.
-Requests that the selection state of all positions set in @mask be
-updated to the respective value in the @selected bitmask.
+Requests that the selection state of all positions set in @mask
+be updated to the respective value in the @selected bitmask.
In pseudocode, it would look something like this:
-|[<!-- language="C" -->
+```c
for (i = 0; i < n_items; i++)
{
// don't change values not in the mask
@@ -64058,17 +67600,20 @@ else
unselect_item (i);
}
-gtk_selection_model_selection_changed (model, first_changed_item, n_changed_items);
-]|
+gtk_selection_model_selection_changed (model,
+first_changed_item,
+n_changed_items);
+```
-@mask and @selected must not be modified. They may refer to the same bitset,
-which would mean that every item in the set should be selected.
+@mask and @selected must not be modified. They may refer to the
+same bitset, which would mean that every item in the set should
+be selected.
</description>
<parameters>
<parameter name="model">
-<parameter_description> a #GtkSelectionModel
+<parameter_description> a `GtkSelectionModel`
</parameter_description>
</parameter>
<parameter name="selected">
@@ -64095,7 +67640,7 @@ Requests to unselect all items in the model.
</description>
<parameters>
<parameter name="model">
-<parameter_description> a #GtkSelectionModel
+<parameter_description> a `GtkSelectionModel`
</parameter_description>
</parameter>
</parameters>
@@ -64112,7 +67657,7 @@ Requests to unselect an item in the model.
</description>
<parameters>
<parameter name="model">
-<parameter_description> a #GtkSelectionModel
+<parameter_description> a `GtkSelectionModel`
</parameter_description>
</parameter>
<parameter name="position">
@@ -64133,7 +67678,7 @@ Requests to unselect a range of items in the model.
</description>
<parameters>
<parameter name="model">
-<parameter_description> a #GtkSelectionModel
+<parameter_description> a `GtkSelectionModel`
</parameter_description>
</parameter>
<parameter name="position">
@@ -64152,7 +67697,7 @@ tried. This does not mean the range was unselected.
<function name="gtk_separator_new">
<description>
-Creates a new #GtkSeparator with the given orientation.
+Creates a new `GtkSeparator` with the given orientation.
</description>
@@ -64162,7 +67707,7 @@ Creates a new #GtkSeparator with the given orientation.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkSeparator.
+<return> a new `GtkSeparator`.
</return>
</function>
@@ -64182,45 +67727,48 @@ Sets the GTK debug flags.
<function name="gtk_settings_get_default">
<description>
-Gets the #GtkSettings object for the default display, creating
-it if necessary. See gtk_settings_get_for_display().
+Gets the `GtkSettings` object for the default display, creating
+it if necessary.
+
+See [type_func@Gtk.Settings.get_for_display].
</description>
<parameters>
</parameters>
-<return> a #GtkSettings object. If there is
+<return> a `GtkSettings` object. If there is
no default display, then returns %NULL.
</return>
</function>
<function name="gtk_settings_get_for_display">
<description>
-Gets the #GtkSettings object for @display, creating it if necessary.
+Gets the `GtkSettings` object for @display, creating it if necessary.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay.
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkSettings object.
+<return> a `GtkSettings` object
</return>
</function>
<function name="gtk_settings_reset_property">
<description>
Undoes the effect of calling g_object_set() to install an
-application-specific value for a setting. After this call,
-the setting will again follow the session-wide value for
-this setting.
+application-specific value for a setting.
+
+After this call, the setting will again follow the session-wide
+value for this setting.
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkSettings object
+<parameter_description> a `GtkSettings` object
</parameter_description>
</parameter>
<parameter name="name">
@@ -64233,7 +67781,7 @@ this setting.
<function name="gtk_shortcut_action_activate">
<description>
-Activates the action on the @widget with the given @args.
+Activates the action on the @widget with the given @args.
Note that some actions ignore the passed in @flags, @widget or @args.
@@ -64245,7 +67793,7 @@ or if the activation otherwise had no effect, %FALSE will be returned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcutAction
+<parameter_description> a `GtkShortcutAction`
</parameter_description>
</parameter>
<parameter name="flags">
@@ -64267,17 +67815,18 @@ or if the activation otherwise had no effect, %FALSE will be returned.
<function name="gtk_shortcut_action_parse_string">
<description>
-Tries to parse the given string into an action. On
-success, the parsed action is returned. When parsing
+Tries to parse the given string into an action.
+
+On success, the parsed action is returned. When parsing
failed, %NULL is returned.
The accepted strings are:
-- `nothing`, for #GtkNothingAction
-- `activate`, for #GtkActivateAction
-- `mnemonic-activate`, for #GtkMnemonicAction
-- `action(NAME)`, for a #GtkNamedAction for the action named `NAME`
-- `signal(NAME)`, for a #GtkSignalAction for the signal `NAME`
+- `nothing`, for `GtkNothingAction`
+- `activate`, for `GtkActivateAction`
+- `mnemonic-activate`, for `GtkMnemonicAction`
+- `action(NAME)`, for a `GtkNamedAction` for the action named `NAME`
+- `signal(NAME)`, for a `GtkSignalAction` for the signal `NAME`
</description>
@@ -64287,7 +67836,7 @@ The accepted strings are:
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkShortcutAction
+<return> a new `GtkShortcutAction`
or %NULL on error
</return>
</function>
@@ -64295,6 +67844,7 @@ or %NULL on error
<function name="gtk_shortcut_action_print">
<description>
Prints the given action into a string for the developer.
+
This is meant for debugging and logging.
The form of the representation may change at any time and is
@@ -64303,11 +67853,11 @@ not guaranteed to stay identical.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcutAction
+<parameter_description> a `GtkShortcutAction`
</parameter_description>
</parameter>
<parameter name="string">
-<parameter_description> a #GString to print into
+<parameter_description> a `GString` to print into
</parameter_description>
</parameter>
</parameters>
@@ -64317,14 +67867,15 @@ not guaranteed to stay identical.
<function name="gtk_shortcut_action_to_string">
<description>
Prints the given action into a human-readable string.
-This is a small wrapper around gtk_shortcut_action_print() to help
-when debugging.
+
+This is a small wrapper around [method@Gtk.ShortcutAction.print]
+to help when debugging.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcutAction
+<parameter_description> a `GtkShortcutAction`
</parameter_description>
</parameter>
</parameters>
@@ -64346,7 +67897,7 @@ function does nothing.
</parameter_description>
</parameter>
<parameter name="shortcut">
-<parameter_description> a #GtkShortcut
+<parameter_description> a `GtkShortcut`
</parameter_description>
</parameter>
</parameters>
@@ -64355,14 +67906,13 @@ function does nothing.
<function name="gtk_shortcut_controller_get_mnemonics_modifiers">
<description>
-Gets the mnemonics modifiers for when this controller activates its shortcuts. See
-gtk_shortcut_controller_set_mnemonics_modifiers() for details.
+Gets the mnemonics modifiers for when this controller activates its shortcuts.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcutController
+<parameter_description> a `GtkShortcutController`
</parameter_description>
</parameter>
</parameters>
@@ -64379,7 +67929,7 @@ gtk_shortcut_controller_set_scope() for details.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcutController
+<parameter_description> a `GtkShortcutController`
</parameter_description>
</parameter>
</parameters>
@@ -64412,7 +67962,7 @@ but you can change the contents of the model.
</description>
<parameters>
<parameter name="model">
-<parameter_description> a #GListModel containing shortcuts
+<parameter_description> a `GListModel` containing shortcuts
</parameter_description>
</parameter>
</parameters>
@@ -64434,7 +67984,7 @@ uses an external shortcut list, this function does nothing.
</parameter_description>
</parameter>
<parameter name="shortcut">
-<parameter_description> a #GtkShortcut
+<parameter_description> a `GtkShortcut`
</parameter_description>
</parameter>
</parameters>
@@ -64460,7 +68010,7 @@ have their own modifiers for activating mnemonics.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcutController
+<parameter_description> a `GtkShortcutController`
</parameter_description>
</parameter>
<parameter name="modifiers">
@@ -64486,7 +68036,7 @@ when the widget has focus.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcutController
+<parameter_description> a `GtkShortcutController`
</parameter_description>
</parameter>
<parameter name="scope">
@@ -64505,7 +68055,7 @@ Gets the action that is activated by this shortcut.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcut
+<parameter_description> a `GtkShortcut`
</parameter_description>
</parameter>
</parameters>
@@ -64521,7 +68071,7 @@ Gets the arguments that are passed when activating the shortcut.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcut
+<parameter_description> a `GtkShortcut`
</parameter_description>
</parameter>
</parameters>
@@ -64537,7 +68087,7 @@ Gets the trigger used to trigger @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcut
+<parameter_description> a `GtkShortcut`
</parameter_description>
</parameter>
</parameters>
@@ -64553,7 +68103,7 @@ Retrieves the current accelerator of @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcutLabel
+<parameter_description> a `GtkShortcutLabel`
</parameter_description>
</parameter>
</parameters>
@@ -64569,7 +68119,7 @@ Retrieves the text that is displayed when no accelerator is set.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcutLabel
+<parameter_description> a `GtkShortcutLabel`
</parameter_description>
</parameter>
</parameters>
@@ -64580,7 +68130,7 @@ accelerator is set.
<function name="gtk_shortcut_label_new">
<description>
-Creates a new #GtkShortcutLabel with @accelerator set.
+Creates a new `GtkShortcutLabel` with @accelerator set.
</description>
@@ -64590,7 +68140,7 @@ Creates a new #GtkShortcutLabel with @accelerator set.
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated #GtkShortcutLabel
+<return> a newly-allocated `GtkShortcutLabel`
</return>
</function>
@@ -64601,7 +68151,7 @@ Sets the accelerator to be displayed by @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcutLabel
+<parameter_description> a `GtkShortcutLabel`
</parameter_description>
</parameter>
<parameter name="accelerator">
@@ -64619,7 +68169,7 @@ Sets the text to be displayed by @self when no accelerator is set.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcutLabel
+<parameter_description> a `GtkShortcutLabel`
</parameter_description>
</parameter>
<parameter name="disabled_text">
@@ -64632,8 +68182,8 @@ Sets the text to be displayed by @self when no accelerator is set.
<function name="gtk_shortcut_new">
<description>
-Creates a new #GtkShortcut that is triggered by @trigger and then activates
-@action.
+Creates a new `GtkShortcut` that is triggered by
+@trigger and then activates @action.
</description>
@@ -64648,13 +68198,13 @@ triggering
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkShortcut
+<return> a new `GtkShortcut`
</return>
</function>
<function name="gtk_shortcut_new_with_arguments">
<description>
-Creates a new #GtkShortcut that is triggered by @trigger and then activates
+Creates a new `GtkShortcut` that is triggered by @trigger and then activates
@action with arguments given by @format_string.
@@ -64679,7 +68229,7 @@ no arguments
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkShortcut
+<return> a new `GtkShortcut`
</return>
</function>
@@ -64690,7 +68240,7 @@ Sets the new action for @self to be @action.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcut
+<parameter_description> a `GtkShortcut`
</parameter_description>
</parameter>
<parameter name="action">
@@ -64709,7 +68259,7 @@ Sets the arguments to pass when activating the shortcut.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcut
+<parameter_description> a `GtkShortcut`
</parameter_description>
</parameter>
<parameter name="args">
@@ -64727,7 +68277,7 @@ Sets the new trigger for @self to be @trigger.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcut
+<parameter_description> a `GtkShortcut`
</parameter_description>
</parameter>
<parameter name="trigger">
@@ -64742,18 +68292,19 @@ If the @trigger is %NULL, the never trigger will be used.
<function name="gtk_shortcut_trigger_compare">
<description>
The types of @trigger1 and @trigger2 are #gconstpointer only to allow
-use of this function as a #GCompareFunc. They must each be a
-#GtkShortcutTrigger.
+use of this function as a #GCompareFunc.
+
+They must each be a `GtkShortcutTrigger`.
</description>
<parameters>
<parameter name="trigger1">
-<parameter_description> a #GtkShortcutTrigger
+<parameter_description> a `GtkShortcutTrigger`
</parameter_description>
</parameter>
<parameter name="trigger2">
-<parameter_description> a #GtkShortcutTrigger
+<parameter_description> a `GtkShortcutTrigger`
</parameter_description>
</parameter>
</parameters>
@@ -64768,17 +68319,17 @@ or be greater than @trigger2.
Checks if @trigger1 and @trigger2 trigger under the same conditions.
The types of @one and @two are #gconstpointer only to allow use of this
-function with #GHashTable. They must each be a #GtkShortcutTrigger.
+function with #GHashTable. They must each be a `GtkShortcutTrigger`.
</description>
<parameters>
<parameter name="trigger1">
-<parameter_description> a #GtkShortcutTrigger
+<parameter_description> a `GtkShortcutTrigger`
</parameter_description>
</parameter>
<parameter name="trigger2">
-<parameter_description> a #GtkShortcutTrigger
+<parameter_description> a `GtkShortcutTrigger`
</parameter_description>
</parameter>
</parameters>
@@ -64788,21 +68339,21 @@ function with #GHashTable. They must each be a #GtkShortcutTrigger.
<function name="gtk_shortcut_trigger_hash">
<description>
-Generates a hash value for a #GtkShortcutTrigger.
+Generates a hash value for a `GtkShortcutTrigger`.
The output of this function is guaranteed to be the same for a given
-value only per-process. It may change between different processor
-architectures or even different versions of GTK. Do not use this
+value only per-process. It may change between different processor
+architectures or even different versions of GTK. Do not use this
function as a basis for building protocols or file formats.
The types of @trigger is #gconstpointer only to allow use of this
-function with #GHashTable. They must each be a #GtkShortcutTrigger.
+function with #GHashTable. They must each be a `GtkShortcutTrigger`.
</description>
<parameters>
<parameter name="trigger">
-<parameter_description> a #GtkShortcutTrigger
+<parameter_description> a `GtkShortcutTrigger`
</parameter_description>
</parameter>
</parameters>
@@ -64812,17 +68363,18 @@ function with #GHashTable. They must each be a #GtkShortcutTrigger.
<function name="gtk_shortcut_trigger_parse_string">
<description>
-Tries to parse the given string into a trigger. On success,
-the parsed trigger is returned. When parsing failed, %NULL is
-returned.
+Tries to parse the given string into a trigger.
+
+On success, the parsed trigger is returned.
+When parsing failed, %NULL is returned.
The accepted strings are:
-- `never`, for #GtkNeverTrigger
-- a string parsed by gtk_accelerator_parse(), for a #GtkKeyvalTrigger, e.g. `<Control>C`
-- underscore, followed by a single character, for MnemonicTrigger, e.g. `_l`
+- `never`, for `GtkNeverTrigger`
+- a string parsed by gtk_accelerator_parse(), for a `GtkKeyvalTrigger`, e.g. `<Control>C`
+- underscore, followed by a single character, for `GtkMnemonicTrigger`, e.g. `_l`
- two valid trigger strings, separated by a `|` character, for a
-#GtkAlternativeTrigger: `<Control>q|<Control>w`
+`GtkAlternativeTrigger`: `<Control>q|<Control>w`
Note that you will have to escape the `<` and `>` characters when specifying
triggers in XML files, such as GtkBuilder ui files. Use `<` instead of
@@ -64836,7 +68388,7 @@ triggers in XML files, such as GtkBuilder ui files. Use `<` instead of
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkShortcutTrigger
+<return> a new `GtkShortcutTrigger`
or %NULL on error
</return>
</function>
@@ -64852,11 +68404,11 @@ and is not guaranteed to stay identical.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcutTrigger
+<parameter_description> a `GtkShortcutTrigger`
</parameter_description>
</parameter>
<parameter name="string">
-<parameter_description> a #GString to print into
+<parameter_description> a `GString` to print into
</parameter_description>
</parameter>
</parameters>
@@ -64865,9 +68417,10 @@ and is not guaranteed to stay identical.
<function name="gtk_shortcut_trigger_print_label">
<description>
-Prints the given trigger into a string. This function is
-returning a translated string for presentation to end users
-for example in menu items or in help texts.
+Prints the given trigger into a string.
+
+This function is returning a translated string for presentation
+to end users for example in menu items or in help texts.
The @display in use may influence the resulting string in
various forms, such as resolving hardware keycodes or by
@@ -64880,15 +68433,15 @@ not guaranteed to stay identical.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcutTrigger
+<parameter_description> a `GtkShortcutTrigger`
</parameter_description>
</parameter>
<parameter name="display">
-<parameter_description> #GdkDisplay to print for
+<parameter_description> `GdkDisplay` to print for
</parameter_description>
</parameter>
<parameter name="string">
-<parameter_description> a #GString to print into
+<parameter_description> a `GString` to print into
</parameter_description>
</parameter>
</parameters>
@@ -64900,9 +68453,11 @@ for end users.
<function name="gtk_shortcut_trigger_to_label">
<description>
-Gets textual representation for the given trigger. This
-function is returning a translated string for presentation
-to end users for example in menu items or in help texts.
+Gets textual representation for the given trigger.
+
+This function is returning a translated string for
+presentation to end users for example in menu items
+or in help texts.
The @display in use may influence the resulting string in
various forms, such as resolving hardware keycodes or by
@@ -64915,11 +68470,11 @@ not guaranteed to stay identical.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcutTrigger
+<parameter_description> a `GtkShortcutTrigger`
</parameter_description>
</parameter>
<parameter name="display">
-<parameter_description> #GdkDisplay to print for
+<parameter_description> `GdkDisplay` to print for
</parameter_description>
</parameter>
</parameters>
@@ -64930,14 +68485,15 @@ not guaranteed to stay identical.
<function name="gtk_shortcut_trigger_to_string">
<description>
Prints the given trigger into a human-readable string.
-This is a small wrapper around gtk_shortcut_trigger_print()
+
+This is a small wrapper around [method@Gtk.ShortcutTrigger.print]
to help when debugging.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcutTrigger
+<parameter_description> a `GtkShortcutTrigger`
</parameter_description>
</parameter>
</parameters>
@@ -64953,7 +68509,7 @@ Checks if the given @event triggers @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkShortcutTrigger
+<parameter_description> a `GtkShortcutTrigger`
</parameter_description>
</parameter>
<parameter name="event">
@@ -64973,14 +68529,15 @@ in @event is a Key event and has the right modifiers set.
<function name="gtk_show_about_dialog">
<description>
-This is a convenience function for showing an application’s about box.
+A convenience function for showing an application’s about dialog.
+
The constructed dialog is associated with the parent window and
reused for future invocations of this function.
</description>
<parameters>
<parameter name="parent">
-<parameter_description> transient parent, or %NULL for none
+<parameter_description> the parent top-level window
</parameter_description>
</parameter>
<parameter name="first_property_name">
@@ -64988,7 +68545,8 @@ reused for future invocations of this function.
</parameter_description>
</parameter>
<parameter name="Varargs">
-<parameter_description> value of first property, followed by more properties, %NULL-terminated
+<parameter_description> value of first property, followed by more pairs of property
+name and value, `NULL`-terminated
</parameter_description>
</parameter>
</parameters>
@@ -65061,7 +68619,7 @@ necessary for sandbox helpers to parent their dialogs properly.
<function name="gtk_show_uri_full_finish">
<description>
-Finished the gtk_show_uri() call and returns the result
+Finishes the gtk_show_uri() call and returns the result
of the operation.
@@ -65104,8 +68662,9 @@ Returns the name of the signal that will be emitted.
<function name="gtk_signal_action_new">
<description>
Creates an action that when activated, emits the given action signal
-on the provided widget unpacking the given args into arguments passed
-to the signal.
+on the provided widget.
+
+It will also unpack the args into arguments passed to the signal.
</description>
@@ -65115,20 +68674,21 @@ to the signal.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkShortcutAction
+<return> a new `GtkShortcutAction`
</return>
</function>
<function name="gtk_signal_list_item_factory_new">
<description>
-Creates a new #GtkSignalListItemFactory. You need to connect signal
-handlers before you use it.
+Creates a new `GtkSignalListItemFactory`.
+
+You need to connect signal handlers before you use it.
</description>
<parameters>
</parameters>
-<return> a new #GtkSignalListItemFactory
+<return> a new `GtkSignalListItemFactory`
</return>
</function>
@@ -65141,7 +68701,7 @@ gtk_single_selection_set_autoselect().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSingleSelection
+<parameter_description> a `GtkSingleSelection`
</parameter_description>
</parameter>
</parameters>
@@ -65158,7 +68718,7 @@ unselecting the selected item.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSingleSelection
+<parameter_description> a `GtkSingleSelection`
</parameter_description>
</parameter>
</parameters>
@@ -65174,7 +68734,7 @@ Gets the model that @self is wrapping.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSingleSelection
+<parameter_description> a `GtkSingleSelection`
</parameter_description>
</parameter>
</parameters>
@@ -65184,14 +68744,15 @@ Gets the model that @self is wrapping.
<function name="gtk_single_selection_get_selected">
<description>
-Gets the position of the selected item. If no item is selected,
-#GTK_INVALID_LIST_POSITION is returned.
+Gets the position of the selected item.
+
+If no item is selected, %GTK_INVALID_LIST_POSITION is returned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSingleSelection
+<parameter_description> a `GtkSingleSelection`
</parameter_description>
</parameter>
</parameters>
@@ -65209,7 +68770,7 @@ If no item is selected, %NULL is returned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSingleSelection
+<parameter_description> a `GtkSingleSelection`
</parameter_description>
</parameter>
</parameters>
@@ -65225,16 +68786,18 @@ Creates a new selection to handle @model.
</description>
<parameters>
<parameter name="model">
-<parameter_description> the #GListModel to manage, or %NULL
+<parameter_description> the `GListModel` to manage, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkSingleSelection
+<return> a new `GtkSingleSelection`
</return>
</function>
<function name="gtk_single_selection_set_autoselect">
<description>
+Enables or disables autoselect.
+
If @autoselect is %TRUE, @self will enforce that an item is always
selected. It will select a new item when the currently selected
item is deleted and it will disallow unselecting the current item.
@@ -65242,7 +68805,7 @@ item is deleted and it will disallow unselecting the current item.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSingleSelection
+<parameter_description> a `GtkSingleSelection`
</parameter_description>
</parameter>
<parameter name="autoselect">
@@ -65258,14 +68821,14 @@ item is deleted and it will disallow unselecting the current item.
If %TRUE, unselecting the current item via
gtk_selection_model_unselect_item() is supported.
-Note that setting #GtkSingleSelection:autoselect will cause the
-unselecting to not work, so it practically makes no sense to set
-both at the same time the same time.
+Note that setting [property@Gtk.SingleSelection:autoselect] will
+cause unselecting to not work, so it practically makes no sense
+to set both at the same time the same time.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSingleSelection
+<parameter_description> a `GtkSingleSelection`
</parameter_description>
</parameter>
<parameter name="can_unselect">
@@ -65278,17 +68841,18 @@ both at the same time the same time.
<function name="gtk_single_selection_set_model">
<description>
-Sets the model that @self should wrap. If @model is %NULL, @self
-will be empty.
+Sets the model that @self should wrap.
+
+If @model is %NULL, @self will be empty.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSingleSelection
+<parameter_description> a `GtkSingleSelection`
</parameter_description>
</parameter>
<parameter name="model">
-<parameter_description> A #GListModel to wrap
+<parameter_description> A `GListModel` to wrap
</parameter_description>
</parameter>
</parameters>
@@ -65300,19 +68864,20 @@ will be empty.
Selects the item at the given position.
If the list does not have an item at @position or
-#GTK_INVALID_LIST_POSITION is given, the behavior depends on the
-value of the #GtkSingleSelection:autoselect property: If it is set,
-no change will occur and the old item will stay selected. If it is
-unset, the selection will be unset and no item will be selected.
+%GTK_INVALID_LIST_POSITION is given, the behavior depends on the
+value of the [property@Gtk.SingleSelection:autoselect] property:
+If it is set, no change will occur and the old item will stay
+selected. If it is unset, the selection will be unset and no item
+will be selected.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSingleSelection
+<parameter_description> a `GtkSingleSelection`
</parameter_description>
</parameter>
<parameter name="position">
-<parameter_description> the item to select or #GTK_INVALID_LIST_POSITION
+<parameter_description> the item to select or %GTK_INVALID_LIST_POSITION
</parameter_description>
</parameter>
</parameters>
@@ -65321,23 +68886,26 @@ unset, the selection will be unset and no item will be selected.
<function name="gtk_size_group_add_widget">
<description>
-Adds a widget to a #GtkSizeGroup. In the future, the requisition
+Adds a widget to a `GtkSizeGroup`.
+
+In the future, the requisition
of the widget will be determined as the maximum of its requisition
and the requisition of the other widgets in the size group.
Whether this applies horizontally, vertically, or in both directions
-depends on the mode of the size group. See gtk_size_group_set_mode().
+depends on the mode of the size group.
+See [method@Gtk.SizeGroup.set_mode].
-When the widget is destroyed or no longer referenced elsewhere, it will
-be removed from the size group.
+When the widget is destroyed or no longer referenced elsewhere, it
+will be removed from the size group.
</description>
<parameters>
<parameter name="size_group">
-<parameter_description> a #GtkSizeGroup
+<parameter_description> a `GtkSizeGroup`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> the #GtkWidget to add
+<parameter_description> the `GtkWidget` to add
</parameter_description>
</parameter>
</parameters>
@@ -65346,13 +68914,13 @@ be removed from the size group.
<function name="gtk_size_group_get_mode">
<description>
-Gets the current mode of the size group. See gtk_size_group_set_mode().
+Gets the current mode of the size group.
</description>
<parameters>
<parameter name="size_group">
-<parameter_description> a #GtkSizeGroup
+<parameter_description> a `GtkSizeGroup`
</parameter_description>
</parameter>
</parameters>
@@ -65368,19 +68936,19 @@ Returns the list of widgets associated with @size_group.
</description>
<parameters>
<parameter name="size_group">
-<parameter_description> a #GtkSizeGroup
+<parameter_description> a `GtkSizeGroup`
</parameter_description>
</parameter>
</parameters>
-<return> a #GSList of
+<return> a `GSList` of
widgets. The list is owned by GTK and should not be modified.
</return>
</function>
<function name="gtk_size_group_new">
<description>
-Create a new #GtkSizeGroup.
-
+Create a new `GtkSizeGroup`.
+
</description>
<parameters>
@@ -65389,22 +68957,22 @@ Create a new #GtkSizeGroup.
</parameter_description>
</parameter>
</parameters>
-<return> a newly created #GtkSizeGroup
+<return> a newly created `GtkSizeGroup`
</return>
</function>
<function name="gtk_size_group_remove_widget">
<description>
-Removes a widget from a #GtkSizeGroup.
+Removes a widget from a `GtkSizeGroup`.
</description>
<parameters>
<parameter name="size_group">
-<parameter_description> a #GtkSizeGroup
+<parameter_description> a `GtkSizeGroup`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> the #GtkWidget to remove
+<parameter_description> the `GtkWidget` to remove
</parameter_description>
</parameter>
</parameters>
@@ -65413,17 +68981,18 @@ Removes a widget from a #GtkSizeGroup.
<function name="gtk_size_group_set_mode">
<description>
-Sets the #GtkSizeGroupMode of the size group. The mode of the size
-group determines whether the widgets in the size group should
-all have the same horizontal requisition (%GTK_SIZE_GROUP_HORIZONTAL)
-all have the same vertical requisition (%GTK_SIZE_GROUP_VERTICAL),
-or should all have the same requisition in both directions
-(%GTK_SIZE_GROUP_BOTH).
+Sets the `GtkSizeGroupMode` of the size group.
+
+The mode of the size group determines whether the widgets in the
+size group should all have the same horizontal requisition
+(%GTK_SIZE_GROUP_HORIZONTAL) all have the same vertical requisition
+(%GTK_SIZE_GROUP_VERTICAL), or should all have the same requisition
+in both directions (%GTK_SIZE_GROUP_BOTH).
</description>
<parameters>
<parameter name="size_group">
-<parameter_description> a #GtkSizeGroup
+<parameter_description> a `GtkSizeGroup`
</parameter_description>
</parameter>
<parameter name="mode">
@@ -65442,7 +69011,7 @@ Gets the model that is currently being used or %NULL if none.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSliceListModel
+<parameter_description> a `GtkSliceListModel`
</parameter_description>
</parameter>
</parameters>
@@ -65452,13 +69021,13 @@ Gets the model that is currently being used or %NULL if none.
<function name="gtk_slice_list_model_get_offset">
<description>
-Gets the offset set via gtk_slice_list_model_set_offset()
+Gets the offset set via gtk_slice_list_model_set_offset().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSliceListModel
+<parameter_description> a `GtkSliceListModel`
</parameter_description>
</parameter>
</parameters>
@@ -65474,7 +69043,7 @@ Gets the size set via gtk_slice_list_model_set_size().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSliceListModel
+<parameter_description> a `GtkSliceListModel`
</parameter_description>
</parameter>
</parameters>
@@ -65484,8 +69053,10 @@ Gets the size set via gtk_slice_list_model_set_size().
<function name="gtk_slice_list_model_new">
<description>
-Creates a new slice model that presents the slice from @offset to
-@offset + @size our of the given @model.
+Creates a new slice model.
+
+It presents the slice from @offset to offset + @size
+of the given @model.
</description>
@@ -65503,20 +69074,20 @@ Creates a new slice model that presents the slice from @offset to
</parameter_description>
</parameter>
</parameters>
-<return> A new #GtkSliceListModel
+<return> A new `GtkSliceListModel`
</return>
</function>
<function name="gtk_slice_list_model_set_model">
<description>
-Sets the model to show a slice of. The model's item type must conform
-to @self's item type.
+Sets the model to show a slice of.
+The model's item type must conform to @self's item type.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSliceListModel
+<parameter_description> a `GtkSliceListModel`
</parameter_description>
</parameter>
<parameter name="model">
@@ -65532,12 +69103,12 @@ to @self's item type.
Sets the offset into the original model for this slice.
If the offset is too large for the sliced model,
-@self will end up empty.
+@self will end up empty.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSliceListModel
+<parameter_description> a `GtkSliceListModel`
</parameter_description>
</parameter>
<parameter name="offset">
@@ -65553,13 +69124,13 @@ If the offset is too large for the sliced model,
Sets the maximum size. @self will never have more items
than @size.
-It can however have fewer items if the offset is too large or
-the model sliced from doesn't have enough items.
+It can however have fewer items if the offset is too large
+or the model sliced from doesn't have enough items.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSliceListModel
+<parameter_description> a `GtkSliceListModel`
</parameter_description>
</parameter>
<parameter name="size">
@@ -65572,17 +69143,18 @@ the model sliced from doesn't have enough items.
<function name="gtk_snapshot_append_border">
<description>
-Appends a stroked border rectangle inside the given @outline. The
-4 sides of the border can have different widths and colors.
+Appends a stroked border rectangle inside the given @outline.
+
+The four sides of the border can have different widths and colors.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="outline">
-<parameter_description> a #GskRoundedRect describing the outline of the border
+<parameter_description> a `GskRoundedRect` describing the outline of the border
</parameter_description>
</parameter>
<parameter name="border_width">
@@ -65601,14 +69173,14 @@ bottom and left side.
<function name="gtk_snapshot_append_cairo">
<description>
-Creates a new render node and appends it to the current render
-node of @snapshot, without changing the current node.
+Creates a new `GskCairoNode` and appends it to the current
+render node of @snapshot, without changing the current node.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="bounds">
@@ -65616,26 +69188,28 @@ node of @snapshot, without changing the current node.
</parameter_description>
</parameter>
</parameters>
-<return> a cairo_t suitable for drawing the contents of the newly
-created render node
+<return> a `cairo_t` suitable for drawing the contents of
+the newly created render node
</return>
</function>
<function name="gtk_snapshot_append_color">
<description>
-Creates a new render node drawing the @color into the given @bounds and appends it
-to the current render node of @snapshot.
+Creates a new render node drawing the @color into the
+given @bounds and appends it to the current render node
+of @snapshot.
-You should try to avoid calling this function if @color is transparent.
+You should try to avoid calling this function if
+@color is transparent.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="color">
-<parameter_description> the #GdkRGBA to draw
+<parameter_description> the `GdkRGBA` to draw
</parameter_description>
</parameter>
<parameter name="bounds">
@@ -65653,7 +69227,7 @@ Appends a conic gradient node with the given stops to @snapshot.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="bounds">
@@ -65665,12 +69239,13 @@ Appends a conic gradient node with the given stops to @snapshot.
</parameter_description>
</parameter>
<parameter name="rotation">
-<parameter_description> the clockwise rotation in degrees of the starting angle. 0 means the
-starting angle is the top.
+<parameter_description> the clockwise rotation in degrees of the starting angle.
+0 means the starting angle is the top.
</parameter_description>
</parameter>
<parameter name="stops">
-<parameter_description> a pointer to an array of #GskColorStop defining the gradient
+<parameter_description> a pointer to an array of `GskColorStop`
+defining the gradient
</parameter_description>
</parameter>
<parameter name="n_stops">
@@ -65688,7 +69263,7 @@ Appends an inset shadow into the box given by @outline.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="outline">
@@ -65750,7 +69325,7 @@ Appends a linear gradient node with the given stops to @snapshot.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="bounds">
@@ -65766,7 +69341,8 @@ Appends a linear gradient node with the given stops to @snapshot.
</parameter_description>
</parameter>
<parameter name="stops">
-<parameter_description> a pointer to an array of #GskColorStop defining the gradient
+<parameter_description> a pointer to an array of `GskColorStop`
+defining the gradient
</parameter_description>
</parameter>
<parameter name="n_stops">
@@ -65780,14 +69356,15 @@ Appends a linear gradient node with the given stops to @snapshot.
<function name="gtk_snapshot_append_node">
<description>
Appends @node to the current render node of @snapshot,
-without changing the current node. If @snapshot does
-not have a current node yet, @node will become the
-initial node.
+without changing the current node.
+
+If @snapshot does not have a current node yet, @node
+will become the initial node.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="node">
@@ -65805,7 +69382,7 @@ Appends an outset shadow node around the box given by @outline.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="outline">
@@ -65843,7 +69420,7 @@ Appends a radial gradient node with the given stops to @snapshot.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="bounds">
@@ -65871,7 +69448,8 @@ Appends a radial gradient node with the given stops to @snapshot.
</parameter_description>
</parameter>
<parameter name="stops">
-<parameter_description> a pointer to an array of #GskColorStop defining the gradient
+<parameter_description> a pointer to an array of `GskColorStop`
+defining the gradient
</parameter_description>
</parameter>
<parameter name="n_stops">
@@ -65889,7 +69467,7 @@ Appends a repeating linear gradient node with the given stops to @snapshot.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="bounds">
@@ -65905,7 +69483,8 @@ Appends a repeating linear gradient node with the given stops to @snapshot.
</parameter_description>
</parameter>
<parameter name="stops">
-<parameter_description> a pointer to an array of #GskColorStop defining the gradient
+<parameter_description> a pointer to an array of `GskColorStop`
+defining the gradient
</parameter_description>
</parameter>
<parameter name="n_stops">
@@ -65923,7 +69502,7 @@ Appends a repeating radial gradient node with the given stops to @snapshot.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="bounds">
@@ -65951,7 +69530,8 @@ Appends a repeating radial gradient node with the given stops to @snapshot.
</parameter_description>
</parameter>
<parameter name="stops">
-<parameter_description> a pointer to an array of #GskColorStop defining the gradient
+<parameter_description> a pointer to an array of `GskColorStop`
+defining the gradient
</parameter_description>
</parameter>
<parameter name="n_stops">
@@ -65964,17 +69544,18 @@ Appends a repeating radial gradient node with the given stops to @snapshot.
<function name="gtk_snapshot_append_texture">
<description>
-Creates a new render node drawing the @texture into the given @bounds and appends it
-to the current render node of @snapshot.
+Creates a new render node drawing the @texture
+into the given @bounds and appends it to the
+current render node of @snapshot.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="texture">
-<parameter_description> the #GdkTexture to render
+<parameter_description> the `GdkTexture` to render
</parameter_description>
</parameter>
<parameter name="bounds">
@@ -65994,11 +69575,11 @@ and frees @snapshot.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
</parameters>
-<return> a newly-created #GskRenderNode
+<return> a newly-created `GskRenderNode`
</return>
</function>
@@ -66011,7 +69592,7 @@ constructed by @snapshot and frees @snapshot.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="size">
@@ -66020,21 +69601,23 @@ or %NULL to use the bounds of the snapshot
</parameter_description>
</parameter>
</parameters>
-<return> a newly-created #GdkPaintable
+<return> a newly-created `GdkPaintable`
</return>
</function>
<function name="gtk_snapshot_gl_shader_pop_texture">
<description>
Removes the top element from the stack of render nodes and
-adds it to the nearest GskGLShaderNode below it. This must be called the
-same number of times as the number of textures is needed for the
-shader in gtk_snapshot_push_gl_shader().
+adds it to the nearest `GskGLShaderNode` below it.
+
+This must be called the same number of times as the number
+of textures is needed for the shader in
+[method@Gtk.Snapshot.push_gl_shader].
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
</parameters>
@@ -66043,13 +69626,13 @@ shader in gtk_snapshot_push_gl_shader().
<function name="gtk_snapshot_new">
<description>
-Creates a new #GtkSnapshot.
+Creates a new `GtkSnapshot`.
</description>
<parameters>
</parameters>
-<return> a newly-allocated #GtkSnapshot
+<return> a newly-allocated `GtkSnapshot`
</return>
</function>
@@ -66057,12 +69640,12 @@ Creates a new #GtkSnapshot.
<description>
Applies a perspective projection transform.
-See gsk_transform_perspective() for a discussion on the details.
+See [method@Gsk.Transform.perspective] for a discussion on the details.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="depth">
@@ -66081,7 +69664,7 @@ and appends it to the node underneath it.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
</parameters>
@@ -66090,18 +69673,20 @@ and appends it to the node underneath it.
<function name="gtk_snapshot_push_blend">
<description>
-Blends together 2 images with the given blend mode.
+Blends together two images with the given blend mode.
-Until the first call to gtk_snapshot_pop(), the bottom image for the
-blend operation will be recorded. After that call, the top image to
-be blended will be recorded until the second call to gtk_snapshot_pop().
+Until the first call to [method Gtk Snapshot pop], the
+bottom image for the blend operation will be recorded.
+After that call, the top image to be blended will be
+recorded until the second call to [method Gtk Snapshot pop].
-Calling this function requires 2 subsequent calls to gtk_snapshot_pop().
+Calling this function requires two subsequent calls
+to [method Gtk Snapshot pop].
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="blend_mode">
@@ -66116,12 +69701,12 @@ Calling this function requires 2 subsequent calls to gtk_snapshot_pop().
<description>
Blurs an image.
-The image is recorded until the next call to gtk_snapshot_pop().
+The image is recorded until the next call to [method Gtk Snapshot pop].
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="radius">
@@ -66136,12 +69721,12 @@ The image is recorded until the next call to gtk_snapshot_pop().
<description>
Clips an image to a rectangle.
-The image is recorded until the next call to gtk_snapshot_pop().
+The image is recorded until the next call to [method Gtk Snapshot pop].
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="bounds">
@@ -66154,9 +69739,9 @@ The image is recorded until the next call to gtk_snapshot_pop().
<function name="gtk_snapshot_push_collect">
<description>
-PRIVATE.
+Private.
-Puhses state so a later pop_collect call can collect all nodes
+Pushes state so a later pop_collect call can collect all nodes
appended until that point.
</description>
@@ -66170,12 +69755,12 @@ appended until that point.
Modifies the colors of an image by applying an affine transformation
in RGB space.
-The image is recorded until the next call to gtk_snapshot_pop().
+The image is recorded until the next call to [method Gtk Snapshot pop].
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="color_matrix">
@@ -66195,16 +69780,17 @@ The image is recorded until the next call to gtk_snapshot_pop().
Snapshots a cross-fade operation between two images with the
given @progress.
-Until the first call to gtk_snapshot_pop(), the start image
+Until the first call to [method Gtk Snapshot pop], the start image
will be snapshot. After that call, the end image will be recorded
-until the second call to gtk_snapshot_pop().
+until the second call to [method Gtk Snapshot pop].
-Calling this function requires 2 calls to gtk_snapshot_pop().
+Calling this function requires two subsequent calls
+to [method Gtk Snapshot pop].
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="progress">
@@ -66217,14 +69803,16 @@ Calling this function requires 2 calls to gtk_snapshot_pop().
<function name="gtk_snapshot_push_debug">
<description>
-Inserts a debug node with a message. Debug nodes don't affect
-the rendering at all, but can be helpful in identifying parts
-of a render node tree dump, for example in the GTK inspector.
+Inserts a debug node with a message.
+
+Debug nodes don't affect the rendering at all, but can be
+helpful in identifying parts of a render node tree dump,
+for example in the GTK inspector.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="message">
@@ -66241,38 +69829,45 @@ of a render node tree dump, for example in the GTK inspector.
<function name="gtk_snapshot_push_gl_shader">
<description>
-Push a #GskGLShaderNode with a specific #GskGLShader and a set of uniform values
-to use while rendering. Additionally this takes a list of @n_children other nodes
-which will be passed to the #GskGLShaderNode.
+Push a `GskGLShaderNode`.
+
+The node uses the given [class@Gsk.GLShader] and uniform values
+Additionally this takes a list of @n_children other nodes
+which will be passed to the `GskGLShaderNode`.
The @take_args argument is a block of data to use for uniform
-arguments, as per types and offsets defined by the @shader. Normally this is
-generated by gsk_gl_shader_format_args() or #GskGLShaderArgBuilder.
-The snapshotter takes ownership of @take_args, so the caller should not free it
-after this.
+arguments, as per types and offsets defined by the @shader.
+Normally this is generated by [method@Gsk.GLShader.format_args]
+or [struct@Gsk.ShaderArgsBuilder].
-If the renderer doesn't support GL shaders, or if there is any problem when
-compiling the shader, then the node will draw pink. You should use
-gsk_gl_shader_compile() to ensure the @shader will work for the renderer
-before using it.
+The snapshotter takes ownership of @take_args, so the caller should
+not free it after this.
-If the shader requires textures (see gsk_gl_shader_get_n_textures()), then it is
-expected that you call gtk_snapshot_gl_shader_pop_texture() the number of times that are
-required. Each of these calls will generate a node that is added as a child to the gl shader
-node, which in turn will render these offscreen and pass as a texture to the shader.
+If the renderer doesn't support GL shaders, or if there is any
+problem when compiling the shader, then the node will draw pink.
+You should use [method@Gsk.GLShader.compile] to ensure the @shader
+will work for the renderer before using it.
-Once all textures (if any) are pop:ed, you must call the regular gtk_snapshot_pop().
+If the shader requires textures (see [method@Gsk.GLShader.get_n_textures]),
+then it is expected that you call [method@Gtk.Snapshot.gl_shader_pop_texture]
+the number of times that are required. Each of these calls will generate
+a node that is added as a child to the `GskGLShaderNode`, which in turn
+will render these offscreen and pass as a texture to the shader.
-If you want to use pre-existing textures as input to the shader rather than
-rendering new ones, use gtk_snapshot_append_texture() to push a texture node. These
-will be used directly rather than being re-rendered.
+Once all textures (if any) are pop:ed, you must call the regular
+[method Gtk Snapshot pop].
-For details on how to write shaders, see #GskGLShader.
+If you want to use pre-existing textures as input to the shader rather
+than rendering new ones, use [method@Gtk.Snapshot.append_texture] to
+push a texture node. These will be used directly rather than being
+re-rendered.
+
+For details on how to write shaders, see [class@Gsk.GLShader].
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="shader">
@@ -66295,12 +69890,12 @@ For details on how to write shaders, see #GskGLShader.
<description>
Modifies the opacity of an image.
-The image is recorded until the next call to gtk_snapshot_pop().
+The image is recorded until the next call to [method Gtk Snapshot pop].
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="opacity">
@@ -66315,12 +69910,12 @@ The image is recorded until the next call to gtk_snapshot_pop().
<description>
Creates a node that repeats the child node.
-The child is recorded until the next call to gtk_snapshot_pop().
+The child is recorded until the next call to [method Gtk Snapshot pop].
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="bounds">
@@ -66340,12 +69935,12 @@ to use the full size of the collected child node
<description>
Clips an image to a rounded rectangle.
-The image is recorded until the next call to gtk_snapshot_pop().
+The image is recorded until the next call to [method Gtk Snapshot pop].
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="bounds">
@@ -66360,12 +69955,12 @@ The image is recorded until the next call to gtk_snapshot_pop().
<description>
Applies a shadow to an image.
-The image is recorded until the next call to gtk_snapshot_pop().
+The image is recorded until the next call to [method Gtk Snapshot pop].
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="shadow">
@@ -66389,11 +69984,11 @@ the current node.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="context">
-<parameter_description> the #GtkStyleContext to use
+<parameter_description> the `GtkStyleContext` to use
</parameter_description>
</parameter>
<parameter name="x">
@@ -66425,11 +70020,11 @@ the current node.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="context">
-<parameter_description> the #GtkStyleContext to use
+<parameter_description> the `GtkStyleContext` to use
</parameter_description>
</parameter>
<parameter name="x">
@@ -66461,11 +70056,11 @@ the current node.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="context">
-<parameter_description> the #GtkStyleContext to use
+<parameter_description> the `GtkStyleContext` to use
</parameter_description>
</parameter>
<parameter name="x">
@@ -66499,7 +70094,7 @@ Draws a text caret using @snapshot at the specified index of @layout.
</parameter_description>
</parameter>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
<parameter name="x">
@@ -66511,7 +70106,7 @@ Draws a text caret using @snapshot at the specified index of @layout.
</parameter_description>
</parameter>
<parameter name="layout">
-<parameter_description> the #PangoLayout of the text
+<parameter_description> the `PangoLayout` of the text
</parameter_description>
</parameter>
<parameter name="index">
@@ -66535,11 +70130,11 @@ without changing the current node.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="context">
-<parameter_description> the #GtkStyleContext to use
+<parameter_description> the `GtkStyleContext` to use
</parameter_description>
</parameter>
<parameter name="x">
@@ -66567,7 +70162,7 @@ saved states.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
</parameters>
@@ -66577,12 +70172,14 @@ saved states.
<function name="gtk_snapshot_rotate">
<description>
Rotates @@snapshot's coordinate system by @angle degrees in 2D space -
-or in 3D speak, rotates around the z axis.
+or in 3D speak, rotates around the Z axis.
+
+To rotate around other axes, use [method@Gsk.Transform.rotate_3d].
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="angle">
@@ -66597,12 +70194,12 @@ or in 3D speak, rotates around the z axis.
<description>
Rotates @snapshot's coordinate system by @angle degrees around @axis.
-For a rotation in 2D space, use gsk_transform_rotate().
+For a rotation in 2D space, use [method@Gsk.Transform.rotate].
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="angle">
@@ -66620,20 +70217,21 @@ For a rotation in 2D space, use gsk_transform_rotate().
<function name="gtk_snapshot_save">
<description>
Makes a copy of the current state of @snapshot and saves it
-on an internal stack of saved states for @snapshot. When
-gtk_snapshot_restore() is called, @snapshot will be restored to
-the saved state. Multiple calls to gtk_snapshot_save() and
-gtk_snapshot_restore() can be nested; each call to
-gtk_snapshot_restore() restores the state from the matching paired
-gtk_snapshot_save().
+on an internal stack.
+
+When [method@Gtk.Snapshot.restore] is called, @snapshot will
+be restored to the saved state. Multiple calls to
+gtk_snapshot_save() and gtk_snapshot_restore() can be nested;
+each call to gtk_snapshot_restore() restores the state from
+the matching paired gtk_snapshot_save().
-It is necessary to clear all saved states with corresponding calls
-to gtk_snapshot_restore().
+It is necessary to clear all saved states with corresponding
+calls to gtk_snapshot_restore().
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
</parameters>
@@ -66645,12 +70243,12 @@ to gtk_snapshot_restore().
Scales @snapshot's coordinate system in 2-dimensional space by
the given factors.
-Use gtk_snapshot_scale_3d() to scale in all 3 dimensions.
+Use [method@Gtk.Snapshot.scale_3d] to scale in all 3 dimensions.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="factor_x">
@@ -66672,7 +70270,7 @@ Scales @snapshot's coordinate system by the given factors.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="factor_x">
@@ -66694,36 +70292,38 @@ Scales @snapshot's coordinate system by the given factors.
<function name="gtk_snapshot_to_node">
<description>
Returns the render node that was constructed
-by @snapshot. After calling this function, it
-is no longer possible to add more nodes to
-@snapshot. The only function that should be
-called after this is g_object_unref().
+by @snapshot.
+
+After calling this function, it is no longer possible to
+add more nodes to @snapshot. The only function that should
+be called after this is g_object_unref().
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
</parameters>
-<return> the constructed #GskRenderNode
+<return> the constructed `GskRenderNode`
</return>
</function>
<function name="gtk_snapshot_to_paintable">
<description>
Returns a paintable encapsulating the render node
-that was constructed by @snapshot. After calling
-this function, it is no longer possible to add more
-nodes to @snapshot. The only function that should be
-called after this is g_object_unref().
+that was constructed by @snapshot.
+
+After calling this function, it is no longer possible to
+add more nodes to @snapshot. The only function that should
+be called after this is g_object_unref().
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="size">
@@ -66743,7 +70343,7 @@ Transforms @snapshot's coordinate system with the given @transform.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="transform">
@@ -66761,7 +70361,7 @@ Transforms @snapshot's coordinate system with the given @matrix.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="matrix">
@@ -66779,7 +70379,7 @@ Translates @snapshot's coordinate system by @point in 2-dimensional space.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="point">
@@ -66797,7 +70397,7 @@ Translates @snapshot's coordinate system by @point.
</description>
<parameters>
<parameter name="snapshot">
-<parameter_description> a #GtkSnapshot
+<parameter_description> a `GtkSnapshot`
</parameter_description>
</parameter>
<parameter name="point">
@@ -66810,14 +70410,15 @@ Translates @snapshot's coordinate system by @point.
<function name="gtk_sort_list_model_get_incremental">
<description>
-Returns whether incremental sorting was enabled via
-gtk_sort_list_model_set_incremental().
+Returns whether incremental sorting is enabled.
+
+See [method@Gtk.SortListModel.set_incremental].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSortListModel
+<parameter_description> a `GtkSortListModel`
</parameter_description>
</parameter>
</parameters>
@@ -66833,7 +70434,7 @@ Gets the model currently sorted or %NULL if none.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSortListModel
+<parameter_description> a `GtkSortListModel`
</parameter_description>
</parameter>
</parameters>
@@ -66843,7 +70444,7 @@ Gets the model currently sorted or %NULL if none.
<function name="gtk_sort_list_model_get_pending">
<description>
-Estimates progress of an ongoing sorting operation
+Estimates progress of an ongoing sorting operation.
The estimate is the number of items that would still need to be
sorted to finish the sorting operation if this was a linear
@@ -66851,20 +70452,21 @@ algorithm. So this number is not related to how many items are
already correctly sorted.
If you want to estimate the progress, you can use code like this:
-|[<!-- language="C" -->
+```c
pending = gtk_sort_list_model_get_pending (self);
model = gtk_sort_list_model_get_model (self);
progress = 1.0 - pending / (double) MAX (1, g_list_model_get_n_items (model));
-]|
+```
If no sort operation is ongoing - in particular when
-#GtkSortListModel:incremental is %FALSE - this function returns 0.
+[property@Gtk.SortListModel:incremental] is %FALSE - this
+function returns 0.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSortListModel
+<parameter_description> a `GtkSortListModel`
</parameter_description>
</parameter>
</parameters>
@@ -66880,7 +70482,7 @@ Gets the sorter that is used to sort @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSortListModel
+<parameter_description> a `GtkSortListModel`
</parameter_description>
</parameter>
</parameters>
@@ -66900,11 +70502,11 @@ Creates a new sort list model that uses the @sorter to sort @model.
</parameter_description>
</parameter>
<parameter name="sorter">
-<parameter_description> the #GtkSorter to sort @model with, or %NULL
+<parameter_description> the `GtkSorter` to sort @model with, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkSortListModel
+<return> a new `GtkSortListModel`
</return>
</function>
@@ -66912,7 +70514,7 @@ Creates a new sort list model that uses the @sorter to sort @model.
<description>
Sets the sort model to do an incremental sort.
-When incremental sorting is enabled, the sortlistmodel will not do
+When incremental sorting is enabled, the `GtkSortListModel` will not do
a complete sort immediately, but will instead queue an idle handler that
incrementally sorts the items towards their correct position. This of
course means that items do not instantly appear in the right place. It
@@ -66924,13 +70526,13 @@ interesting around 10,000 to 100,000 items.
By default, incremental sorting is disabled.
-See gtk_sort_list_model_get_pending() for progress information
+See [method@Gtk.SortListModel.get_pending] for progress information
about an ongoing incremental sorting operation.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSortListModel
+<parameter_description> a `GtkSortListModel`
</parameter_description>
</parameter>
<parameter name="incremental">
@@ -66943,13 +70545,14 @@ about an ongoing incremental sorting operation.
<function name="gtk_sort_list_model_set_model">
<description>
-Sets the model to be sorted. The @model's item type must conform to
-the item type of @self.
+Sets the model to be sorted.
+
+The @model's item type must conform to the item type of @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSortListModel
+<parameter_description> a `GtkSortListModel`
</parameter_description>
</parameter>
<parameter name="model">
@@ -66967,11 +70570,11 @@ Sets a new sorter on @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSortListModel
+<parameter_description> a `GtkSortListModel`
</parameter_description>
</parameter>
<parameter name="sorter">
-<parameter_description> the #GtkSorter to sort @model with
+<parameter_description> the `GtkSorter` to sort @model with
</parameter_description>
</parameter>
</parameters>
@@ -66980,21 +70583,23 @@ Sets a new sorter on @self.
<function name="gtk_sorter_changed">
<description>
-Emits the #GtkSorter::changed signal to notify all users of the sorter
-that it has changed. Users of the sorter should then update the sort
-order via gtk_sorter_compare().
+Emits the [signal@Gtk.Sorter::changed] signal to notify all users
+of the sorter that it has changed.
+
+Users of the sorter should then update the sort order via
+gtk_sorter_compare().
Depending on the @change parameter, it may be possible to update
-the sort order without a full resorting. Refer to the #GtkSorterChange
-documentation for details.
+the sort order without a full resorting. Refer to the
+[enum@Gtk.SorterChange] documentation for details.
-This function is intended for implementors of #GtkSorter subclasses and
-should not be called from other functions.
+This function is intended for implementors of `GtkSorter`
+subclasses and should not be called from other functions.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSorter
+<parameter_description> a `GtkSorter`
</parameter_description>
</parameter>
<parameter name="change">
@@ -67011,19 +70616,20 @@ Compares two given items according to the sort order implemented
by the sorter.
Sorters implement a partial order:
+
* It is reflexive, ie a = a
* It is antisymmetric, ie if a < b and b < a, then a = b
* It is transitive, ie given any 3 items with a ≤ b and b ≤ c,
then a ≤ c
-The sorter may signal it conforms to additional constraints
-via the return value of gtk_sorter_get_order().
+The sorter may signal it conforms to additional constraints
+via the return value of [method@Gtk.Sorter.get_order].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSorter
+<parameter_description> a `GtkSorter`
</parameter_description>
</parameter>
<parameter name="item1">
@@ -67043,7 +70649,9 @@ via the return value of gtk_sorter_get_order().
<function name="gtk_sorter_get_order">
<description>
-Gets the order that @self conforms to. See #GtkSorterOrder for details
+Gets the order that @self conforms to.
+
+See [enum@Gtk.SorterOrder] for details
of the possible return values.
This function is intended to allow optimizations.
@@ -67052,7 +70660,7 @@ This function is intended to allow optimizations.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSorter
+<parameter_description> a `GtkSorter`
</parameter_description>
</parameter>
</parameters>
@@ -67062,17 +70670,19 @@ This function is intended to allow optimizations.
<function name="gtk_spin_button_configure">
<description>
-Changes the properties of an existing spin button. The adjustment,
-climb rate, and number of decimal places are updated accordingly.
+Changes the properties of an existing spin button.
+
+The adjustment, climb rate, and number of decimal places
+are updated accordingly.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment to replace the spin button’s
+<parameter_description> a `GtkAdjustment` to replace the spin button’s
existing adjustment, or %NULL to leave its current adjustment unchanged
</parameter_description>
</parameter>
@@ -67090,17 +70700,17 @@ existing adjustment, or %NULL to leave its current adjustment unchanged
<function name="gtk_spin_button_get_adjustment">
<description>
-Get the adjustment associated with a #GtkSpinButton
+Get the adjustment associated with a `GtkSpinButton`.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkAdjustment of @spin_button
+<return> the `GtkAdjustment` of @spin_button
</return>
</function>
@@ -67112,7 +70722,7 @@ Returns the acceleration rate for repeated changes.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
</parameters>
@@ -67122,13 +70732,13 @@ Returns the acceleration rate for repeated changes.
<function name="gtk_spin_button_get_digits">
<description>
-Fetches the precision of @spin_button. See gtk_spin_button_set_digits().
+Fetches the precision of @spin_button.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
</parameters>
@@ -67138,13 +70748,15 @@ Fetches the precision of @spin_button. See gtk_spin_button_set_digits().
<function name="gtk_spin_button_get_increments">
<description>
-Gets the current step and page the increments used by @spin_button. See
-gtk_spin_button_set_increments().
+Gets the current step and page the increments
+used by @spin_button.
+
+See [method@Gtk.SpinButton.set_increments].
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
<parameter name="step">
@@ -67162,13 +70774,12 @@ gtk_spin_button_set_increments().
<function name="gtk_spin_button_get_numeric">
<description>
Returns whether non-numeric text can be typed into the spin button.
-See gtk_spin_button_set_numeric().
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
</parameters>
@@ -67179,12 +70790,13 @@ See gtk_spin_button_set_numeric().
<function name="gtk_spin_button_get_range">
<description>
Gets the range allowed for @spin_button.
-See gtk_spin_button_set_range().
+
+See [method@Gtk.SpinButton.set_range].
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
<parameter name="min">
@@ -67202,13 +70814,12 @@ See gtk_spin_button_set_range().
<function name="gtk_spin_button_get_snap_to_ticks">
<description>
Returns whether the values are corrected to the nearest step.
-See gtk_spin_button_set_snap_to_ticks().
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
</parameters>
@@ -67219,13 +70830,14 @@ See gtk_spin_button_set_snap_to_ticks().
<function name="gtk_spin_button_get_update_policy">
<description>
Gets the update behavior of a spin button.
-See gtk_spin_button_set_update_policy().
+
+See [method@Gtk.SpinButton.set_update_policy].
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
</parameters>
@@ -67241,7 +70853,7 @@ Get the value in the @spin_button.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
</parameters>
@@ -67257,7 +70869,7 @@ Get the value @spin_button represented as an integer.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
</parameters>
@@ -67269,13 +70881,13 @@ Get the value @spin_button represented as an integer.
<description>
Returns whether the spin button’s value wraps around to the
opposite limit when the upper or lower limit of the range is
-exceeded. See gtk_spin_button_set_wrap().
+exceeded.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
</parameters>
@@ -67285,13 +70897,13 @@ exceeded. See gtk_spin_button_set_wrap().
<function name="gtk_spin_button_new">
<description>
-Creates a new #GtkSpinButton.
+Creates a new `GtkSpinButton`.
</description>
<parameters>
<parameter name="adjustment">
-<parameter_description> the #GtkAdjustment object that this spin
+<parameter_description> the `GtkAdjustment` that this spin
button should use, or %NULL
</parameter_description>
</parameter>
@@ -67305,21 +70917,25 @@ accelerate if you continue to hold down an up/down button or arrow key
</parameter_description>
</parameter>
</parameters>
-<return> The new spin button as a #GtkWidget
+<return> The new `GtkSpinButton`
</return>
</function>
<function name="gtk_spin_button_new_with_range">
<description>
-This is a convenience constructor that allows creation of a numeric
-#GtkSpinButton without manually creating an adjustment. The value is
-initially set to the minimum value and a page increment of 10 * @step
-is the default. The precision of the spin button is equivalent to the
+Creates a new `GtkSpinButton` with the given properties.
+
+This is a convenience constructor that allows creation
+of a numeric `GtkSpinButton` without manually creating
+an adjustment. The value is initially set to the minimum
+value and a page increment of 10 * @step is the default.
+The precision of the spin button is equivalent to the
precision of @step.
-Note that the way in which the precision is derived works best if @step
-is a power of ten. If the resulting precision is not suitable for your
-needs, use gtk_spin_button_set_digits() to correct it.
+Note that the way in which the precision is derived works
+best if @step is a power of ten. If the resulting precision
+is not suitable for your needs, use
+[method@Gtk.SpinButton.set_digits] to correct it.
</description>
@@ -67337,22 +70953,22 @@ needs, use gtk_spin_button_set_digits() to correct it.
</parameter_description>
</parameter>
</parameters>
-<return> The new spin button as a #GtkWidget
+<return> The new `GtkSpinButton`
</return>
</function>
<function name="gtk_spin_button_set_adjustment">
<description>
-Replaces the #GtkAdjustment associated with @spin_button.
+Replaces the `GtkAdjustment` associated with @spin_button.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment to replace the existing adjustment
+<parameter_description> a `GtkAdjustment` to replace the existing adjustment
</parameter_description>
</parameter>
</parameters>
@@ -67367,7 +70983,7 @@ hold down a button or key.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
<parameter name="climb_rate">
@@ -67380,17 +70996,19 @@ hold down a button or key.
<function name="gtk_spin_button_set_digits">
<description>
-Set the precision to be displayed by @spin_button. Up to 20 digit precision
-is allowed.
+Set the precision to be displayed by @spin_button.
+
+Up to 20 digit precision is allowed.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
<parameter name="digits">
-<parameter_description> the number of digits after the decimal point to be displayed for the spin button’s
value
+<parameter_description> the number of digits after the decimal point to be
+displayed for the spin button’s value
</parameter_description>
</parameter>
</parameters>
@@ -67399,13 +71017,15 @@ is allowed.
<function name="gtk_spin_button_set_increments">
<description>
-Sets the step and page increments for spin_button. This affects how
-quickly the value changes when the spin button’s arrows are activated.
+Sets the step and page increments for spin_button.
+
+This affects how quickly the value changes when
+the spin button’s arrows are activated.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
<parameter name="step">
@@ -67428,7 +71048,7 @@ into the spin button.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
<parameter name="numeric">
@@ -67449,7 +71069,7 @@ to fit within the range, otherwise it will remain unchanged.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
<parameter name="min">
@@ -67473,7 +71093,7 @@ providing an invalid value.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
<parameter name="snap_to_ticks">
@@ -67487,17 +71107,18 @@ providing an invalid value.
<function name="gtk_spin_button_set_update_policy">
<description>
Sets the update behavior of a spin button.
-This determines whether the spin button is always updated
-or only when a valid value is set.
+
+This determines whether the spin button is always
+updated or only when a valid value is set.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
<parameter name="policy">
-<parameter_description> a #GtkSpinButtonUpdatePolicy value
+<parameter_description> a `GtkSpinButtonUpdatePolicy` value
</parameter_description>
</parameter>
</parameters>
@@ -67511,7 +71132,7 @@ Sets the value of @spin_button.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
<parameter name="value">
@@ -67531,7 +71152,7 @@ of the range is exceeded.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
<parameter name="wrap">
@@ -67550,11 +71171,11 @@ direction by a specified amount.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
<parameter name="direction">
-<parameter_description> a #GtkSpinType indicating the direction to spin
+<parameter_description> a `GtkSpinType` indicating the direction to spin
</parameter_description>
</parameter>
<parameter name="increment">
@@ -67572,7 +71193,7 @@ Manually force an update of the spin button.
</description>
<parameters>
<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter_description> a `GtkSpinButton`
</parameter_description>
</parameter>
</parameters>
@@ -67587,7 +71208,7 @@ Returns whether the spinner is spinning.
</description>
<parameters>
<parameter name="spinner">
-<parameter_description> a #GtkSpinner
+<parameter_description> a `GtkSpinner`
</parameter_description>
</parameter>
</parameters>
@@ -67603,7 +71224,7 @@ Returns a new spinner widget. Not yet started.
</description>
<parameters>
</parameters>
-<return> a new #GtkSpinner
+<return> a new `GtkSpinner`
</return>
</function>
@@ -67614,7 +71235,7 @@ Sets the activity of the spinner.
</description>
<parameters>
<parameter name="spinner">
-<parameter_description> a #GtkSpinner
+<parameter_description> a `GtkSpinner`
</parameter_description>
</parameter>
<parameter name="spinning">
@@ -67632,7 +71253,7 @@ Starts the animation of the spinner.
</description>
<parameters>
<parameter name="spinner">
-<parameter_description> a #GtkSpinner
+<parameter_description> a `GtkSpinner`
</parameter_description>
</parameter>
</parameters>
@@ -67646,7 +71267,7 @@ Stops the animation of the spinner.
</description>
<parameters>
<parameter name="spinner">
-<parameter_description> a #GtkSpinner
+<parameter_description> a `GtkSpinner`
</parameter_description>
</parameter>
</parameters>
@@ -67661,7 +71282,7 @@ Adds a child to @stack.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
<parameter name="child">
@@ -67669,20 +71290,21 @@ Adds a child to @stack.
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkStackPage for @child
+<return> the `GtkStackPage` for @child
</return>
</function>
<function name="gtk_stack_add_named">
<description>
Adds a child to @stack.
+
The child is identified by the @name.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
<parameter name="child">
@@ -67694,22 +71316,23 @@ The child is identified by the @name.
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkStackPage for @child
+<return> the `GtkStackPage` for @child
</return>
</function>
<function name="gtk_stack_add_titled">
<description>
Adds a child to @stack.
+
The child is identified by the @name. The @title
-will be used by #GtkStackSwitcher to represent
+will be used by `GtkStackSwitcher` to represent
@child in a tab bar, so it should be short.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
<parameter name="child">
@@ -67725,21 +71348,19 @@ will be used by #GtkStackSwitcher to represent
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkStackPage for @child
+<return> the `GtkStackPage` for @child
</return>
</function>
<function name="gtk_stack_get_child_by_name">
<description>
-Finds the child of the #GtkStack with the name given as
-the argument. Returns %NULL if there is no child with this
-name.
+Finds the child with the name given as the argument.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
<parameter name="name">
@@ -67747,20 +71368,20 @@ name.
</parameter_description>
</parameter>
</parameters>
-<return> the requested child of the #GtkStack
+<return> the requested child
+of the `GtkStack`
</return>
</function>
<function name="gtk_stack_get_hhomogeneous">
<description>
Gets whether @stack is horizontally homogeneous.
-See gtk_stack_set_hhomogeneous().
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
</parameters>
@@ -67777,7 +71398,7 @@ the sizes of children on page switch.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> A #GtkStack
+<parameter_description> A `GtkStack`
</parameter_description>
</parameter>
</parameters>
@@ -67787,13 +71408,13 @@ the sizes of children on page switch.
<function name="gtk_stack_get_page">
<description>
-Returns the #GtkStackPage object for @child.
+Returns the `GtkStackPage` object for @child.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
<parameter name="child">
@@ -67801,26 +71422,27 @@ Returns the #GtkStackPage object for @child.
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkStackPage for @child
+<return> the `GtkStackPage` for @child
</return>
</function>
<function name="gtk_stack_get_pages">
<description>
-Returns a #GListModel that contains the pages of the stack,
-and can be used to keep an up-to-date view. The model also
-implements #GtkSelectionModel and can be used to track and
-modify the visible page.
+Returns a `GListModel` that contains the pages of the stack.
+
+This can be used to keep an up-to-date view. The model also
+implements [iface@Gtk.SelectionModel] and can be used to track
+and modify the visible page.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkSelectionModel for the stack's children
+<return> a `GtkSelectionModel` for the stack's children
</return>
</function>
@@ -67833,7 +71455,7 @@ transitions between pages in @stack will take.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
</parameters>
@@ -67850,7 +71472,7 @@ another.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
</parameters>
@@ -67867,7 +71489,7 @@ for transitions between pages in @stack.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
</parameters>
@@ -67878,13 +71500,12 @@ for transitions between pages in @stack.
<function name="gtk_stack_get_vhomogeneous">
<description>
Gets whether @stack is vertically homogeneous.
-See gtk_stack_set_vhomogeneous().
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
</parameters>
@@ -67894,47 +71515,46 @@ See gtk_stack_set_vhomogeneous().
<function name="gtk_stack_get_visible_child">
<description>
-Gets the currently visible child of @stack, or %NULL if
-there are no visible children.
+Gets the currently visible child of @stack.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
</parameters>
-<return> the visible child of the #GtkStack
+<return> the visible child of the `GtkStack`
</return>
</function>
<function name="gtk_stack_get_visible_child_name">
<description>
-Returns the name of the currently visible child of @stack, or
-%NULL if there is no visible child.
+Returns the name of the currently visible child of @stack.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
</parameters>
-<return> the name of the visible child of the #GtkStack
+<return> the name of the visible child
+of the `GtkStack`
</return>
</function>
<function name="gtk_stack_new">
<description>
-Creates a new #GtkStack container.
+Creates a new `GtkStack`.
</description>
<parameters>
</parameters>
-<return> a new #GtkStack
+<return> a new `GtkStack`
</return>
</function>
@@ -67946,7 +71566,7 @@ Returns the stack child to which @self belongs.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStackPage
+<parameter_description> a `GtkStackPage`
</parameter_description>
</parameter>
</parameters>
@@ -67956,100 +71576,97 @@ Returns the stack child to which @self belongs.
<function name="gtk_stack_page_get_icon_name">
<description>
-Returns the current value of the #GtkStackPage:icon-name property.
+Returns the icon name of the page.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStackPage
+<parameter_description> a `GtkStackPage`
</parameter_description>
</parameter>
</parameters>
-<return> The value of the #GtkStackPage:icon-name property.
-See gtk_stack_page_set_icon_name() for details on how to set a new value.
+<return> The value of the [property@Gtk.StackPage:icon-name] property
</return>
</function>
<function name="gtk_stack_page_get_name">
<description>
-Returns the current value of the #GtkStackPage:name property.
+Returns the name of the page.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStackPage
+<parameter_description> a `GtkStackPage`
</parameter_description>
</parameter>
</parameters>
-<return> The value of the #GtkStackPage:name property.
-See gtk_stack_page_set_name() for details on how to set a new value.
+<return> The value of the [property@Gtk.StackPage:name] property
</return>
</function>
<function name="gtk_stack_page_get_needs_attention">
<description>
-Returns the current value of the #GtkStackPage:needs-attention property.
+Returns whether the page is marked as “needs attention”.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStackPage
+<parameter_description> a `GtkStackPage`
</parameter_description>
</parameter>
</parameters>
-<return> The value of the #GtkStackPage:needs-attention property.
-See gtk_stack_page_set_needs_attention() for details on how to set a new value.
+<return> The value of the [property@Gtk.StackPage:needs-attention]
+property.
</return>
</function>
<function name="gtk_stack_page_get_title">
<description>
-Returns the current value of the #GtkStackPage:title property.
+Gets the page title.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStackPage
+<parameter_description> a `GtkStackPage`
</parameter_description>
</parameter>
</parameters>
-<return> The value of the #GtkStackPage:title property.
-See gtk_stack_page_set_title() for details on how to set a new value.
+<return> The value of the [property@Gtk.StackPage:title] property
</return>
</function>
<function name="gtk_stack_page_get_use_underline">
<description>
-Returns the current value of the #GtkStackPage:use-underline property.
+Gets whether underlines in the page title indicate mnemonics.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStackPage
+<parameter_description> a `GtkStackPage`
</parameter_description>
</parameter>
</parameters>
-<return> The value of the #GtkStackPage:use-underline property.
-See gtk_stack_page_set_use_underline() for details on how to set a new value.
+<return> The value of the [property@Gtk.StackPage:use-underline] property
</return>
</function>
<function name="gtk_stack_page_get_visible">
<description>
-Returns whether @page is visible in its #GtkStack.
-This is independent from the #GtkWidget:visible value of its
-#GtkWidget.
+Returns whether @page is visible in its `GtkStack`.
+
+This is independent from the [property@Gtk.Widget:visible]
+property of its widget.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStackPage
+<parameter_description> a `GtkStackPage`
</parameter_description>
</parameter>
</parameters>
@@ -68059,13 +71676,12 @@ This is independent from the #GtkWidget:visible value of its
<function name="gtk_stack_page_set_icon_name">
<description>
-Sets the new value of the #GtkStackPage:icon-name property.
-See also gtk_stack_page_get_icon_name()
+Sets the icon name of the page.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStackPage
+<parameter_description> a `GtkStackPage`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -68078,13 +71694,12 @@ See also gtk_stack_page_get_icon_name()
<function name="gtk_stack_page_set_name">
<description>
-Sets the new value of the #GtkStackPage:name property.
-See also gtk_stack_page_get_name()
+Sets the name of the page.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStackPage
+<parameter_description> a `GtkStackPage`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -68097,14 +71712,12 @@ See also gtk_stack_page_get_name()
<function name="gtk_stack_page_set_needs_attention">
<description>
-Sets the new value of the #GtkStackPage:needs-attention property.
-See also gtk_stack_page_get_needs_attention()
-
+Sets whether the page is marked as “needs attention”.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStackPage
+<parameter_description> a `GtkStackPage`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -68117,13 +71730,12 @@ See also gtk_stack_page_get_needs_attention()
<function name="gtk_stack_page_set_title">
<description>
-Sets the new value of the #GtkStackPage:title property.
-See also gtk_stack_page_get_title()
+Sets the page title.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStackPage
+<parameter_description> a `GtkStackPage`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -68136,14 +71748,12 @@ See also gtk_stack_page_get_title()
<function name="gtk_stack_page_set_use_underline">
<description>
-Sets the new value of the #GtkStackPage:use-underline property.
-See also gtk_stack_page_get_use_underline()
-
+Sets whether underlines in the page title indicate mnemonics.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStackPage
+<parameter_description> a `GtkStackPage`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -68156,13 +71766,12 @@ See also gtk_stack_page_get_use_underline()
<function name="gtk_stack_page_set_visible">
<description>
-Sets the new value of the #GtkStackPage:visible property
-to @visible.
+Sets whether @page is visible in its `GtkStack`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStackPage
+<parameter_description> a `GtkStackPage`
</parameter_description>
</parameter>
<parameter name="visible">
@@ -68180,7 +71789,7 @@ Removes a child widget from @stack.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
<parameter name="child">
@@ -68193,15 +71802,16 @@ Removes a child widget from @stack.
<function name="gtk_stack_set_hhomogeneous">
<description>
-Sets the #GtkStack to be horizontally homogeneous or not.
-If it is homogeneous, the #GtkStack will request the same
+Sets the `GtkStack` to be horizontally homogeneous or not.
+
+If it is homogeneous, the `GtkStack` will request the same
width for all its children. If it isn't, the stack
may change width when a different child becomes visible.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
<parameter name="hhomogeneous">
@@ -68215,15 +71825,17 @@ may change width when a different child becomes visible.
<function name="gtk_stack_set_interpolate_size">
<description>
Sets whether or not @stack will interpolate its size when
-changing the visible child. If the #GtkStack:interpolate-size
-property is set to %TRUE, @stack will interpolate its size between
-the current one and the one it'll take after changing the
-visible child, according to the set transition duration.
+changing the visible child.
+
+If the [property@Gtk.Stack:interpolate-size] property is set
+to %TRUE, @stack will interpolate its size between the current
+one and the one it'll take after changing the visible child,
+according to the set transition duration.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> A #GtkStack
+<parameter_description> A `GtkStack`
</parameter_description>
</parameter>
<parameter name="interpolate_size">
@@ -68242,7 +71854,7 @@ will take.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
<parameter name="duration">
@@ -68256,8 +71868,9 @@ will take.
<function name="gtk_stack_set_transition_type">
<description>
Sets the type of animation that will be used for
-transitions between pages in @stack. Available
-types include various kinds of fades and slides.
+transitions between pages in @stack.
+
+Available types include various kinds of fades and slides.
The transition type can be changed without problems
at runtime, so it is possible to change the animation
@@ -68266,7 +71879,7 @@ based on the page that is about to become current.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
<parameter name="transition">
@@ -68280,14 +71893,15 @@ based on the page that is about to become current.
<function name="gtk_stack_set_vhomogeneous">
<description>
Sets the #GtkStack to be vertically homogeneous or not.
-If it is homogeneous, the #GtkStack will request the same
+
+If it is homogeneous, the `GtkStack` will request the same
height for all its children. If it isn't, the stack
may change height when a different child becomes visible.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
<parameter name="vhomogeneous">
@@ -68302,19 +71916,18 @@ may change height when a different child becomes visible.
<description>
Makes @child the visible child of @stack.
-If @child is different from the currently
-visible child, the transition between the
-two will be animated with the current
-transition type of @stack.
+If @child is different from the currently visible child,
+the transition between the two will be animated with the
+current transition type of @stack.
Note that the @child widget has to be visible itself
-(see gtk_widget_show()) in order to become the visible
+(see [method Gtk Widget show]) in order to become the visible
child of @stack.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
<parameter name="child">
@@ -68330,13 +71943,13 @@ child of @stack.
Makes the child with the given name visible.
Note that the child widget has to be visible itself
-(see gtk_widget_show()) in order to become the visible
+(see [method Gtk Widget show]) in order to become the visible
child of @stack.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
<parameter name="name">
@@ -68355,19 +71968,18 @@ child of @stack.
<description>
Makes the child with the given name visible.
-If @child is different from the currently
-visible child, the transition between the
-two will be animated with the current
-transition type of @stack.
+If @child is different from the currently visible child,
+the transition between the two will be animated with the
+current transition type of @stack.
Note that the child widget has to be visible itself
-(see gtk_widget_show()) in order to become the visible
+(see [method Gtk Widget show]) in order to become the visible
child of @stack.
</description>
<parameters>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
<parameter name="name">
@@ -68381,13 +71993,12 @@ child of @stack.
<function name="gtk_stack_sidebar_get_stack">
<description>
Retrieves the stack.
-See gtk_stack_sidebar_set_stack().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStackSidebar
+<parameter_description> a `GtkStackSidebar`
</parameter_description>
</parameter>
</parameters>
@@ -68398,31 +72009,31 @@ See gtk_stack_sidebar_set_stack().
<function name="gtk_stack_sidebar_new">
<description>
-Creates a new sidebar.
+Creates a new `GtkStackSidebar`.
</description>
<parameters>
</parameters>
-<return> the new #GtkStackSidebar
+<return> the new `GtkStackSidebar`
</return>
</function>
<function name="gtk_stack_sidebar_set_stack">
<description>
-Set the #GtkStack associated with this #GtkStackSidebar.
+Set the `GtkStack` associated with this `GtkStackSidebar`.
-The sidebar widget will automatically update according to the order
-(packing) and items within the given #GtkStack.
+The sidebar widget will automatically update according to
+the order and items within the given `GtkStack`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStackSidebar
+<parameter_description> a `GtkStackSidebar`
</parameter_description>
</parameter>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
</parameters>
@@ -68432,13 +72043,12 @@ The sidebar widget will automatically update according to the order
<function name="gtk_stack_switcher_get_stack">
<description>
Retrieves the stack.
-See gtk_stack_switcher_set_stack().
</description>
<parameters>
<parameter name="switcher">
-<parameter_description> a #GtkStackSwitcher
+<parameter_description> a `GtkStackSwitcher`
</parameter_description>
</parameter>
</parameters>
@@ -68449,13 +72059,13 @@ none has been set explicitly.
<function name="gtk_stack_switcher_new">
<description>
-Create a new #GtkStackSwitcher.
+Create a new `GtkStackSwitcher`.
</description>
<parameters>
</parameters>
-<return> a new #GtkStackSwitcher.
+<return> a new `GtkStackSwitcher`.
</return>
</function>
@@ -68466,11 +72076,11 @@ Sets the stack to control.
</description>
<parameters>
<parameter name="switcher">
-<parameter_description> a #GtkStackSwitcher
+<parameter_description> a `GtkStackSwitcher`
</parameter_description>
</parameter>
<parameter name="stack">
-<parameter_description> a #GtkStack
+<parameter_description> a `GtkStack`
</parameter_description>
</parameter>
</parameters>
@@ -68479,19 +72089,20 @@ Sets the stack to control.
<function name="gtk_statusbar_get_context_id">
<description>
-Returns a new context identifier, given a description
-of the actual context. Note that the description is
-not shown in the UI.
+Returns a new context identifier, given a description
+of the actual context.
+
+Note that the description is not shown in the UI.
</description>
<parameters>
<parameter name="statusbar">
-<parameter_description> a #GtkStatusbar
+<parameter_description> a `GtkStatusbar`
</parameter_description>
</parameter>
<parameter name="context_description">
-<parameter_description> textual description of what context
+<parameter_description> textual description of what context
the new message is being used in
</parameter_description>
</parameter>
@@ -68502,13 +72113,13 @@ the new message is being used in
<function name="gtk_statusbar_get_message">
<description>
-Retrieves the contents of the label in #GtkStatusbar.
+Retrieves the contents of the label in `GtkStatusbar`.
</description>
<parameters>
<parameter name="statusbar">
-<parameter_description> a #GtkStatusbar
+<parameter_description> a `GtkStatusbar`
</parameter_description>
</parameter>
</parameters>
@@ -68518,29 +72129,29 @@ Retrieves the contents of the label in #GtkStatusbar.
<function name="gtk_statusbar_new">
<description>
-Creates a new #GtkStatusbar ready for messages.
+Creates a new `GtkStatusbar` ready for messages.
</description>
<parameters>
</parameters>
-<return> the new #GtkStatusbar
+<return> the new `GtkStatusbar`
</return>
</function>
<function name="gtk_statusbar_pop">
<description>
-Removes the first message in the #GtkStatusbar’s stack
-with the given context id.
+Removes the first message in the `GtkStatusbar`’s stack
+with the given context id.
-Note that this may not change the displayed message, if
-the message at the top of the stack has a different
+Note that this may not change the displayed message,
+if the message at the top of the stack has a different
context id.
</description>
<parameters>
<parameter name="statusbar">
-<parameter_description> a #GtkStatusbar
+<parameter_description> a `GtkStatusbar`
</parameter_description>
</parameter>
<parameter name="context_id">
@@ -68559,7 +72170,7 @@ Pushes a new message onto a statusbar’s stack.
</description>
<parameters>
<parameter name="statusbar">
-<parameter_description> a #GtkStatusbar
+<parameter_description> a `GtkStatusbar`
</parameter_description>
</parameter>
<parameter name="context_id">
@@ -68572,20 +72183,20 @@ gtk_statusbar_get_context_id()
</parameter_description>
</parameter>
</parameters>
-<return> a message id that can be used with
-gtk_statusbar_remove().
+<return> a message id that can be used with
+[method@Gtk.Statusbar.remove].
</return>
</function>
<function name="gtk_statusbar_remove">
<description>
-Forces the removal of a message from a statusbar’s stack.
+Forces the removal of a message from a statusbar’s stack.
The exact @context_id and @message_id must be specified.
</description>
<parameters>
<parameter name="statusbar">
-<parameter_description> a #GtkStatusbar
+<parameter_description> a `GtkStatusbar`
</parameter_description>
</parameter>
<parameter name="context_id">
@@ -68593,7 +72204,7 @@ The exact @context_id and @message_id must be specified.
</parameter_description>
</parameter>
<parameter name="message_id">
-<parameter_description> a message identifier, as returned by gtk_statusbar_push()
+<parameter_description> a message identifier, as returned by [method Gtk Statusbar push]
</parameter_description>
</parameter>
</parameters>
@@ -68608,7 +72219,7 @@ stack with the exact @context_id.
</description>
<parameters>
<parameter name="statusbar">
-<parameter_description> a #GtkStatusbar
+<parameter_description> a `GtkStatusbar`
</parameter_description>
</parameter>
<parameter name="context_id">
@@ -68628,11 +72239,11 @@ obtain strings from items.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringFilter
+<parameter_description> a `GtkStringFilter`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkExpression
+<return> a `GtkExpression`
</return>
</function>
@@ -68644,7 +72255,7 @@ Returns whether the filter ignores case differences.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringFilter
+<parameter_description> a `GtkStringFilter`
</parameter_description>
</parameter>
</parameters>
@@ -68660,7 +72271,7 @@ Returns the match mode that the filter is using.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringFilter
+<parameter_description> a `GtkStringFilter`
</parameter_description>
</parameter>
</parameters>
@@ -68670,17 +72281,17 @@ Returns the match mode that the filter is using.
<function name="gtk_string_filter_get_search">
<description>
-Gets the search string set via gtk_string_filter_set_search().
+Gets the search term.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringFilter
+<parameter_description> a `GtkStringFilter`
</parameter_description>
</parameter>
</parameters>
-<return> The search string
+<return> The search term
</return>
</function>
@@ -68700,24 +72311,25 @@ or %NULL for none
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkStringFilter
+<return> a new `GtkStringFilter`
</return>
</function>
<function name="gtk_string_filter_set_expression">
<description>
Sets the expression that the string filter uses to
-obtain strings from items. The expression must have
-a value type of #G_TYPE_STRING.
+obtain strings from items.
+
+The expression must have a value type of %G_TYPE_STRING.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringFilter
+<parameter_description> a `GtkStringFilter`
</parameter_description>
</parameter>
<parameter name="expression">
-<parameter_description> a #GtkExpression
+<parameter_description> a `GtkExpression`
</parameter_description>
</parameter>
</parameters>
@@ -68731,7 +72343,7 @@ Sets whether the filter ignores case differences.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringFilter
+<parameter_description> a `GtkStringFilter`
</parameter_description>
</parameter>
<parameter name="ignore_case">
@@ -68749,7 +72361,7 @@ Sets the match mode for the filter.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringFilter
+<parameter_description> a `GtkStringFilter`
</parameter_description>
</parameter>
<parameter name="mode">
@@ -68767,7 +72379,7 @@ Sets the string to search for.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringFilter
+<parameter_description> a `GtkStringFilter`
</parameter_description>
</parameter>
<parameter name="search">
@@ -68783,13 +72395,13 @@ or %NULL to clear the search
<description>
Appends @string to @self.
-The @string will be copied. See gtk_string_list_take()
-for a way to avoid that.
+The @string will be copied. See
+[method Gtk StringList take] for a way to avoid that.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringList
+<parameter_description> a `GtkStringList`
</parameter_description>
</parameter>
<parameter name="string">
@@ -68802,8 +72414,9 @@ for a way to avoid that.
<function name="gtk_string_list_get_string">
<description>
-Gets the string that is at @position in @self. If @self
-does not contain @position items, %NULL is returned.
+Gets the string that is at @position in @self.
+
+If @self does not contain @position items, %NULL is returned.
This function returns the const char *. To get the
object wrapping it, use g_list_model_get_item().
@@ -68812,7 +72425,7 @@ object wrapping it, use g_list_model_get_item().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringList
+<parameter_description> a `GtkStringList`
</parameter_description>
</parameter>
<parameter name="position">
@@ -68826,7 +72439,7 @@ object wrapping it, use g_list_model_get_item().
<function name="gtk_string_list_new">
<description>
-Creates a new #GtkStringList with the given @strings.
+Creates a new `GtkStringList` with the given @strings.
</description>
@@ -68836,19 +72449,21 @@ Creates a new #GtkStringList with the given @strings.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkStringList
+<return> a new `GtkStringList`
</return>
</function>
<function name="gtk_string_list_remove">
<description>
-Removes the string at @position from @self. @position must
-be smaller than the current length of the list.
+Removes the string at @position from @self.
+
+@position must be smaller than the current
+length of the list.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringList
+<parameter_description> a `GtkStringList`
</parameter_description>
</parameter>
<parameter name="position">
@@ -68864,9 +72479,9 @@ be smaller than the current length of the list.
Changes @self by removing @n_removals strings and adding @additions
to it.
-This function is more efficient than gtk_string_list_append() and
-gtk_string_list_remove(), because it only emits
-#GListModel::items-changed once for the change.
+This function is more efficient than [method@Gtk.StringList.append]
+and [method@Gtk.StringList.remove], because it only emits the
+::items-changed signal once for the change.
This function copies the strings in @additions.
@@ -68877,7 +72492,7 @@ of the list at the time this function is called).
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringList
+<parameter_description> a `GtkStringList`
</parameter_description>
</parameter>
<parameter name="position">
@@ -68901,17 +72516,17 @@ of the list at the time this function is called).
Adds @string to self at the end, and takes
ownership of it.
-This variant of gtk_string_list_append() is
-convenient for formatting strings:
+This variant of [method@Gtk.StringList.append]
+is convenient for formatting strings:
-|[
+```c
gtk_string_list_take (self, g_strdup_print ("%d dollars", lots));
-]|
+```
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringList
+<parameter_description> a `GtkStringList`
</parameter_description>
</parameter>
<parameter name="string">
@@ -68924,13 +72539,13 @@ gtk_string_list_take (self, g_strdup_print ("%d dollars", lots));
<function name="gtk_string_object_get_string">
<description>
-Returns the string contained in a #GtkStringObject.
+Returns the string contained in a `GtkStringObject`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringObject
+<parameter_description> a `GtkStringObject`
</parameter_description>
</parameter>
</parameters>
@@ -68940,7 +72555,7 @@ Returns the string contained in a #GtkStringObject.
<function name="gtk_string_object_new">
<description>
-Wraps a string in an object for use with #GListModel
+Wraps a string in an object for use with `GListModel`.
</description>
@@ -68950,7 +72565,7 @@ Wraps a string in an object for use with #GListModel
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkStringObject
+<return> a new `GtkStringObject`
</return>
</function>
@@ -68962,11 +72577,11 @@ Gets the expression that is evaluated to obtain strings from items.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringSorter
+<parameter_description> a `GtkStringSorter`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkExpression, or %NULL
+<return> a `GtkExpression`, or %NULL
</return>
</function>
@@ -68978,7 +72593,7 @@ Gets whether the sorter ignores case differences.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringSorter
+<parameter_description> a `GtkStringSorter`
</parameter_description>
</parameter>
</parameters>
@@ -69002,7 +72617,7 @@ compare items as invalid.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkStringSorter
+<return> a new `GtkStringSorter`
</return>
</function>
@@ -69010,16 +72625,16 @@ compare items as invalid.
<description>
Sets the expression that is evaluated to obtain strings from items.
-The expression must have the type G_TYPE_STRING.
+The expression must have the type %G_TYPE_STRING.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringSorter
+<parameter_description> a `GtkStringSorter`
</parameter_description>
</parameter>
<parameter name="expression">
-<parameter_description> a #GtkExpression, or %NULL
+<parameter_description> a `GtkExpression`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -69033,7 +72648,7 @@ Sets whether the sorter will ignore case differences.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkStringSorter
+<parameter_description> a `GtkStringSorter`
</parameter_description>
</parameter>
<parameter name="ignore_case">
@@ -69049,23 +72664,23 @@ Sets whether the sorter will ignore case differences.
Adds a style class to @context, so later uses of the
style context will make use of this new class for styling.
-In the CSS file format, a #GtkEntry defining a “search”
+In the CSS file format, a `GtkEntry` defining a “search”
class, would be matched by:
-|[ <!-- language="CSS" -->
+```css
entry.search { ... }
-]|
+```
While any widget defining a “search” class would be
matched by:
-|[ <!-- language="CSS" -->
+```css
.search { ... }
-]|
+```
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
<parameter name="class_name">
@@ -69079,30 +72694,31 @@ matched by:
<function name="gtk_style_context_add_provider">
<description>
Adds a style provider to @context, to be used in style construction.
+
Note that a style provider added by this function only affects
the style of the widget to which @context belongs. If you want
to affect the style of all widgets, use
-gtk_style_context_add_provider_for_display().
+[func@Gtk.StyleContext.add_provider_for_display].
-Note: If both priorities are the same, a #GtkStyleProvider
+Note: If both priorities are the same, a `GtkStyleProvider`
added through this function takes precedence over another added
-through gtk_style_context_add_provider_for_display().
+through [func@Gtk.StyleContext.add_provider_for_display].
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
<parameter name="provider">
-<parameter_description> a #GtkStyleProvider
+<parameter_description> a `GtkStyleProvider`
</parameter_description>
</parameter>
<parameter name="priority">
<parameter_description> the priority of the style provider. The lower
-it is, the earlier it will be used in the style
-construction. Typically this will be in the range
-between %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK and
+it is, the earlier it will be used in the style construction.
+Typically this will be in the range between
+%GTK_STYLE_PROVIDER_PRIORITY_FALLBACK and
%GTK_STYLE_PROVIDER_PRIORITY_USER
</parameter_description>
</parameter>
@@ -69113,30 +72729,30 @@ between %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK and
<function name="gtk_style_context_add_provider_for_display">
<description>
Adds a global style provider to @display, which will be used
-in style construction for all #GtkStyleContexts under @display.
+in style construction for all `GtkStyleContexts` under @display.
-GTK uses this to make styling information from #GtkSettings
+GTK uses this to make styling information from `GtkSettings`
available.
-Note: If both priorities are the same, A #GtkStyleProvider
-added through gtk_style_context_add_provider() takes precedence
-over another added through this function.
+Note: If both priorities are the same, A `GtkStyleProvider`
+added through [method@Gtk.StyleContext.add_provider] takes
+precedence over another added through this function.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
<parameter name="provider">
-<parameter_description> a #GtkStyleProvider
+<parameter_description> a `GtkStyleProvider`
</parameter_description>
</parameter>
<parameter name="priority">
<parameter_description> the priority of the style provider. The lower
-it is, the earlier it will be used in the style
-construction. Typically this will be in the range
-between %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK and
+it is, the earlier it will be used in the style construction.
+Typically this will be in the range between
+%GTK_STYLE_PROVIDER_PRIORITY_FALLBACK and
%GTK_STYLE_PROVIDER_PRIORITY_USER
</parameter_description>
</parameter>
@@ -69146,12 +72762,12 @@ between %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK and
<function name="gtk_style_context_get_border">
<description>
-Gets the border for a given state as a #GtkBorder.
+Gets the border for a given state as a `GtkBorder`.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
<parameter name="border">
@@ -69169,7 +72785,7 @@ Gets the foreground color for a given state.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
<parameter name="color">
@@ -69182,28 +72798,28 @@ Gets the foreground color for a given state.
<function name="gtk_style_context_get_display">
<description>
-Returns the #GdkDisplay to which @context is attached.
+Returns the `GdkDisplay` to which @context is attached.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDisplay.
+<return> a `GdkDisplay`.
</return>
</function>
<function name="gtk_style_context_get_margin">
<description>
-Gets the margin for a given state as a #GtkBorder.
+Gets the margin for a given state as a `GtkBorder`.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
<parameter name="margin">
@@ -69216,12 +72832,12 @@ Gets the margin for a given state as a #GtkBorder.
<function name="gtk_style_context_get_padding">
<description>
-Gets the padding for a given state as a #GtkBorder.
+Gets the padding for a given state as a `GtkBorder`.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
<parameter name="padding">
@@ -69240,7 +72856,7 @@ Returns the scale used for assets.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
</parameters>
@@ -69252,16 +72868,17 @@ Returns the scale used for assets.
<description>
Returns the state used for style matching.
-This method should only be used to retrieve the #GtkStateFlags
-to pass to #GtkStyleContext methods, like gtk_style_context_get_padding().
-If you need to retrieve the current state of a #GtkWidget, use
-gtk_widget_get_state_flags().
+This method should only be used to retrieve the `GtkStateFlags`
+to pass to `GtkStyleContext` methods, like
+[method@Gtk.StyleContext.get_padding].
+If you need to retrieve the current state of a `GtkWidget`, use
+[method@Gtk.Widget.get_state_flags].
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
</parameters>
@@ -69278,7 +72895,7 @@ given class name.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
<parameter name="class_name">
@@ -69298,7 +72915,7 @@ Looks up and resolves a color name in the @context color map.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
<parameter name="color_name">
@@ -69321,7 +72938,7 @@ Removes @class_name from @context.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
<parameter name="class_name">
@@ -69339,11 +72956,11 @@ Removes @provider from the style providers list in @context.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
<parameter name="provider">
-<parameter_description> a #GtkStyleProvider
+<parameter_description> a `GtkStyleProvider`
</parameter_description>
</parameter>
</parameters>
@@ -69357,11 +72974,11 @@ Removes @provider from the global style providers list in @display.
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
<parameter name="provider">
-<parameter_description> a #GtkStyleProvider
+<parameter_description> a `GtkStyleProvider`
</parameter_description>
</parameter>
</parameters>
@@ -69371,12 +72988,13 @@ Removes @provider from the global style providers list in @display.
<function name="gtk_style_context_restore">
<description>
Restores @context state to a previous stage.
-See gtk_style_context_save().
+
+See [method Gtk StyleContext save].
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
</parameters>
@@ -69385,18 +73003,21 @@ See gtk_style_context_save().
<function name="gtk_style_context_save">
<description>
-Saves the @context state, so temporary modifications done through
-gtk_style_context_add_class(), gtk_style_context_remove_class(),
-gtk_style_context_set_state(), etc. can quickly be reverted
-in one go through gtk_style_context_restore().
+Saves the @context state.
+
+This allows temporary modifications done through
+[method@Gtk.StyleContext.add_class],
+[method@Gtk.StyleContext.remove_class],
+[method@Gtk.StyleContext.set_state] to be quickly
+reverted in one go through [method@Gtk.StyleContext.restore].
-The matching call to gtk_style_context_restore() must be done
-before GTK returns to the main loop.
+The matching call to [method@Gtk.StyleContext.restore]
+must be done before GTK returns to the main loop.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
</parameters>
@@ -69407,21 +73028,21 @@ before GTK returns to the main loop.
<description>
Attaches @context to the given display.
-The display is used to add style information from “global” style
-providers, such as the display's #GtkSettings instance.
+The display is used to add style information from “global”
+style providers, such as the display's `GtkSettings` instance.
-If you are using a #GtkStyleContext returned from
-gtk_widget_get_style_context(), you do not need to
+If you are using a `GtkStyleContext` returned from
+[method@Gtk.Widget.get_style_context], you do not need to
call this yourself.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -69435,7 +73056,7 @@ Sets the scale to use when getting image assets for the style.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
<parameter name="scale">
@@ -69453,7 +73074,7 @@ Sets the state to be used for style matching.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
<parameter name="flags">
@@ -69481,7 +73102,7 @@ the format of the returned string, it may change.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GtkStyleContext
+<parameter_description> a `GtkStyleContext`
</parameter_description>
</parameter>
<parameter name="flags">
@@ -69495,29 +73116,29 @@ the format of the returned string, it may change.
<function name="gtk_switch_get_active">
<description>
-Gets whether the #GtkSwitch is in its “on” or “off” state.
+Gets whether the `GtkSwitch` is in its “on” or “off” state.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSwitch
+<parameter_description> a `GtkSwitch`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the #GtkSwitch is active, and %FALSE otherwise
+<return> %TRUE if the `GtkSwitch` is active, and %FALSE otherwise
</return>
</function>
<function name="gtk_switch_get_state">
<description>
-Gets the underlying state of the #GtkSwitch.
+Gets the underlying state of the `GtkSwitch`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSwitch
+<parameter_description> a `GtkSwitch`
</parameter_description>
</parameter>
</parameters>
@@ -69527,13 +73148,13 @@ Gets the underlying state of the #GtkSwitch.
<function name="gtk_switch_new">
<description>
-Creates a new #GtkSwitch widget.
+Creates a new `GtkSwitch` widget.
</description>
<parameters>
</parameters>
-<return> the newly created #GtkSwitch instance
+<return> the newly created `GtkSwitch` instance
</return>
</function>
@@ -69544,7 +73165,7 @@ Changes the state of @self to the desired one.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSwitch
+<parameter_description> a `GtkSwitch`
</parameter_description>
</parameter>
<parameter name="is_active">
@@ -69557,18 +73178,18 @@ Changes the state of @self to the desired one.
<function name="gtk_switch_set_state">
<description>
-Sets the underlying state of the #GtkSwitch.
+Sets the underlying state of the `GtkSwitch`.
-Normally, this is the same as #GtkSwitch:active, unless the switch
-is set up for delayed state changes. This function is typically
-called from a #GtkSwitch::state-set signal handler.
+Normally, this is the same as [property@Gtk.Switch:active], unless
+the switch is set up for delayed state changes. This function is
+typically called from a [signal@Gtk.Switch`::state-set] signal handler.
-See #GtkSwitch::state-set for details.
+See [signal@Gtk.Switch::state-set] for details.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkSwitch
+<parameter_description> a `GtkSwitch`
</parameter_description>
</parameter>
<parameter name="state">
@@ -69831,7 +73452,7 @@ Checks whether the #GtkAccessible has @state set.
This function is used to initialize a GTK test program.
It will in turn call g_test_init() and gtk_init() to properly
-initialize the testing framework and graphical toolkit. It’ll
+initialize the testing framework and graphical toolkit. It’ll
also set the program’s locale to “C”. This is done to make test
program environments as deterministic as possible.
@@ -69893,9 +73514,10 @@ g_type_from_name() after calling this function.
<function name="gtk_test_widget_wait_for_draw">
<description>
-Enters the main loop and waits for @widget to be “drawn”. In this
-context that means it waits for the frame clock of @widget to have
-run a full styling, layout and drawing cycle.
+Enters the main loop and waits for @widget to be “drawn”.
+
+In this context that means it waits for the frame clock of
+@widget to have run a full styling, layout and drawing cycle.
This function is intended to be used for syncing with actions that
depend on @widget relayouting or on interaction with the display
@@ -69994,17 +73616,19 @@ if the reference count reaches 0.
<function name="gtk_text_buffer_add_mark">
<description>
-Adds the mark at position @where. The mark must not be added to
-another buffer, and if its name is not %NULL then there must not
-be another mark in the buffer with the same name.
+Adds the mark at position @where.
-Emits the #GtkTextBuffer::mark-set signal as notification of the mark's
-initial placement.
+The mark must not be added to another buffer, and if its name
+is not %NULL then there must not be another mark in the buffer
+with the same name.
+
+Emits the `GtkTextBuffer`::mark-set signal as notification of
+the mark's initial placement.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="mark">
@@ -70021,19 +73645,20 @@ initial placement.
<function name="gtk_text_buffer_add_selection_clipboard">
<description>
-Adds @clipboard to the list of clipboards in which the selection
-contents of @buffer are available. In most cases, @clipboard will be
-the #GdkClipboard returned by gtk_widget_get_primary_clipboard()
-for a view of @buffer.
+Adds @clipboard to the list of clipboards in which the selection
+contents of @buffer are available.
+
+In most cases, @clipboard will be the `GdkClipboard` returned by
+[method@Gtk.Widget.get_primary_clipboard] for a view of @buffer.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard
+<parameter_description> a `GdkClipboard`
</parameter_description>
</parameter>
</parameters>
@@ -70042,18 +73667,20 @@ for a view of @buffer.
<function name="gtk_text_buffer_apply_tag">
<description>
-Emits the “apply-tag” signal on @buffer. The default
-handler for the signal applies @tag to the given range.
-@start and @end do not have to be in order.
+Emits the “apply-tag” signal on @buffer.
+
+The default handler for the signal applies
+@tag to the given range. @start and @end do
+not have to be in order.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="tag">
-<parameter_description> a #GtkTextTag
+<parameter_description> a `GtkTextTag`
</parameter_description>
</parameter>
<parameter name="start">
@@ -70070,17 +73697,20 @@ handler for the signal applies @tag to the given range.
<function name="gtk_text_buffer_apply_tag_by_name">
<description>
-Calls gtk_text_tag_table_lookup() on the buffer’s tag table to
-get a #GtkTextTag, then calls gtk_text_buffer_apply_tag().
+Emits the “apply-tag” signal on @buffer.
+
+Calls [method@Gtk.TextTagTable.lookup] on the buffer’s
+tag table to get a `GtkTextTag`, then calls
+[method@Gtk.TextBuffer.apply_tag].
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="name">
-<parameter_description> name of a named #GtkTextTag
+<parameter_description> name of a named `GtkTextTag`
</parameter_description>
</parameter>
<parameter name="start">
@@ -70098,21 +73728,22 @@ get a #GtkTextTag, then calls gtk_text_buffer_apply_tag().
<function name="gtk_text_buffer_backspace">
<description>
Performs the appropriate action as if the user hit the delete
-key with the cursor at the position specified by @iter. In the
-normal case a single character will be deleted, but when
+key with the cursor at the position specified by @iter.
+
+In the normal case a single character will be deleted, but when
combining accents are involved, more than one character can
be deleted, and when precomposed character and accent combinations
are involved, less than one character will be deleted.
-Because the buffer is modified, all outstanding iterators become
+Because the buffer is modified, all outstanding iterators become
invalid after calling this function; however, the @iter will be
-re-initialized to point to the location where text was deleted.
+re-initialized to point to the location where text was deleted.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -70134,12 +73765,14 @@ re-initialized to point to the location where text was deleted.
<function name="gtk_text_buffer_begin_irreversible_action">
<description>
-Denotes the beginning of an action that may not be undone. This will cause
-any previous operations in the undo/redo queue to be cleared.
+Denotes the beginning of an action that may not be undone.
+
+This will cause any previous operations in the undo/redo queue
+to be cleared.
This should be paired with a call to
-gtk_text_buffer_end_irreversible_action() after the irreversible action
-has completed.
+[method@Gtk.TextBuffer.end_irreversible_action] after the irreversible
+action has completed.
You may nest calls to gtk_text_buffer_begin_irreversible_action() and
gtk_text_buffer_end_irreversible_action() pairs.
@@ -70147,7 +73780,7 @@ gtk_text_buffer_end_irreversible_action() pairs.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -70158,26 +73791,27 @@ gtk_text_buffer_end_irreversible_action() pairs.
<description>
Called to indicate that the buffer operations between here and a
call to gtk_text_buffer_end_user_action() are part of a single
-user-visible operation. The operations between
-gtk_text_buffer_begin_user_action() and
+user-visible operation.
+
+The operations between gtk_text_buffer_begin_user_action() and
gtk_text_buffer_end_user_action() can then be grouped when creating
-an undo stack. #GtkTextBuffer maintains a count of calls to
+an undo stack. `GtkTextBuffer` maintains a count of calls to
gtk_text_buffer_begin_user_action() that have not been closed with
-a call to gtk_text_buffer_end_user_action(), and emits the
-“begin-user-action” and “end-user-action” signals only for the
-outermost pair of calls. This allows you to build user actions
+a call to gtk_text_buffer_end_user_action(), and emits the
+“begin-user-action” and “end-user-action” signals only for the
+outermost pair of calls. This allows you to build user actions
from other user actions.
The “interactive” buffer mutation functions, such as
-gtk_text_buffer_insert_interactive(), automatically call begin/end
-user action around the buffer operations they perform, so there's
-no need to add extra calls if you user action consists solely of a
-single call to one of those functions.
+[method@Gtk.TextBuffer.insert_interactive], automatically call
+begin/end user action around the buffer operations they perform,
+so there's no need to add extra calls if you user action consists
+solely of a single call to one of those functions.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -70191,11 +73825,11 @@ Copies the currently-selected text to a clipboard.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="clipboard">
-<parameter_description> the #GdkClipboard object to copy to
+<parameter_description> the `GdkClipboard` object to copy to
</parameter_description>
</parameter>
</parameters>
@@ -70204,17 +73838,20 @@ Copies the currently-selected text to a clipboard.
<function name="gtk_text_buffer_create_child_anchor">
<description>
+Creates and inserts a child anchor.
+
This is a convenience function which simply creates a child anchor
-with gtk_text_child_anchor_new() and inserts it into the buffer
-with gtk_text_buffer_insert_child_anchor(). The new anchor is
-owned by the buffer; no reference count is returned to
-the caller of gtk_text_buffer_create_child_anchor().
+with [ctor Gtk TextChildAnchor new] and inserts it into the buffer
+with [method@Gtk.TextBuffer.insert_child_anchor].
+
+The new anchor is owned by the buffer; no reference count is
+returned to the caller of this function.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -70228,29 +73865,31 @@ the caller of gtk_text_buffer_create_child_anchor().
<function name="gtk_text_buffer_create_mark">
<description>
-Creates a mark at position @where. If @mark_name is %NULL, the mark
-is anonymous; otherwise, the mark can be retrieved by name using
-gtk_text_buffer_get_mark(). If a mark has left gravity, and text is
-inserted at the mark’s current location, the mark will be moved to
-the left of the newly-inserted text. If the mark has right gravity
+Creates a mark at position @where.
+
+If @mark_name is %NULL, the mark is anonymous; otherwise, the mark
+can be retrieved by name using [method@Gtk.TextBuffer.get_mark].
+If a mark has left gravity, and text is inserted at the mark’s
+current location, the mark will be moved to the left of the
+newly-inserted text. If the mark has right gravity
(@left_gravity = %FALSE), the mark will end up on the right of
newly-inserted text. The standard left-to-right cursor is a mark
with right gravity (when you type, the cursor stays on the right
side of the text you’re typing).
-The caller of this function does not own a
-reference to the returned #GtkTextMark, so you can ignore the
-return value if you like. Marks are owned by the buffer and go
+The caller of this function does not own a
+reference to the returned #GtkTextMark, so you can ignore the
+return value if you like. Marks are owned by the buffer and go
away when the buffer does.
-Emits the #GtkTextBuffer::mark-set signal as notification of the mark's
-initial placement.
+Emits the `GtkTextBuffer`::mark-set signal as notification of
+the mark's initial placement.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="mark_name">
@@ -70273,7 +73912,8 @@ initial placement.
<function name="gtk_text_buffer_create_tag">
<description>
Creates a tag and adds it to the tag table for @buffer.
-Equivalent to calling gtk_text_tag_new() and then adding the
+
+Equivalent to calling [ctor Gtk TextTag new] and then adding the
tag to the buffer’s tag table. The returned tag is owned by
the buffer’s tag table, so the ref count will be equal to one.
@@ -70289,7 +73929,7 @@ of properties to set on the tag, as with g_object_set().
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="tag_name">
@@ -70311,17 +73951,17 @@ of properties to set on the tag, as with g_object_set().
<function name="gtk_text_buffer_cut_clipboard">
<description>
-Copies the currently-selected text to a clipboard, then deletes
-said text if it’s editable.
+Copies the currently-selected text to a clipboard,
+then deletes said text if it’s editable.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="clipboard">
-<parameter_description> the #GdkClipboard object to cut to
+<parameter_description> the `GdkClipboard` object to cut to
</parameter_description>
</parameter>
<parameter name="default_editable">
@@ -70334,9 +73974,12 @@ said text if it’s editable.
<function name="gtk_text_buffer_delete">
<description>
-Deletes text between @start and @end. The order of @start and @end
-is not actually relevant; gtk_text_buffer_delete() will reorder
-them. This function actually emits the “delete-range” signal, and
+Deletes text between @start and @end.
+
+The order of @start and @end is not actually relevant;
+gtk_text_buffer_delete() will reorder them.
+
+This function actually emits the “delete-range” signal, and
the default handler of that signal deletes the text. Because the
buffer is modified, all outstanding iterators become invalid after
calling this function; however, the @start and @end will be
@@ -70345,7 +73988,7 @@ re-initialized to point to the location where text was deleted.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="start">
@@ -70363,16 +74006,17 @@ re-initialized to point to the location where text was deleted.
<function name="gtk_text_buffer_delete_interactive">
<description>
Deletes all editable text in the given range.
-Calls gtk_text_buffer_delete() for each editable sub-range of
-[@start,@end). @start and @end are revalidated to point to
-the location of the last deleted range, or left untouched if
-no text was deleted.
+
+Calls [method@Gtk.TextBuffer.delete] for each editable
+sub-range of [@start,@end). @start and @end are revalidated
+to point to the location of the last deleted range, or left
+untouched if no text was deleted.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="start_iter">
@@ -70395,23 +74039,26 @@ no text was deleted.
<function name="gtk_text_buffer_delete_mark">
<description>
Deletes @mark, so that it’s no longer located anywhere in the
-buffer. Removes the reference the buffer holds to the mark, so if
-you haven’t called g_object_ref() on the mark, it will be freed. Even
-if the mark isn’t freed, most operations on @mark become
-invalid, until it gets added to a buffer again with
-gtk_text_buffer_add_mark(). Use gtk_text_mark_get_deleted() to
-find out if a mark has been removed from its buffer.
-The #GtkTextBuffer::mark-deleted signal will be emitted as notification after
-the mark is deleted.
+buffer.
+
+Removes the reference the buffer holds to the mark, so if
+you haven’t called g_object_ref() on the mark, it will be freed.
+Even if the mark isn’t freed, most operations on @mark become
+invalid, until it gets added to a buffer again with
+[method@Gtk.TextBuffer.add_mark]. Use [method@Gtk.TextMark.get_deleted]
+to find out if a mark has been removed from its buffer.
+
+The [signal@Gtk.TextBuffer::mark-deleted] signal will be emitted as
+notification after the mark is deleted.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="mark">
-<parameter_description> a #GtkTextMark in @buffer
+<parameter_description> a `GtkTextMark` in @buffer
</parameter_description>
</parameter>
</parameters>
@@ -70420,13 +74067,14 @@ the mark is deleted.
<function name="gtk_text_buffer_delete_mark_by_name">
<description>
-Deletes the mark named @name; the mark must exist. See
-gtk_text_buffer_delete_mark() for details.
+Deletes the mark named @name; the mark must exist.
+
+See [method@Gtk.TextBuffer.delete_mark] for details.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="name">
@@ -70440,15 +74088,16 @@ gtk_text_buffer_delete_mark() for details.
<function name="gtk_text_buffer_delete_selection">
<description>
Deletes the range between the “insert” and “selection_bound” marks,
-that is, the currently-selected text. If @interactive is %TRUE,
-the editability of the selection will be considered (users can’t delete
-uneditable text).
+that is, the currently-selected text.
+
+If @interactive is %TRUE, the editability of the selection will be
+considered (users can’t delete uneditable text).
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="interactive">
@@ -70466,11 +74115,14 @@ uneditable text).
<function name="gtk_text_buffer_end_irreversible_action">
<description>
-Denotes the end of an action that may not be undone. This will cause
-any previous operations in the undo/redo queue to be cleared.
+Denotes the end of an action that may not be undone.
+
+This will cause any previous operations in the undo/redo
+queue to be cleared.
-This should be called after completing modifications to the text buffer
-after gtk_text_buffer_begin_irreversible_action() was called.
+This should be called after completing modifications to the
+text buffer after gtk_text_buffer_begin_irreversible_action()
+was called.
You may nest calls to gtk_text_buffer_begin_irreversible_action() and
gtk_text_buffer_end_irreversible_action() pairs.
@@ -70478,7 +74130,7 @@ gtk_text_buffer_end_irreversible_action() pairs.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -70487,13 +74139,16 @@ gtk_text_buffer_end_irreversible_action() pairs.
<function name="gtk_text_buffer_end_user_action">
<description>
-Should be paired with a call to gtk_text_buffer_begin_user_action().
+Ends a user-visible operation.
+
+Should be paired with a call to
+[method@Gtk.TextBuffer.begin_user_action].
See that function for a full explanation.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -70508,7 +74163,7 @@ entire buffer lies within the range [@start,@end).
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="start">
@@ -70531,7 +74186,7 @@ Gets whether there is a redoable action in the history.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -70547,7 +74202,7 @@ Gets whether there is an undoable action in the history.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -70557,16 +74212,19 @@ Gets whether there is an undoable action in the history.
<function name="gtk_text_buffer_get_char_count">
<description>
-Gets the number of characters in the buffer; note that characters
-and bytes are not the same, you can’t e.g. expect the contents of
-the buffer in string form to be this many bytes long. The character
-count is cached, so this function is very fast.
+Gets the number of characters in the buffer.
+
+Note that characters and bytes are not the same, you can’t e.g.
+expect the contents of the buffer in string form to be this
+many bytes long.
+
+The character count is cached, so this function is very fast.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -70576,17 +74234,17 @@ count is cached, so this function is very fast.
<function name="gtk_text_buffer_get_enable_undo">
<description>
-Gets whether the buffer is saving modifications to the buffer to allow for
-undo and redo actions.
+Gets whether the buffer is saving modifications to the buffer
+to allow for undo and redo actions.
-See gtk_text_buffer_begin_irreversible_action() and
-gtk_text_buffer_end_irreversible_action() to create changes to the buffer
-that cannot be undone.
+See [method@Gtk.TextBuffer.begin_irreversible_action] and
+[method@Gtk.TextBuffer.end_irreversible_action] to create
+changes to the buffer that cannot be undone.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -70596,16 +74254,18 @@ that cannot be undone.
<function name="gtk_text_buffer_get_end_iter">
<description>
Initializes @iter with the “end iterator,” one past the last valid
-character in the text buffer. If dereferenced with
-gtk_text_iter_get_char(), the end iterator has a character value of 0.
+character in the text buffer.
+
+If dereferenced with [method@Gtk.TextIter.get_char], the end
+iterator has a character value of 0.
The entire buffer lies in the range from the first position in
-the buffer (call gtk_text_buffer_get_start_iter() to get
+the buffer (call [method@Gtk.TextBuffer.get_start_iter] to get
character position 0) to the end iterator.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -70624,7 +74284,7 @@ Indicates whether the buffer has some text currently selected.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -70635,15 +74295,16 @@ Indicates whether the buffer has some text currently selected.
<function name="gtk_text_buffer_get_insert">
<description>
Returns the mark that represents the cursor (insertion point).
-Equivalent to calling gtk_text_buffer_get_mark() to get the mark
-named “insert”, but very slightly more efficient, and involves less
-typing.
+
+Equivalent to calling [method@Gtk.TextBuffer.get_mark]
+to get the mark named “insert”, but very slightly more
+efficient, and involves less typing.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -70658,7 +74319,7 @@ Obtains the location of @anchor within @buffer.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -70675,14 +74336,16 @@ Obtains the location of @anchor within @buffer.
<function name="gtk_text_buffer_get_iter_at_line">
<description>
-Initializes @iter to the start of the given line. If @line_number is greater
-than the number of lines in the @buffer, the end iterator is returned.
+Initializes @iter to the start of the given line.
+
+If @line_number is greater than the number of lines
+in the @buffer, the end iterator is returned.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -70701,18 +74364,19 @@ than the number of lines in the @buffer, the end iterator is returned.
<function name="gtk_text_buffer_get_iter_at_line_index">
<description>
Obtains an iterator pointing to @byte_index within the given line.
+
@byte_index must be the start of a UTF-8 character. Note bytes, not
characters; UTF-8 may encode one character as multiple bytes.
-If @line_number is greater than the number of lines
-in the @buffer, the end iterator is returned. And if @byte_index is off the
+If @line_number is greater than the number of lines in the @buffer,
+the end iterator is returned. And if @byte_index is off the
end of the line, the iterator at the end of the line is returned.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -70734,20 +74398,20 @@ end of the line, the iterator at the end of the line is returned.
<function name="gtk_text_buffer_get_iter_at_line_offset">
<description>
-Obtains an iterator pointing to @char_offset within the given line. Note
-characters, not bytes; UTF-8 may encode one character as multiple bytes.
+Obtains an iterator pointing to @char_offset within the given line.
-Before the 3.20 version, it was not allowed to pass an invalid location.
+Note characters, not bytes; UTF-8 may encode one character as multiple
+bytes.
-If @line_number is greater than the number of lines
-in the @buffer, the end iterator is returned. And if @char_offset is off the
+If @line_number is greater than the number of lines in the @buffer,
+the end iterator is returned. And if @char_offset is off the
end of the line, the iterator at the end of the line is returned.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -70774,7 +74438,7 @@ Initializes @iter with the current position of @mark.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -70782,7 +74446,7 @@ Initializes @iter with the current position of @mark.
</parameter_description>
</parameter>
<parameter name="mark">
-<parameter_description> a #GtkTextMark in @buffer
+<parameter_description> a `GtkTextMark` in @buffer
</parameter_description>
</parameter>
</parameters>
@@ -70792,14 +74456,16 @@ Initializes @iter with the current position of @mark.
<function name="gtk_text_buffer_get_iter_at_offset">
<description>
Initializes @iter to a position @char_offset chars from the start
-of the entire buffer. If @char_offset is -1 or greater than the number
+of the entire buffer.
+
+If @char_offset is -1 or greater than the number
of characters in the buffer, @iter is initialized to the end iterator,
the iterator one past the last valid character in the buffer.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -70816,14 +74482,15 @@ the iterator one past the last valid character in the buffer.
<function name="gtk_text_buffer_get_line_count">
<description>
-Obtains the number of lines in the buffer. This value is cached, so
-the function is very fast.
+Obtains the number of lines in the buffer.
+
+This value is cached, so the function is very fast.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -70840,7 +74507,7 @@ mark exists in the buffer.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="name">
@@ -70854,15 +74521,16 @@ mark exists in the buffer.
<function name="gtk_text_buffer_get_max_undo_levels">
<description>
-Gets the maximum number of undo levels to perform. If 0, unlimited undo
-actions may be performed. Note that this may have a memory usage impact
-as it requires storing an additional copy of the inserted or removed text
-within the text buffer.
+Gets the maximum number of undo levels to perform.
+
+If 0, unlimited undo actions may be performed. Note that this may
+have a memory usage impact as it requires storing an additional
+copy of the inserted or removed text within the text buffer.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -70872,15 +74540,16 @@ within the text buffer.
<function name="gtk_text_buffer_get_modified">
<description>
Indicates whether the buffer has been modified since the last call
-to gtk_text_buffer_set_modified() set the modification flag to
-%FALSE. Used for example to enable a “save” function in a text
-editor.
+to [method@Gtk.TextBuffer.set_modified] set the modification flag to
+%FALSE.
+
+Used for example to enable a “save” function in a text editor.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -70890,23 +74559,24 @@ editor.
<function name="gtk_text_buffer_get_selection_bound">
<description>
-Returns the mark that represents the selection bound. Equivalent
-to calling gtk_text_buffer_get_mark() to get the mark named
-“selection_bound”, but very slightly more efficient, and involves
-less typing.
+Returns the mark that represents the selection bound.
+
+Equivalent to calling [method@Gtk.TextBuffer.get_mark]
+to get the mark named “selection_bound”, but very slightly
+more efficient, and involves less typing.
The currently-selected text in @buffer is the region between the
“selection_bound” and “insert” marks. If “selection_bound” and
“insert” are in the same place, then there is no current selection.
-gtk_text_buffer_get_selection_bounds() is another convenient function
-for handling the selection, if you just want to know whether there’s a
-selection and what its bounds are.
+[method@Gtk.TextBuffer.get_selection_bounds] is another convenient
+function for handling the selection, if you just want to know whether
+there’s a selection and what its bounds are.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -70917,17 +74587,18 @@ selection and what its bounds are.
<function name="gtk_text_buffer_get_selection_bounds">
<description>
Returns %TRUE if some text is selected; places the bounds
-of the selection in @start and @end (if the selection has length 0,
-then @start and @end are filled in with the same value).
-@start and @end will be in ascending order. If @start and @end are
-NULL, then they are not filled in, but the return value still indicates
-whether text is selected.
+of the selection in @start and @end.
+
+If the selection has length 0, then @start and @end are filled
+in with the same value. @start and @end will be in ascending order.
+If @start and @end are %NULL, then they are not filled in, but the
+return value still indicates whether text is selected.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer` a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="start">
@@ -70945,40 +74616,41 @@ whether text is selected.
<function name="gtk_text_buffer_get_selection_content">
<description>
-Get a content provider for this buffer. It can be
-used to make the content of @buffer available in a
-#GdkClipboard, see gdk_clipboard_set_content().
+Get a content provider for this buffer.
+
+It can be used to make the content of @buffer available
+in a `GdkClipboard`, see [method@Gdk.Clipboard.set_content].
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkContentProvider.
+<return> a new `GdkContentProvider`.
</return>
</function>
<function name="gtk_text_buffer_get_slice">
<description>
-Returns the text in the range [@start,@end). Excludes undisplayed
-text (text marked with tags that set the invisibility attribute) if
-@include_hidden_chars is %FALSE. The returned string includes a
-0xFFFC character whenever the buffer contains
-embedded images, so byte and character indexes into
-the returned string do correspond to byte
-and character indexes into the buffer. Contrast with
-gtk_text_buffer_get_text(). Note that 0xFFFC can occur in normal
-text as well, so it is not a reliable indicator that a paintable or
-widget is in the buffer.
+Returns the text in the range [@start,@end).
+
+Excludes undisplayed text (text marked with tags that set the
+invisibility attribute) if @include_hidden_chars is %FALSE.
+The returned string includes a 0xFFFC character whenever the
+buffer contains embedded images, so byte and character indexes
+into the returned string do correspond to byte and character
+indexes into the buffer. Contrast with [method@Gtk.TextBuffer.get_text].
+Note that 0xFFFC can occur in normal text as well, so it is not a
+reliable indicator that a paintable or widget is in the buffer.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="start">
@@ -71000,14 +74672,15 @@ widget is in the buffer.
<function name="gtk_text_buffer_get_start_iter">
<description>
-Initialized @iter with the first position in the text buffer. This
-is the same as using gtk_text_buffer_get_iter_at_offset() to get
-the iter at character offset 0.
+Initialized @iter with the first position in the text buffer.
+
+This is the same as using [method@Gtk.TextBuffer.get_iter_at_offset]
+to get the iter at character offset 0.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -71020,13 +74693,13 @@ the iter at character offset 0.
<function name="gtk_text_buffer_get_tag_table">
<description>
-Get the #GtkTextTagTable associated with this buffer.
+Get the `GtkTextTagTable` associated with this buffer.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -71036,19 +74709,20 @@ Get the #GtkTextTagTable associated with this buffer.
<function name="gtk_text_buffer_get_text">
<description>
-Returns the text in the range [@start,@end). Excludes undisplayed
-text (text marked with tags that set the invisibility attribute) if
-@include_hidden_chars is %FALSE. Does not include characters
-representing embedded images, so byte and character indexes into
-the returned string do not correspond to byte
-and character indexes into the buffer. Contrast with
-gtk_text_buffer_get_slice().
+Returns the text in the range [@start,@end).
+
+Excludes undisplayed text (text marked with tags that set the
+invisibility attribute) if @include_hidden_chars is %FALSE.
+Does not include characters representing embedded images, so
+byte and character indexes into the returned string do not
+correspond to byte and character indexes into the buffer.
+Contrast with [method@Gtk.TextBuffer.get_slice].
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="start">
@@ -71070,8 +74744,9 @@ gtk_text_buffer_get_slice().
<function name="gtk_text_buffer_insert">
<description>
-Inserts @len bytes of @text at position @iter. If @len is -1,
-@text must be nul-terminated and will be inserted in its
+Inserts @len bytes of @text at position @iter.
+
+If @len is -1, @text must be nul-terminated and will be inserted in its
entirety. Emits the “insert-text” signal; insertion actually occurs
in the default handler for the signal. @iter is invalidated when
insertion occurs (because the buffer contents change), but the
@@ -71081,7 +74756,7 @@ inserted text.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -71102,13 +74777,15 @@ inserted text.
<function name="gtk_text_buffer_insert_at_cursor">
<description>
-Simply calls gtk_text_buffer_insert(), using the current
-cursor position as the insertion point.
+Inserts @text in @buffer.
+
+Simply calls [method@Gtk.TextBuffer.insert],
+using the current cursor position as the insertion point.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="text">
@@ -71125,22 +74802,24 @@ cursor position as the insertion point.
<function name="gtk_text_buffer_insert_child_anchor">
<description>
-Inserts a child widget anchor into the text buffer at @iter. The
-anchor will be counted as one character in character counts, and
+Inserts a child widget anchor into the text buffer at @iter.
+
+The anchor will be counted as one character in character counts, and
when obtaining the buffer contents as a string, will be represented
by the Unicode “object replacement character” 0xFFFC. Note that the
“slice” variants for obtaining portions of the buffer as a string
include this character for child anchors, but the “text” variants do
-not. E.g. see gtk_text_buffer_get_slice() and
-gtk_text_buffer_get_text(). Consider
-gtk_text_buffer_create_child_anchor() as a more convenient
-alternative to this function. The buffer will add a reference to
-the anchor, so you can unref it after insertion.
+not. E.g. see [method@Gtk.TextBuffer.get_slice] and
+[method@Gtk.TextBuffer.get_text].
+
+Consider [method@Gtk.TextBuffer.create_child_anchor] as a more
+convenient alternative to this function. The buffer will add a
+reference to the anchor, so you can unref it after insertion.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -71148,7 +74827,7 @@ the anchor, so you can unref it after insertion.
</parameter_description>
</parameter>
<parameter name="anchor">
-<parameter_description> a #GtkTextChildAnchor
+<parameter_description> a `GtkTextChildAnchor`
</parameter_description>
</parameter>
</parameters>
@@ -71157,20 +74836,22 @@ the anchor, so you can unref it after insertion.
<function name="gtk_text_buffer_insert_interactive">
<description>
-Like gtk_text_buffer_insert(), but the insertion will not occur if
-@iter is at a non-editable location in the buffer. Usually you
+Inserts @text in @buffer.
+
+Like [method@Gtk.TextBuffer.insert], but the insertion will not occur
+if @iter is at a non-editable location in the buffer. Usually you
want to prevent insertions at ineditable locations if the insertion
results from a user action (is interactive).
@default_editable indicates the editability of text that doesn't
have a tag affecting editability applied to it. Typically the
-result of gtk_text_view_get_editable() is appropriate here.
+result of [method@Gtk.TextView.get_editable] is appropriate here.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -71196,18 +74877,20 @@ result of gtk_text_view_get_editable() is appropriate here.
<function name="gtk_text_buffer_insert_interactive_at_cursor">
<description>
-Calls gtk_text_buffer_insert_interactive() at the cursor
-position.
+Inserts @text in @buffer.
+
+Calls [method@Gtk.TextBuffer.insert_interactive]
+at the cursor position.
@default_editable indicates the editability of text that doesn't
have a tag affecting editability applied to it. Typically the
-result of gtk_text_view_get_editable() is appropriate here.
+result of [method@Gtk.TextView.get_editable] is appropriate here.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="text">
@@ -71229,16 +74912,17 @@ result of gtk_text_view_get_editable() is appropriate here.
<function name="gtk_text_buffer_insert_markup">
<description>
-Inserts the text in @markup at position @iter. @markup will be inserted
-in its entirety and must be nul-terminated and valid UTF-8. Emits the
-#GtkTextBuffer::insert-text signal, possibly multiple times; insertion
-actually occurs in the default handler for the signal. @iter will point
-to the end of the inserted text on return.
+Inserts the text in @markup at position @iter.
+
+@markup will be inserted in its entirety and must be nul-terminated
+and valid UTF-8. Emits the [signal@Gtk.TextBuffer::insert-text] signal,
+possibly multiple times; insertion actually occurs in the default handler
+for the signal. @iter will point to the end of the inserted text on return.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -71246,7 +74930,7 @@ to the end of the inserted text on return.
</parameter_description>
</parameter>
<parameter name="markup">
-<parameter_description> a nul-terminated UTF-8 string containing [Pango markup][PangoMarkupFormat]
+<parameter_description> a nul-terminated UTF-8 string containing Pango markup
</parameter_description>
</parameter>
<parameter name="len">
@@ -71259,19 +74943,20 @@ to the end of the inserted text on return.
<function name="gtk_text_buffer_insert_paintable">
<description>
-Inserts an image into the text buffer at @iter. The image will be
-counted as one character in character counts, and when obtaining
-the buffer contents as a string, will be represented by the Unicode
-“object replacement character” 0xFFFC. Note that the “slice”
-variants for obtaining portions of the buffer as a string include
-this character for paintable, but the “text” variants do
-not. e.g. see gtk_text_buffer_get_slice() and
-gtk_text_buffer_get_text().
+Inserts an image into the text buffer at @iter.
+
+The image will be counted as one character in character counts,
+and when obtaining the buffer contents as a string, will be
+represented by the Unicode “object replacement character” 0xFFFC.
+Note that the “slice” variants for obtaining portions of the buffer
+as a string include this character for paintable, but the “text”
+variants do not. e.g. see [method@Gtk.TextBuffer.get_slice] and
+[method@Gtk.TextBuffer.get_text].
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -71279,7 +74964,7 @@ gtk_text_buffer_get_text().
</parameter_description>
</parameter>
<parameter name="paintable">
-<parameter_description> a #GdkPaintable
+<parameter_description> a `GdkPaintable`
</parameter_description>
</parameter>
</parameters>
@@ -71288,8 +74973,11 @@ gtk_text_buffer_get_text().
<function name="gtk_text_buffer_insert_range">
<description>
-Copies text, tags, and paintables between @start and @end (the order
-of @start and @end doesn’t matter) and inserts the copy at @iter.
+Copies text, tags, and paintables between @start and @end
+and inserts the copy at @iter.
+
+The order of @start and @end doesn’t matter.
+
Used instead of simply getting/inserting text because it preserves
images and tags. If @start and @end are in a different buffer from
@buffer, the two buffers must share the same tag table.
@@ -71300,7 +74988,7 @@ so expect those.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -71308,7 +74996,7 @@ so expect those.
</parameter_description>
</parameter>
<parameter name="start">
-<parameter_description> a position in a #GtkTextBuffer
+<parameter_description> a position in a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="end">
@@ -71321,17 +75009,20 @@ so expect those.
<function name="gtk_text_buffer_insert_range_interactive">
<description>
-Same as gtk_text_buffer_insert_range(), but does nothing if the
-insertion point isn’t editable. The @default_editable parameter
-indicates whether the text is editable at @iter if no tags
-enclosing @iter affect editability. Typically the result of
-gtk_text_view_get_editable() is appropriate here.
+Copies text, tags, and paintables between @start and @end
+and inserts the copy at @iter.
+
+Same as [method@Gtk.TextBuffer.insert_range], but does nothing
+if the insertion point isn’t editable. The @default_editable
+parameter indicates whether the text is editable at @iter if
+no tags enclosing @iter affect editability. Typically the result
+of [method@Gtk.TextView.get_editable] is appropriate here.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -71339,7 +75030,7 @@ gtk_text_view_get_editable() is appropriate here.
</parameter_description>
</parameter>
<parameter name="start">
-<parameter_description> a position in a #GtkTextBuffer
+<parameter_description> a position in a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="end">
@@ -71358,15 +75049,17 @@ gtk_text_view_get_editable() is appropriate here.
<function name="gtk_text_buffer_insert_with_tags">
<description>
Inserts @text into @buffer at @iter, applying the list of tags to
-the newly-inserted text. The last tag specified must be %NULL to
-terminate the list. Equivalent to calling gtk_text_buffer_insert(),
-then gtk_text_buffer_apply_tag() on the inserted text;
-gtk_text_buffer_insert_with_tags() is just a convenience function.
+the newly-inserted text.
+
+The last tag specified must be %NULL to terminate the list.
+Equivalent to calling [method@Gtk.TextBuffer.insert],
+then [method@Gtk.TextBuffer.apply_tag] on the inserted text;
+this is just a convenience function.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -71395,13 +75088,16 @@ gtk_text_buffer_insert_with_tags() is just a convenience function.
<function name="gtk_text_buffer_insert_with_tags_by_name">
<description>
-Same as gtk_text_buffer_insert_with_tags(), but allows you
+Inserts @text into @buffer at @iter, applying the list of tags to
+the newly-inserted text.
+
+Same as [method@Gtk.TextBuffer.insert_with_tags], but allows you
to pass in tag names instead of tag objects.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="iter">
@@ -71430,17 +75126,19 @@ to pass in tag names instead of tag objects.
<function name="gtk_text_buffer_move_mark">
<description>
-Moves @mark to the new location @where. Emits the #GtkTextBuffer::mark-set
+Moves @mark to the new location @where.
+
+Emits the `GtkTextBuffer`::mark-set
signal as notification of the move.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="mark">
-<parameter_description> a #GtkTextMark
+<parameter_description> a `GtkTextMark`
</parameter_description>
</parameter>
<parameter name="where">
@@ -71454,12 +75152,13 @@ signal as notification of the move.
<function name="gtk_text_buffer_move_mark_by_name">
<description>
Moves the mark named @name (which must exist) to location @where.
-See gtk_text_buffer_move_mark() for details.
+
+See [method@Gtk.TextBuffer.move_mark] for details.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="name">
@@ -71492,22 +75191,24 @@ Creates a new text buffer.
<function name="gtk_text_buffer_paste_clipboard">
<description>
-Pastes the contents of a clipboard. If @override_location is %NULL, the
-pasted text will be inserted at the cursor position, or the buffer selection
-will be replaced if the selection is non-empty.
+Pastes the contents of a clipboard.
+
+If @override_location is %NULL, the pasted text will be inserted
+at the cursor position, or the buffer selection will be replaced
+if the selection is non-empty.
-Note: pasting is asynchronous, that is, we’ll ask for the paste data and
-return, and at some point later after the main loop runs, the paste data will
-be inserted.
+Note: pasting is asynchronous, that is, we’ll ask for the paste data
+and return, and at some point later after the main loop runs, the paste
+data will be inserted.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="clipboard">
-<parameter_description> the #GdkClipboard to paste from
+<parameter_description> the `GdkClipboard` to paste from
</parameter_description>
</parameter>
<parameter name="override_location">
@@ -71525,8 +75226,10 @@ be inserted.
<function name="gtk_text_buffer_place_cursor">
<description>
This function moves the “insert” and “selection_bound” marks
-simultaneously. If you move them to the same place in two steps
-with gtk_text_buffer_move_mark(), you will temporarily select a
+simultaneously.
+
+If you move them to the same place in two steps with
+[method@Gtk.TextBuffer.move_mark], you will temporarily select a
region in between their old and new locations, which can be pretty
inefficient since the temporarily-selected region will force stuff
to be recalculated. This function moves them as a unit, which can
@@ -71535,7 +75238,7 @@ be optimized.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="where">
@@ -71553,7 +75256,7 @@ Redoes the next redoable action on the buffer, if there is one.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -71562,16 +75265,17 @@ Redoes the next redoable action on the buffer, if there is one.
<function name="gtk_text_buffer_remove_all_tags">
<description>
-Removes all tags in the range between @start and @end. Be careful
-with this function; it could remove tags added in code unrelated to
-the code you’re currently writing. That is, using this function is
-probably a bad idea if you have two or more unrelated code sections
-that add tags.
+Removes all tags in the range between @start and @end.
+
+Be careful with this function; it could remove tags added in code
+unrelated to the code you’re currently writing. That is, using this
+function is probably a bad idea if you have two or more unrelated
+code sections that add tags.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="start">
@@ -71588,18 +75292,18 @@ that add tags.
<function name="gtk_text_buffer_remove_selection_clipboard">
<description>
-Removes a #GdkClipboard added with
+Removes a `GdkClipboard` added with
gtk_text_buffer_add_selection_clipboard().
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="clipboard">
-<parameter_description> a #GdkClipboard added to @buffer by
-gtk_text_buffer_add_selection_clipboard()
+<parameter_description> a `GdkClipboard` added to @buffer by
+[method@Gtk.TextBuffer.add_selection_clipboard]
</parameter_description>
</parameter>
</parameters>
@@ -71608,18 +75312,20 @@ gtk_text_buffer_add_selection_clipboard()
<function name="gtk_text_buffer_remove_tag">
<description>
-Emits the “remove-tag” signal. The default handler for the signal
-removes all occurrences of @tag from the given range. @start and
-@end don’t have to be in order.
+Emits the “remove-tag” signal.
+
+The default handler for the signal removes all occurrences
+of @tag from the given range. @start and @end don’t have
+to be in order.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="tag">
-<parameter_description> a #GtkTextTag
+<parameter_description> a `GtkTextTag`
</parameter_description>
</parameter>
<parameter name="start">
@@ -71636,17 +75342,20 @@ removes all occurrences of @tag from the given range. @start and
<function name="gtk_text_buffer_remove_tag_by_name">
<description>
-Calls gtk_text_tag_table_lookup() on the buffer’s tag table to
-get a #GtkTextTag, then calls gtk_text_buffer_remove_tag().
+Emits the “remove-tag” signal.
+
+Calls [method@Gtk.TextTagTable.lookup] on the buffer’s
+tag table to get a `GtkTextTag`, then calls
+[method@Gtk.TextBuffer.remove_tag].
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="name">
-<parameter_description> name of a #GtkTextTag
+<parameter_description> name of a `GtkTextTag`
</parameter_description>
</parameter>
<parameter name="start">
@@ -71664,8 +75373,10 @@ get a #GtkTextTag, then calls gtk_text_buffer_remove_tag().
<function name="gtk_text_buffer_select_range">
<description>
This function moves the “insert” and “selection_bound” marks
-simultaneously. If you move them in two steps
-with gtk_text_buffer_move_mark(), you will temporarily select a
+simultaneously.
+
+If you move them in two steps with
+[method@Gtk.TextBuffer.move_mark], you will temporarily select a
region in between their old and new locations, which can be pretty
inefficient since the temporarily-selected region will force stuff
to be recalculated. This function moves them as a unit, which can
@@ -71674,7 +75385,7 @@ be optimized.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="ins">
@@ -71691,18 +75402,19 @@ be optimized.
<function name="gtk_text_buffer_set_enable_undo">
<description>
-Sets whether or not to enable undoable actions in the text buffer. If
-enabled, the user will be able to undo the last number of actions up to
-gtk_text_buffer_get_max_undo_levels().
+Sets whether or not to enable undoable actions in the text buffer.
+
+If enabled, the user will be able to undo the last number of actions
+up to [method@Gtk.TextBuffer.get_max_undo_levels].
-See gtk_text_buffer_begin_irreversible_action() and
-gtk_text_buffer_end_irreversible_action() to create changes to the buffer
-that cannot be undone.
+See [method@Gtk.TextBuffer.begin_irreversible_action] and
+[method@Gtk.TextBuffer.end_irreversible_action] to create
+changes to the buffer that cannot be undone.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="enable_undo">
@@ -71715,26 +75427,27 @@ that cannot be undone.
<function name="gtk_text_buffer_set_mark">
<description>
-Move the mark to the given position, if not @should_exist,
-create the mark.
+Move the mark to the given position.
+
+If not @should_exist, create the mark.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="mark_name">
-<parameter_description> name of the mark
+<parameter_description> name of the mark
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> location for the mark
+<parameter_description> location for the mark
</parameter_description>
</parameter>
<parameter name="left_gravity">
-<parameter_description> if the mark is created by this function, gravity for
+<parameter_description> if the mark is created by this function, gravity for
the new mark
</parameter_description>
</parameter>
@@ -71750,15 +75463,16 @@ immediately
<function name="gtk_text_buffer_set_max_undo_levels">
<description>
-Sets the maximum number of undo levels to perform. If 0, unlimited undo
-actions may be performed. Note that this may have a memory usage impact
-as it requires storing an additional copy of the inserted or removed text
-within the text buffer.
+Sets the maximum number of undo levels to perform.
+
+If 0, unlimited undo actions may be performed. Note that this may
+have a memory usage impact as it requires storing an additional
+copy of the inserted or removed text within the text buffer.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="max_undo_levels">
@@ -71771,16 +75485,20 @@ within the text buffer.
<function name="gtk_text_buffer_set_modified">
<description>
-Used to keep track of whether the buffer has been modified since the
-last time it was saved. Whenever the buffer is saved to disk, call
-gtk_text_buffer_set_modified (@buffer, FALSE). When the buffer is modified,
-it will automatically toggled on the modified bit again. When the modified
-bit flips, the buffer emits the #GtkTextBuffer::modified-changed signal.
+Used to keep track of whether the buffer has been
+modified since the last time it was saved.
+
+Whenever the buffer is saved to disk, call
+`gtk_text_buffer_set_modified (@buffer, FALSE)`.
+When the buffer is modified, it will automatically
+toggled on the modified bit again. When the modified
+bit flips, the buffer emits the
+[signal@Gtk.TextBuffer::modified-changed] signal.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -71793,13 +75511,15 @@ bit flips, the buffer emits the #GtkTextBuffer::modified-changed signal.
<function name="gtk_text_buffer_set_text">
<description>
-Deletes current contents of @buffer, and inserts @text instead. If
-@len is -1, @text must be nul-terminated. @text must be valid UTF-8.
+Deletes current contents of @buffer, and inserts @text instead.
+
+If @len is -1, @text must be nul-terminated.
+@text must be valid UTF-8.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
<parameter name="text">
@@ -71821,7 +75541,7 @@ Undoes the last undoable action on the buffer, if there is one.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -71831,17 +75551,19 @@ Undoes the last undoable action on the buffer, if there is one.
<function name="gtk_text_child_anchor_get_deleted">
<description>
Determines whether a child anchor has been deleted from
-the buffer. Keep in mind that the child anchor will be
-unreferenced when removed from the buffer, so you need to
-hold your own reference (with g_object_ref()) if you plan
-to use this function — otherwise all deleted child anchors
-will also be finalized.
+the buffer.
+
+Keep in mind that the child anchor will be unreferenced
+when removed from the buffer, so you need to hold your own
+reference (with g_object_ref()) if you plan to use this
+function — otherwise all deleted child anchors will also
+be finalized.
</description>
<parameters>
<parameter name="anchor">
-<parameter_description> a #GtkTextChildAnchor
+<parameter_description> a `GtkTextChildAnchor`
</parameter_description>
</parameter>
</parameters>
@@ -71859,7 +75581,7 @@ The order in which the widgets are returned is not defined.
</description>
<parameters>
<parameter name="anchor">
-<parameter_description> a #GtkTextChildAnchor
+<parameter_description> a `GtkTextChildAnchor`
</parameter_description>
</parameter>
<parameter name="out_len">
@@ -71874,16 +75596,18 @@ array of widgets anchored at @anchor
<function name="gtk_text_child_anchor_new">
<description>
-Creates a new #GtkTextChildAnchor. Usually you would then insert
-it into a #GtkTextBuffer with gtk_text_buffer_insert_child_anchor().
-To perform the creation and insertion in one step, use the
-convenience function gtk_text_buffer_create_child_anchor().
+Creates a new `GtkTextChildAnchor`.
+
+Usually you would then insert it into a `GtkTextBuffer` with
+[method@Gtk.TextBuffer.insert_child_anchor]. To perform the
+creation and insertion in one step, use the convenience
+function [method@Gtk.TextBuffer.create_child_anchor].
</description>
<parameters>
</parameters>
-<return> a new #GtkTextChildAnchor
+<return> a new `GtkTextChildAnchor`
</return>
</function>
@@ -71895,59 +75619,59 @@ Retrieves the value set by gtk_text_set_activates_default().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the self will activate the default widget
+<return> %TRUE if the `GtkText` will activate the default widget
</return>
</function>
<function name="gtk_text_get_attributes">
<description>
-Gets the attribute list that was set on the self using
-gtk_text_set_attributes(), if any.
+Gets the attribute list that was set on the `GtkText`
+using gtk_text_set_attributes().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
-<return> the attribute list, or %NULL
-if none was set.
+<return> the attribute list,
+or %NULL if none was set.
</return>
</function>
<function name="gtk_text_get_buffer">
<description>
-Get the #GtkEntryBuffer object which holds the text for
+Get the `GtkEntryBuffer` object which holds the text for
this self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkEntryBuffer object.
+<return> A `GtkEntryBuffer` object.
</return>
</function>
<function name="gtk_text_get_enable_emoji_completion">
<description>
Returns whether Emoji completion is enabled for this
-GtkText widget.
+`GtkText` widget.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
@@ -71963,7 +75687,7 @@ Gets the menu model set with gtk_text_set_extra_menu().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
@@ -71973,12 +75697,12 @@ Gets the menu model set with gtk_text_set_extra_menu().
<function name="gtk_text_get_input_hints">
<description>
-Gets the value of the #GtkText:input-hints property.
+Gets the input hints of the `GtkText`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
@@ -71987,12 +75711,12 @@ Gets the value of the #GtkText:input-hints property.
<function name="gtk_text_get_input_purpose">
<description>
-Gets the value of the #GtkText:input-purpose property.
+Gets the input purpose of the `GtkText`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
@@ -72002,16 +75726,17 @@ Gets the value of the #GtkText:input-purpose property.
<function name="gtk_text_get_invisible_char">
<description>
Retrieves the character displayed in place of the real characters
-for entries with visibility set to false. Note that GTK does not
-compute this value unless it needs it, so the value returned by
-this function is not very useful unless it has been explicitly
-set with gtk_text_set_invisible_char()
+for entries with visibility set to false.
+
+Note that GTK does not compute this value unless it needs it,
+so the value returned by this function is not very useful unless
+it has been explicitly set with [method Gtk Text.set_invisible_char].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
@@ -72022,22 +75747,23 @@ show invisible text at all.
<function name="gtk_text_get_max_length">
<description>
-Retrieves the maximum allowed length of the text in
-@self. See gtk_text_set_max_length().
+Retrieves the maximum allowed length of the text in @self.
+
+See [method Gtk Text.set_max_length].
-This is equivalent to getting @self's #GtkEntryBuffer and
-calling gtk_entry_buffer_get_max_length() on it.
+This is equivalent to getting @self's `GtkEntryBuffer` and
+calling [method@Gtk.EntryBuffer.get_max_length] on it.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
<return> the maximum allowed number of characters
-in #GtkText, or 0 if there is no maximum.
+in `GtkText`, or 0 if there is no maximum.
</return>
</function>
@@ -72049,7 +75775,7 @@ Gets the value set by gtk_text_set_overwrite_mode().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
@@ -72059,33 +75785,35 @@ Gets the value set by gtk_text_set_overwrite_mode().
<function name="gtk_text_get_placeholder_text">
<description>
-Retrieves the text that will be displayed when @self is empty and unfocused
+Retrieves the text that will be displayed when
+@self is empty and unfocused
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the placeholder text as a string.
-This string points to internally allocated storage in the widget and must
-not be freed, modified or stored. If no placeholder text has been set,
-%NULL will be returned.
+<return> a pointer
+to the placeholder text as a string. This string
+points to internally allocated storage in the widget
+and must not be freed, modified or stored. If no placeholder
+text has been set, %NULL will be returned.
</return>
</function>
<function name="gtk_text_get_propagate_text_width">
<description>
-Returns whether the #GtkText will grow and shrink
+Returns whether the `GtkText` will grow and shrink
with the content.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
@@ -72095,53 +75823,52 @@ with the content.
<function name="gtk_text_get_tabs">
<description>
-Gets the tabstops that were set on the self using gtk_text_set_tabs(), if
-any.
+Gets the tabstops that were set on the `GtkText`
+using gtk_text_set_tabs().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
-<return> the tabstops, or %NULL if none was set.
+<return> the tabstops,
+or %NULL if none was set.
</return>
</function>
<function name="gtk_text_get_text_length">
<description>
-Retrieves the current length of the text in
-@self.
-
-This is equivalent to getting @self's #GtkEntryBuffer and
-calling gtk_entry_buffer_get_length() on it.
+Retrieves the current length of the text in @self.
+This is equivalent to getting @self's `GtkEntryBuffer`
+and calling [method@Gtk.EntryBuffer.get_length] on it.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
<return> the current number of characters
-in #GtkText, or 0 if there are none.
+in `GtkText`, or 0 if there are none.
</return>
</function>
<function name="gtk_text_get_truncate_multiline">
<description>
-Returns whether the #GtkText will truncate multi-line text
+Returns whether the `GtkText` will truncate multi-line text
that is pasted into the widget
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
@@ -72152,13 +75879,12 @@ that is pasted into the widget
<function name="gtk_text_get_visibility">
<description>
Retrieves whether the text in @self is visible.
-See gtk_text_set_visibility().
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
@@ -72170,7 +75896,7 @@ See gtk_text_set_visibility().
<description>
Causes @self to have keyboard focus.
-It behaves like gtk_widget_grab_focus(),
+It behaves like [method@Gtk.Widget.grab_focus],
except that it doesn't select the contents of @self.
You only want to call this on some special entries
which the user usually doesn't want to replace all text in,
@@ -72180,7 +75906,7 @@ such as search-as-you-type entries.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
@@ -72190,19 +75916,21 @@ such as search-as-you-type entries.
<function name="gtk_text_iter_assign">
<description>
-Assigns the value of @other to @iter. This function
-is not useful in applications, because iterators can be assigned
-with `GtkTextIter i = j;`. The
-function is used by language bindings.
+Assigns the value of @other to @iter.
+
+This function is not useful in applications, because
+iterators can be assigned with `GtkTextIter i = j;`.
+
+The function is used by language bindings.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="other">
-<parameter_description> another #GtkTextIter
+<parameter_description> another `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -72211,10 +75939,7 @@ function is used by language bindings.
<function name="gtk_text_iter_backward_char">
<description>
-Moves backward by one character offset. Returns %TRUE if movement
-was possible; if @iter was the first in the buffer (character
-offset 0), gtk_text_iter_backward_char() returns %FALSE for convenience when
-writing loops.
+Moves backward by one character offset.
</description>
@@ -72230,9 +75955,12 @@ writing loops.
<function name="gtk_text_iter_backward_chars">
<description>
-Moves @count characters backward, if possible (if @count would move
-past the start or end of the buffer, moves to the start or end of
-the buffer). The return value indicates whether the iterator moved
+Moves @count characters backward, if possible.
+
+If @count would move past the start or end of the buffer, moves
+to the start or end of the buffer.
+
+The return value indicates whether the iterator moved
onto a dereferenceable position; if the iterator didn’t move, or
moved onto the end iterator, then %FALSE is returned. If @count is 0,
the function does nothing and returns %FALSE.
@@ -72250,7 +75978,6 @@ the function does nothing and returns %FALSE.
</parameter>
</parameters>
<return> whether @iter moved and is dereferenceable
-
</return>
</function>
@@ -72262,7 +75989,7 @@ Like gtk_text_iter_forward_cursor_position(), but moves backward.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -72272,14 +75999,15 @@ Like gtk_text_iter_forward_cursor_position(), but moves backward.
<function name="gtk_text_iter_backward_cursor_positions">
<description>
-Moves up to @count cursor positions. See
-gtk_text_iter_forward_cursor_position() for details.
+Moves up to @count cursor positions.
+
+See [method@Gtk.TextIter.forward_cursor_position] for details.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="count">
@@ -72293,13 +76021,14 @@ gtk_text_iter_forward_cursor_position() for details.
<function name="gtk_text_iter_backward_find_char">
<description>
-Same as gtk_text_iter_forward_find_char(), but goes backward from @iter.
+Same as gtk_text_iter_forward_find_char(),
+but goes backward from @iter.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="pred">
@@ -72321,13 +76050,7 @@ Same as gtk_text_iter_forward_find_char(), but goes backward from @iter.
<function name="gtk_text_iter_backward_line">
<description>
-Moves @iter to the start of the previous line. Returns %TRUE if
-@iter could be moved; i.e. if @iter was at character offset 0, this
-function returns %FALSE. Therefore if @iter was already on line 0,
-but not at the start of the line, @iter is snapped to the start of
-the line and the function returns %TRUE. (Note that this implies that
-in a loop calling this function, the line number may not change on
-every iteration, if your first iteration is on line 0.)
+Moves @iter to the start of the previous line.
</description>
@@ -72343,9 +76066,12 @@ every iteration, if your first iteration is on line 0.)
<function name="gtk_text_iter_backward_lines">
<description>
-Moves @count lines backward, if possible (if @count would move
-past the start or end of the buffer, moves to the start or end of
-the buffer). The return value indicates whether the iterator moved
+Moves @count lines backward, if possible.
+
+If @count would move past the start or end of the buffer, moves to
+the start or end of the buffer.
+
+The return value indicates whether the iterator moved
onto a dereferenceable position; if the iterator didn’t move, or
moved onto the end iterator, then %FALSE is returned. If @count is 0,
the function does nothing and returns %FALSE. If @count is negative,
@@ -72355,7 +76081,7 @@ moves forward by 0 - @count lines.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="count">
@@ -72371,14 +76097,14 @@ moves forward by 0 - @count lines.
<description>
Same as gtk_text_iter_forward_search(), but moves backward.
-@match_end will never be set to a #GtkTextIter located after @iter, even if
-there is a possible @match_start before or at @iter.
+@match_end will never be set to a `GtkTextIter` located after @iter,
+even if there is a possible @match_start before or at @iter.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter where the search begins
+<parameter_description> a `GtkTextIter` where the search begins
</parameter_description>
</parameter>
<parameter name="str">
@@ -72408,17 +76134,19 @@ there is a possible @match_start before or at @iter.
<function name="gtk_text_iter_backward_sentence_start">
<description>
-Moves backward to the previous sentence start; if @iter is already at
-the start of a sentence, moves backward to the next one. Sentence
-boundaries are determined by Pango and should be correct for nearly
-any language (if not, the correct fix would be to the Pango text
-boundary algorithms).
+Moves backward to the previous sentence start.
+
+If @iter is already at the start of a sentence, moves backward
+to the next one.
+
+Sentence boundaries are determined by Pango and should
+be correct for nearly any language.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -72428,15 +76156,15 @@ boundary algorithms).
<function name="gtk_text_iter_backward_sentence_starts">
<description>
-Calls gtk_text_iter_backward_sentence_start() up to @count times,
-or until it returns %FALSE. If @count is negative, moves forward
-instead of backward.
+Calls gtk_text_iter_backward_sentence_start() up to @count times.
+
+If @count is negative, moves forward instead of backward.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="count">
@@ -72474,8 +76202,10 @@ gtk_text_iter_get_slice().
<function name="gtk_text_iter_backward_to_tag_toggle">
<description>
Moves backward to the next toggle (on or off) of the
-#GtkTextTag @tag, or to the next toggle of any tag if
-@tag is %NULL. If no matching tag toggles are found,
+@tag, or to the next toggle of any tag if
+@tag is %NULL.
+
+If no matching tag toggles are found,
returns %FALSE, otherwise %TRUE. Does not return toggles
located at @iter, only toggles before @iter. Sets @iter
to the location of the toggle, or the start of the buffer
@@ -72485,11 +76215,11 @@ if no toggle is found.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="tag">
-<parameter_description> a #GtkTextTag, or %NULL
+<parameter_description> a `GtkTextTag`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -72499,14 +76229,15 @@ if no toggle is found.
<function name="gtk_text_iter_backward_visible_cursor_position">
<description>
-Moves @iter forward to the previous visible cursor position. See
-gtk_text_iter_backward_cursor_position() for details.
+Moves @iter forward to the previous visible cursor position.
+
+See [method@Gtk.TextIter.backward_cursor_position] for details.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -72516,14 +76247,15 @@ gtk_text_iter_backward_cursor_position() for details.
<function name="gtk_text_iter_backward_visible_cursor_positions">
<description>
-Moves up to @count visible cursor positions. See
-gtk_text_iter_backward_cursor_position() for details.
+Moves up to @count visible cursor positions.
+
+See [method@Gtk.TextIter.backward_cursor_position] for details.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="count">
@@ -72537,13 +76269,7 @@ gtk_text_iter_backward_cursor_position() for details.
<function name="gtk_text_iter_backward_visible_line">
<description>
-Moves @iter to the start of the previous visible line. Returns %TRUE if
-@iter could be moved; i.e. if @iter was at character offset 0, this
-function returns %FALSE. Therefore if @iter was already on line 0,
-but not at the start of the line, @iter is snapped to the start of
-the line and the function returns %TRUE. (Note that this implies that
-in a loop calling this function, the line number may not change on
-every iteration, if your first iteration is on line 0.)
+Moves @iter to the start of the previous visible line.
</description>
@@ -72559,9 +76285,12 @@ every iteration, if your first iteration is on line 0.)
<function name="gtk_text_iter_backward_visible_lines">
<description>
-Moves @count visible lines backward, if possible (if @count would move
-past the start or end of the buffer, moves to the start or end of
-the buffer). The return value indicates whether the iterator moved
+Moves @count visible lines backward, if possible.
+
+If @count would move past the start or end of the buffer, moves to
+the start or end of the buffer.
+
+The return value indicates whether the iterator moved
onto a dereferenceable position; if the iterator didn’t move, or
moved onto the end iterator, then %FALSE is returned. If @count is 0,
the function does nothing and returns %FALSE. If @count is negative,
@@ -72571,7 +76300,7 @@ moves forward by 0 - @count lines.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="count">
@@ -72585,21 +76314,23 @@ moves forward by 0 - @count lines.
<function name="gtk_text_iter_backward_visible_word_start">
<description>
-Moves backward to the previous visible word start. (If @iter is currently
-on a word start, moves backward to the next one after that.) Word breaks
-are determined by Pango and should be correct for nearly any
-language (if not, the correct fix would be to the Pango word break
-algorithms).
+Moves backward to the previous visible word start.
+
+If @iter is currently on a word start, moves backward to the
+next one after that.
+
+Word breaks are determined by Pango and should be correct
+for nearly any language.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
+<return> %TRUE if @iter moved and is not the end iterator
</return>
</function>
@@ -72611,7 +76342,7 @@ Calls gtk_text_iter_backward_visible_word_start() up to @count times.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="count">
@@ -72619,27 +76350,29 @@ Calls gtk_text_iter_backward_visible_word_start() up to @count times.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
+<return> %TRUE if @iter moved and is not the end iterator
</return>
</function>
<function name="gtk_text_iter_backward_word_start">
<description>
-Moves backward to the previous word start. (If @iter is currently on a
-word start, moves backward to the next one after that.) Word breaks
-are determined by Pango and should be correct for nearly any
-language (if not, the correct fix would be to the Pango word break
-algorithms).
+Moves backward to the previous word start.
+
+If @iter is currently on a word start, moves backward to the
+next one after that.
+
+Word breaks are determined by Pango and should be correct
+for nearly any language
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
+<return> %TRUE if @iter moved and is not the end iterator
</return>
</function>
@@ -72651,7 +76384,7 @@ Calls gtk_text_iter_backward_word_start() up to @count times.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="count">
@@ -72659,7 +76392,7 @@ Calls gtk_text_iter_backward_word_start() up to @count times.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
+<return> %TRUE if @iter moved and is not the end iterator
</return>
</function>
@@ -72667,10 +76400,12 @@ Calls gtk_text_iter_backward_word_start() up to @count times.
<description>
Considering the default editability of the buffer, and tags that
affect editability, determines whether text inserted at @iter would
-be editable. If text inserted at @iter would be editable then the
+be editable.
+
+If text inserted at @iter would be editable then the
user should be allowed to insert text at @iter.
-gtk_text_buffer_insert_interactive() uses this function to decide
-whether insertions are allowed at a given position.
+[method@Gtk.TextBuffer.insert_interactive] uses this function
+to decide whether insertions are allowed at a given position.
</description>
@@ -72692,18 +76427,19 @@ whether insertions are allowed at a given position.
<description>
A qsort()-style function that returns negative if @lhs is less than
@rhs, positive if @lhs is greater than @rhs, and 0 if they’re equal.
-Ordering is in character offset order, i.e. the first character in the buffer
-is less than the second character in the buffer.
+
+Ordering is in character offset order, i.e. the first character
+in the buffer is less than the second character in the buffer.
</description>
<parameters>
<parameter name="lhs">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="rhs">
-<parameter_description> another #GtkTextIter
+<parameter_description> another `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -72713,10 +76449,13 @@ is less than the second character in the buffer.
<function name="gtk_text_iter_copy">
<description>
-Creates a dynamically-allocated copy of an iterator. This function
-is not useful in applications, because iterators can be copied with a
-simple assignment (`GtkTextIter i = j;`). The
-function is used by language bindings.
+Creates a dynamically-allocated copy of an iterator.
+
+This function is not useful in applications, because
+iterators can be copied with a simple assignment
+(`GtkTextIter i = j;`).
+
+The function is used by language bindings.
</description>
@@ -72726,7 +76465,7 @@ function is used by language bindings.
</parameter_description>
</parameter>
</parameters>
-<return> a copy of the @iter, free with gtk_text_iter_free()
+<return> a copy of the @iter, free with [method Gtk TextIter free]
</return>
</function>
@@ -72743,7 +76482,7 @@ You don’t want to use this function to decide whether text can be
inserted at @iter, because for insertion you don’t want to know
whether the char at @iter is inside an editable range, you want to
know whether a new character inserted at @iter would be inside an
-editable range. Use gtk_text_iter_can_insert() to handle this
+editable range. Use [method@Gtk.TextIter.can_insert] to handle this
case.
@@ -72765,13 +76504,16 @@ case.
<function name="gtk_text_iter_ends_line">
<description>
Returns %TRUE if @iter points to the start of the paragraph
-delimiter characters for a line (delimiters will be either a
-newline, a carriage return, a carriage return followed by a
-newline, or a Unicode paragraph separator character). Note that an
-iterator pointing to the \n of a \r\n pair will not be counted as
-the end of a line, the line ends before the \r. The end iterator is
-considered to be at the end of a line, even though there are no
-paragraph delimiter chars there.
+delimiter characters for a line.
+
+Delimiters will be either a newline, a carriage return, a carriage
+return followed by a newline, or a Unicode paragraph separator
+character.
+
+Note that an iterator pointing to the \n of a \r\n pair will not be
+counted as the end of a line, the line ends before the \r. The end
+iterator is considered to be at the end of a line, even though there
+are no paragraph delimiter chars there.
</description>
@@ -72787,16 +76529,16 @@ paragraph delimiter chars there.
<function name="gtk_text_iter_ends_sentence">
<description>
-Determines whether @iter ends a sentence. Sentence boundaries are
-determined by Pango and should be correct for nearly any language
-(if not, the correct fix would be to the Pango text boundary
-algorithms).
+Determines whether @iter ends a sentence.
+
+Sentence boundaries are determined by Pango and should
+be correct for nearly any language.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -72806,14 +76548,16 @@ algorithms).
<function name="gtk_text_iter_ends_tag">
<description>
-Returns %TRUE if @tag is toggled off at exactly this point. If @tag
-is %NULL, returns %TRUE if any tag is toggled off at this point.
+Returns %TRUE if @tag is toggled off at exactly this point.
-Note that if gtk_text_iter_ends_tag() returns %TRUE, it means that @iter is
-at the end of the tagged range, but that the character
+If @tag is %NULL, returns %TRUE if any tag is toggled off at this point.
+
+Note that if this function returns %TRUE, it means that
+@iter is at the end of the tagged range, but that the character
at @iter is outside the tagged range. In other words,
-unlike gtk_text_iter_starts_tag(), if gtk_text_iter_ends_tag() returns %TRUE,
-gtk_text_iter_has_tag() will return %FALSE for the same parameters.
+unlike [method@Gtk.TextIter.starts_tag], if this function
+returns %TRUE, [method@Gtk.TextIter.has_tag] will return
+%FALSE for the same parameters.
</description>
@@ -72823,7 +76567,7 @@ gtk_text_iter_has_tag() will return %FALSE for the same parameters.
</parameter_description>
</parameter>
<parameter name="tag">
-<parameter_description> a #GtkTextTag, or %NULL
+<parameter_description> a `GtkTextTag`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -72833,16 +76577,16 @@ gtk_text_iter_has_tag() will return %FALSE for the same parameters.
<function name="gtk_text_iter_ends_word">
<description>
-Determines whether @iter ends a natural-language word. Word breaks
-are determined by Pango and should be correct for nearly any
-language (if not, the correct fix would be to the Pango word break
-algorithms).
+Determines whether @iter ends a natural-language word.
+
+Word breaks are determined by Pango and should be correct
+for nearly any language.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -72853,20 +76597,22 @@ algorithms).
<function name="gtk_text_iter_equal">
<description>
Tests whether two iterators are equal, using the fastest possible
-mechanism. This function is very fast; you can expect it to perform
-better than e.g. getting the character offset for each iterator and
-comparing the offsets yourself. Also, it’s a bit faster than
-gtk_text_iter_compare().
+mechanism.
+
+This function is very fast; you can expect it to perform
+better than e.g. getting the character offset for each
+iterator and comparing the offsets yourself. Also, it’s a
+bit faster than [method@Gtk.TextIter.compare].
</description>
<parameters>
<parameter name="lhs">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="rhs">
-<parameter_description> another #GtkTextIter
+<parameter_description> another `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -72876,13 +76622,13 @@ gtk_text_iter_compare().
<function name="gtk_text_iter_forward_char">
<description>
-Moves @iter forward by one character offset. Note that images
-embedded in the buffer occupy 1 character slot, so
-gtk_text_iter_forward_char() may actually move onto an image instead
-of a character, if you have images in your buffer. If @iter is the
-end iterator or one character before it, @iter will now point at
-the end iterator, and gtk_text_iter_forward_char() returns %FALSE for
-convenience when writing loops.
+Moves @iter forward by one character offset.
+
+Note that images embedded in the buffer occupy 1 character slot, so
+this function may actually move onto an image instead of a character,
+if you have images in your buffer. If @iter is the end iterator or
+one character before it, @iter will now point at the end iterator,
+and this function returns %FALSE for convenience when writing loops.
</description>
@@ -72898,9 +76644,12 @@ convenience when writing loops.
<function name="gtk_text_iter_forward_chars">
<description>
-Moves @count characters if possible (if @count would move past the
-start or end of the buffer, moves to the start or end of the
-buffer). The return value indicates whether the new position of
+Moves @count characters if possible.
+
+If @count would move past the start or end of the buffer,
+moves to the start or end of the buffer.
+
+The return value indicates whether the new position of
@iter is different from its original position, and dereferenceable
(the last iterator in the buffer is not dereferenceable). If @count
is 0, the function does nothing and returns %FALSE.
@@ -72923,22 +76672,27 @@ is 0, the function does nothing and returns %FALSE.
<function name="gtk_text_iter_forward_cursor_position">
<description>
-Moves @iter forward by a single cursor position. Cursor positions
-are (unsurprisingly) positions where the cursor can appear. Perhaps
-surprisingly, there may not be a cursor position between all
-characters. The most common example for European languages would be
-a carriage return/newline sequence. For some Unicode characters,
-the equivalent of say the letter “a” with an accent mark will be
-represented as two characters, first the letter then a "combining
-mark" that causes the accent to be rendered; so the cursor can’t go
-between those two characters. See also the #PangoLogAttr-struct and
-pango_break() function.
+Moves @iter forward by a single cursor position.
+
+Cursor positions are (unsurprisingly) positions where the
+cursor can appear. Perhaps surprisingly, there may not be
+a cursor position between all characters. The most common
+example for European languages would be a carriage return/newline
+sequence.
+
+For some Unicode characters, the equivalent of say the letter “a”
+with an accent mark will be represented as two characters, first
+the letter then a "combining mark" that causes the accent to be
+rendered; so the cursor can’t go between those two characters.
+
+See also the [struct@Pango.LogAttr] struct and the [func@Pango.break]
+function.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -72948,14 +76702,15 @@ pango_break() function.
<function name="gtk_text_iter_forward_cursor_positions">
<description>
-Moves up to @count cursor positions. See
-gtk_text_iter_forward_cursor_position() for details.
+Moves up to @count cursor positions.
+
+See [method@Gtk.TextIter.forward_cursor_position] for details.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="count">
@@ -72969,8 +76724,9 @@ gtk_text_iter_forward_cursor_position() for details.
<function name="gtk_text_iter_forward_find_char">
<description>
-Advances @iter, calling @pred on each character. If
-@pred returns %TRUE, returns %TRUE and stops scanning.
+Advances @iter, calling @pred on each character.
+
+If @pred returns %TRUE, returns %TRUE and stops scanning.
If @pred never returns %TRUE, @iter is set to @limit if
@limit is non-%NULL, otherwise to the end iterator.
@@ -72978,7 +76734,7 @@ If @pred never returns %TRUE, @iter is set to @limit if
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="pred">
@@ -72990,7 +76746,7 @@ If @pred never returns %TRUE, @iter is set to @limit if
</parameter_description>
</parameter>
<parameter name="limit">
-<parameter_description> search limit, or %NULL for none
+<parameter_description> search limit, or %NULL for none
</parameter_description>
</parameter>
</parameters>
@@ -73000,9 +76756,11 @@ If @pred never returns %TRUE, @iter is set to @limit if
<function name="gtk_text_iter_forward_line">
<description>
-Moves @iter to the start of the next line. If the iter is already on the
-last line of the buffer, moves the iter to the end of the current line.
-If after the operation, the iter is at the end of the buffer and not
+Moves @iter to the start of the next line.
+
+If the iter is already on the last line of the buffer,
+moves the iter to the end of the current line. If after
+the operation, the iter is at the end of the buffer and not
dereferenceable, returns %FALSE. Otherwise, returns %TRUE.
@@ -73019,9 +76777,12 @@ dereferenceable, returns %FALSE. Otherwise, returns %TRUE.
<function name="gtk_text_iter_forward_lines">
<description>
-Moves @count lines forward, if possible (if @count would move
-past the start or end of the buffer, moves to the start or end of
-the buffer). The return value indicates whether the iterator moved
+Moves @count lines forward, if possible.
+
+If @count would move past the start or end of the buffer, moves to
+the start or end of the buffer.
+
+The return value indicates whether the iterator moved
onto a dereferenceable position; if the iterator didn’t move, or
moved onto the end iterator, then %FALSE is returned. If @count is 0,
the function does nothing and returns %FALSE. If @count is negative,
@@ -73031,7 +76792,7 @@ moves backward by 0 - @count lines.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="count">
@@ -73045,15 +76806,16 @@ moves backward by 0 - @count lines.
<function name="gtk_text_iter_forward_search">
<description>
-Searches forward for @str. Any match is returned by setting
-@match_start to the first character of the match and @match_end to the
-first character after the match. The search will not continue past
-@limit. Note that a search is a linear or O(n) operation, so you
-may wish to use @limit to avoid locking up your UI on large
-buffers.
+Searches forward for @str.
-@match_start will never be set to a #GtkTextIter located before @iter, even if
-there is a possible @match_end after or at @iter.
+Any match is returned by setting @match_start to the first character
+of the match and @match_end to the first character after the match.
+The search will not continue past @limit. Note that a search is a
+linear or O(n) operation, so you may wish to use @limit to avoid
+locking up your UI on large buffers.
+
+@match_start will never be set to a `GtkTextIter` located before @iter,
+even if there is a possible @match_end after or at @iter.
</description>
@@ -73089,17 +76851,19 @@ there is a possible @match_end after or at @iter.
<function name="gtk_text_iter_forward_sentence_end">
<description>
-Moves forward to the next sentence end. (If @iter is at the end of
-a sentence, moves to the next end of sentence.) Sentence
-boundaries are determined by Pango and should be correct for nearly
-any language (if not, the correct fix would be to the Pango text
-boundary algorithms).
+Moves forward to the next sentence end.
+
+If @iter is at the end of a sentence, moves to the next
+end of sentence.
+
+Sentence boundaries are determined by Pango and should
+be correct for nearly any language.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -73109,15 +76873,15 @@ boundary algorithms).
<function name="gtk_text_iter_forward_sentence_ends">
<description>
-Calls gtk_text_iter_forward_sentence_end() @count times (or until
-gtk_text_iter_forward_sentence_end() returns %FALSE). If @count is
-negative, moves backward instead of forward.
+Calls gtk_text_iter_forward_sentence_end() @count times.
+
+If @count is negative, moves backward instead of forward.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="count">
@@ -73131,10 +76895,12 @@ negative, moves backward instead of forward.
<function name="gtk_text_iter_forward_text_chars">
<description>
-Moves forward by @count text characters (paintables, widgets,
-etc. do not count as characters for this). Equivalent to moving
-through the results of gtk_text_iter_get_text(), rather than
-gtk_text_iter_get_slice().
+Moves forward by @count text characters.
+
+Paintables, widgets, etc. do not count as characters for this.
+
+Equivalent to moving through the results of gtk_text_iter_get_text(),
+rather than gtk_text_iter_get_slice().
</description>
@@ -73154,14 +76920,16 @@ gtk_text_iter_get_slice().
<function name="gtk_text_iter_forward_to_end">
<description>
-Moves @iter forward to the “end iterator,” which points one past the last
-valid character in the buffer. gtk_text_iter_get_char() called on the
-end iterator returns 0, which is convenient for writing loops.
+Moves @iter forward to the “end iterator”, which points
+one past the last valid character in the buffer.
+
+gtk_text_iter_get_char() called on the end iterator
+returns 0, which is convenient for writing loops.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -73170,10 +76938,13 @@ end iterator returns 0, which is convenient for writing loops.
<function name="gtk_text_iter_forward_to_line_end">
<description>
-Moves the iterator to point to the paragraph delimiter characters,
-which will be either a newline, a carriage return, a carriage
-return/newline in sequence, or the Unicode paragraph separator
-character. If the iterator is already at the paragraph delimiter
+Moves the iterator to point to the paragraph delimiter characters.
+
+The possible characters are either a newline, a carriage return,
+a carriage return/newline in sequence, or the Unicode paragraph
+separator character.
+
+If the iterator is already at the paragraph delimiter
characters, moves to the paragraph delimiter characters for the
next line. If @iter is on the last line in the buffer, which does
not end in paragraph delimiters, moves to the end iterator (end of
@@ -73183,7 +76954,7 @@ the last line), and returns %FALSE.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -73194,8 +76965,10 @@ the last line), and returns %FALSE.
<function name="gtk_text_iter_forward_to_tag_toggle">
<description>
Moves forward to the next toggle (on or off) of the
-#GtkTextTag @tag, or to the next toggle of any tag if
-@tag is %NULL. If no matching tag toggles are found,
+@tag, or to the next toggle of any tag if
+@tag is %NULL.
+
+If no matching tag toggles are found,
returns %FALSE, otherwise %TRUE. Does not return toggles
located at @iter, only toggles after @iter. Sets @iter to
the location of the toggle, or to the end of the buffer
@@ -73205,11 +76978,11 @@ if no toggle is found.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="tag">
-<parameter_description> a #GtkTextTag, or %NULL
+<parameter_description> a `GtkTextTag`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -73219,14 +76992,15 @@ if no toggle is found.
<function name="gtk_text_iter_forward_visible_cursor_position">
<description>
-Moves @iter forward to the next visible cursor position. See
-gtk_text_iter_forward_cursor_position() for details.
+Moves @iter forward to the next visible cursor position.
+
+See [method@Gtk.TextIter.forward_cursor_position] for details.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -73236,14 +77010,15 @@ gtk_text_iter_forward_cursor_position() for details.
<function name="gtk_text_iter_forward_visible_cursor_positions">
<description>
-Moves up to @count visible cursor positions. See
-gtk_text_iter_forward_cursor_position() for details.
+Moves up to @count visible cursor positions.
+
+See [method@Gtk.TextIter.forward_cursor_position] for details.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="count">
@@ -73257,10 +77032,7 @@ gtk_text_iter_forward_cursor_position() for details.
<function name="gtk_text_iter_forward_visible_line">
<description>
-Moves @iter to the start of the next visible line. Returns %TRUE if there
-was a next line to move to, and %FALSE if @iter was simply moved to
-the end of the buffer and is now not dereferenceable, or if @iter was
-already at the end of the buffer.
+Moves @iter to the start of the next visible line.
</description>
@@ -73276,9 +77048,12 @@ already at the end of the buffer.
<function name="gtk_text_iter_forward_visible_lines">
<description>
-Moves @count visible lines forward, if possible (if @count would move
-past the start or end of the buffer, moves to the start or end of
-the buffer). The return value indicates whether the iterator moved
+Moves @count visible lines forward, if possible.
+
+If @count would move past the start or end of the buffer, moves to
+the start or end of the buffer.
+
+The return value indicates whether the iterator moved
onto a dereferenceable position; if the iterator didn’t move, or
moved onto the end iterator, then %FALSE is returned. If @count is 0,
the function does nothing and returns %FALSE. If @count is negative,
@@ -73288,7 +77063,7 @@ moves backward by 0 - @count lines.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="count">
@@ -73302,21 +77077,23 @@ moves backward by 0 - @count lines.
<function name="gtk_text_iter_forward_visible_word_end">
<description>
-Moves forward to the next visible word end. (If @iter is currently on a
-word end, moves forward to the next one after that.) Word breaks
-are determined by Pango and should be correct for nearly any
-language (if not, the correct fix would be to the Pango word break
-algorithms).
+Moves forward to the next visible word end.
+
+If @iter is currently on a word end, moves forward to the
+next one after that.
+
+Word breaks are determined by Pango and should be correct
+for nearly any language
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
+<return> %TRUE if @iter moved and is not the end iterator
</return>
</function>
@@ -73328,7 +77105,7 @@ Calls gtk_text_iter_forward_visible_word_end() up to @count times.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="count">
@@ -73336,27 +77113,29 @@ Calls gtk_text_iter_forward_visible_word_end() up to @count times.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
+<return> %TRUE if @iter moved and is not the end iterator
</return>
</function>
<function name="gtk_text_iter_forward_word_end">
<description>
-Moves forward to the next word end. (If @iter is currently on a
-word end, moves forward to the next one after that.) Word breaks
-are determined by Pango and should be correct for nearly any
-language (if not, the correct fix would be to the Pango word break
-algorithms).
+Moves forward to the next word end.
+
+If @iter is currently on a word end, moves forward to the
+next one after that.
+
+Word breaks are determined by Pango and should be correct
+for nearly any language.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
+<return> %TRUE if @iter moved and is not the end iterator
</return>
</function>
@@ -73368,7 +77147,7 @@ Calls gtk_text_iter_forward_word_end() up to @count times.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="count">
@@ -73376,16 +77155,17 @@ Calls gtk_text_iter_forward_word_end() up to @count times.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
+<return> %TRUE if @iter moved and is not the end iterator
</return>
</function>
<function name="gtk_text_iter_free">
<description>
-Free an iterator allocated on the heap. This function
-is intended for use in language bindings, and is not
-especially useful for applications, because iterators can
-simply be allocated on the stack.
+Free an iterator allocated on the heap.
+
+This function is intended for use in language bindings,
+and is not especially useful for applications, because
+iterators can simply be allocated on the stack.
</description>
<parameters>
@@ -73399,7 +77179,7 @@ simply be allocated on the stack.
<function name="gtk_text_iter_get_buffer">
<description>
-Returns the #GtkTextBuffer this iterator is associated with.
+Returns the `GtkTextBuffer` this iterator is associated with.
</description>
@@ -73432,13 +77212,15 @@ including the paragraph delimiters.
<function name="gtk_text_iter_get_char">
<description>
-The Unicode character at this iterator is returned. (Equivalent to
-operator* on a C++ iterator.) If the element at this iterator is a
-non-character element, such as an image embedded in the buffer, the
-Unicode “unknown” character 0xFFFC is returned. If invoked on
-the end iterator, zero is returned; zero is not a valid Unicode character.
-So you can write a loop which ends when gtk_text_iter_get_char()
-returns 0.
+The Unicode character at this iterator is returned.
+
+Equivalent to operator* on a C++ iterator. If the element at
+this iterator is a non-character element, such as an image
+embedded in the buffer, the Unicode “unknown” character 0xFFFC
+is returned. If invoked on the end iterator, zero is returned;
+zero is not a valid Unicode character.
+
+So you can write a loop which ends when this function returns 0.
</description>
@@ -73472,8 +77254,9 @@ including the paragraph delimiters.
<function name="gtk_text_iter_get_child_anchor">
<description>
If the location at @iter contains a child anchor, the
-anchor is returned (with no new reference count added). Otherwise,
-%NULL is returned.
+anchor is returned.
+
+Otherwise, %NULL is returned.
</description>
@@ -73492,7 +77275,7 @@ anchor is returned (with no new reference count added). Otherwise,
Returns the language in effect at @iter.
If no tags affecting language apply to @iter, the return
-value is identical to that of gtk_get_default_language().
+value is identical to that of [func@Gtk.get_default_language].
</description>
@@ -73508,9 +77291,10 @@ value is identical to that of gtk_get_default_language().
<function name="gtk_text_iter_get_line">
<description>
-Returns the line number containing the iterator. Lines in
-a #GtkTextBuffer are numbered beginning with 0 for the first
-line in the buffer.
+Returns the line number containing the iterator.
+
+Lines in a `GtkTextBuffer` are numbered beginning
+with 0 for the first line in the buffer.
</description>
@@ -73528,7 +77312,8 @@ line in the buffer.
<description>
Returns the byte index of the iterator, counting
from the start of a newline-terminated line.
-Remember that #GtkTextBuffer encodes text in
+
+Remember that `GtkTextBuffer` encodes text in
UTF-8, and that characters can require a variable
number of bytes to represent.
@@ -73548,6 +77333,7 @@ number of bytes to represent.
<description>
Returns the character offset of the iterator,
counting from the start of a newline-terminated line.
+
The first character on the line has offset 0.
@@ -73564,11 +77350,13 @@ The first character on the line has offset 0.
<function name="gtk_text_iter_get_marks">
<description>
-Returns a list of all #GtkTextMark at this location. Because marks
-are not iterable (they don’t take up any "space" in the buffer,
-they are just marks in between iterable locations), multiple marks
-can exist in the same place. The returned list is not in any
-meaningful order.
+Returns a list of all `GtkTextMark` at this location.
+
+Because marks are not iterable (they don’t take up any "space"
+in the buffer, they are just marks in between iterable locations),
+multiple marks can exist in the same place.
+
+The returned list is not in any meaningful order.
</description>
@@ -73578,17 +77366,19 @@ meaningful order.
</parameter_description>
</parameter>
</parameters>
-<return> list of #GtkTextMark
+<return>
+list of `GtkTextMark`
</return>
</function>
<function name="gtk_text_iter_get_offset">
<description>
Returns the character offset of an iterator.
-Each character in a #GtkTextBuffer has an offset,
+
+Each character in a `GtkTextBuffer` has an offset,
starting with 0 for the first character in the buffer.
-Use gtk_text_buffer_get_iter_at_offset() to convert an
-offset back into an iterator.
+Use [method@Gtk,TextBuffer.get_iter_at_offset] to convert
+an offset back into an iterator.
</description>
@@ -73604,8 +77394,9 @@ offset back into an iterator.
<function name="gtk_text_iter_get_paintable">
<description>
-If the element at @iter is a paintable, the paintable is returned
-(with no new reference count added). Otherwise, %NULL is returned.
+If the element at @iter is a paintable, the paintable is returned.
+
+Otherwise, %NULL is returned.
</description>
@@ -73621,10 +77412,12 @@ If the element at @iter is a paintable, the paintable is returned
<function name="gtk_text_iter_get_slice">
<description>
-Returns the text in the given range. A “slice” is an array of
-characters encoded in UTF-8 format, including the Unicode “unknown”
-character 0xFFFC for iterable non-character elements in the buffer,
-such as images. Because images are encoded in the slice, byte and
+Returns the text in the given range.
+
+A “slice” is an array of characters encoded in UTF-8 format,
+including the Unicode “unknown” character 0xFFFC for iterable
+non-character elements in the buffer, such as images.
+Because images are encoded in the slice, byte and
character offsets in the returned array will correspond to byte
offsets in the text buffer. Note that 0xFFFC can occur in normal
text as well, so it is not a reliable indicator that a paintable or
@@ -73649,9 +77442,12 @@ widget is in the buffer.
<function name="gtk_text_iter_get_tags">
<description>
Returns a list of tags that apply to @iter, in ascending order of
-priority (highest-priority tags are last). The #GtkTextTag in the
-list don’t have a reference added, but you have to free the list
-itself.
+priority.
+
+The highest-priority tags are last.
+
+The `GtkTextTag`s in the list don’t have a reference added,
+but you have to free the list itself.
</description>
@@ -73661,17 +77457,20 @@ itself.
</parameter_description>
</parameter>
</parameters>
-<return> list of #GtkTextTag
+<return> list of
+`GtkTextTag`
</return>
</function>
<function name="gtk_text_iter_get_text">
<description>
-Returns text in the given range. If the range
+Returns text in the given range.
+
+If the range
contains non-text elements such as images, the character and byte
offsets in the returned string will not correspond to character and
byte offsets in the buffer. If you want offsets to correspond, see
-gtk_text_iter_get_slice().
+[method@Gtk.TextIter.get_slice].
</description>
@@ -73691,9 +77490,11 @@ gtk_text_iter_get_slice().
<function name="gtk_text_iter_get_toggled_tags">
<description>
-Returns a list of #GtkTextTag that are toggled on or off at this
-point. (If @toggled_on is %TRUE, the list contains tags that are
-toggled on.) If a tag is toggled on at @iter, then some non-empty
+Returns a list of `GtkTextTag` that are toggled on or off at this
+point.
+
+If @toggled_on is %TRUE, the list contains tags that are
+toggled on. If a tag is toggled on at @iter, then some non-empty
range of characters following @iter has that tag applied to it. If
a tag is toggled off, then some non-empty range following @iter
does not have the tag applied to it.
@@ -73710,7 +77511,8 @@ does not have the tag applied to it.
</parameter_description>
</parameter>
</parameters>
-<return> tags toggled at this point
+<return> tags
+toggled at this point
</return>
</function>
@@ -73725,7 +77527,7 @@ toggled on.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -73744,19 +77546,22 @@ toggled on.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
-<return> offset in visible characters from the start of the line
+<return> offset in visible characters from the start of the line
</return>
</function>
<function name="gtk_text_iter_get_visible_slice">
<description>
-Like gtk_text_iter_get_slice(), but invisible text is not included.
-Invisible text is usually invisible because a #GtkTextTag with the
-“invisible” attribute turned on has been applied to it.
+Returns visible text in the given range.
+
+Like [method@Gtk.TextIter.get_slice], but invisible text
+is not included. Invisible text is usually invisible because
+a `GtkTextTag` with the “invisible” attribute turned on has
+been applied to it.
</description>
@@ -73776,9 +77581,12 @@ Invisible text is usually invisible because a #GtkTextTag with the
<function name="gtk_text_iter_get_visible_text">
<description>
-Like gtk_text_iter_get_text(), but invisible text is not included.
-Invisible text is usually invisible because a #GtkTextTag with the
-“invisible” attribute turned on has been applied to it.
+Returns visible text in the given range.
+
+Like [method@Gtk.TextIter.get_text], but invisible text
+is not included. Invisible text is usually invisible because
+a `GtkTextTag` with the “invisible” attribute turned on has
+been applied to it.
</description>
@@ -73799,8 +77607,11 @@ range
<function name="gtk_text_iter_has_tag">
<description>
-Returns %TRUE if @iter points to a character that is part of a range tagged
-with @tag. See also gtk_text_iter_starts_tag() and gtk_text_iter_ends_tag().
+Returns %TRUE if @iter points to a character that is part
+of a range tagged with @tag.
+
+See also [method@Gtk.TextIter.starts_tag] and
+[method@Gtk.TextIter.ends_tag].
</description>
@@ -73810,7 +77621,7 @@ with @tag. See also gtk_text_iter_starts_tag() and gtk_text_iter_ends_tag().
</parameter_description>
</parameter>
<parameter name="tag">
-<parameter_description> a #GtkTextTag
+<parameter_description> a `GtkTextTag`
</parameter_description>
</parameter>
</parameters>
@@ -73821,13 +77632,14 @@ with @tag. See also gtk_text_iter_starts_tag() and gtk_text_iter_ends_tag().
<function name="gtk_text_iter_in_range">
<description>
Checks whether @iter falls in the range [@start, @end).
+
@start and @end must be in ascending order.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="start">
@@ -73847,15 +77659,16 @@ Checks whether @iter falls in the range [@start, @end).
<description>
Determines whether @iter is inside a sentence (as opposed to in
between two sentences, e.g. after a period and before the first
-letter of the next sentence). Sentence boundaries are determined
-by Pango and should be correct for nearly any language (if not, the
-correct fix would be to the Pango text boundary algorithms).
+letter of the next sentence).
+
+Sentence boundaries are determined by Pango and should be correct
+for nearly any language.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -73866,18 +77679,20 @@ correct fix would be to the Pango text boundary algorithms).
<function name="gtk_text_iter_inside_word">
<description>
Determines whether the character pointed by @iter is part of a
-natural-language word (as opposed to say inside some whitespace). Word
-breaks are determined by Pango and should be correct for nearly any language
-(if not, the correct fix would be to the Pango word break algorithms).
+natural-language word (as opposed to say inside some whitespace).
+
+Word breaks are determined by Pango and should be correct
+for nearly any language.
-Note that if gtk_text_iter_starts_word() returns %TRUE, then this function
-returns %TRUE too, since @iter points to the first character of the word.
+Note that if [method@Gtk.TextIter.starts_word] returns %TRUE,
+then this function returns %TRUE too, since @iter points to
+the first character of the word.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -73887,14 +77702,17 @@ returns %TRUE too, since @iter points to the first character of the word.
<function name="gtk_text_iter_is_cursor_position">
<description>
-See gtk_text_iter_forward_cursor_position() or #PangoLogAttr or
-pango_break() for details on what a cursor position is.
+Determine if @iter is at a cursor position.
+
+See [method@Gtk.TextIter.forward_cursor_position] or
+[struct@Pango.LogAttr] or [func@Pango.break] for details
+on what a cursor position is.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -73904,10 +77722,11 @@ pango_break() for details on what a cursor position is.
<function name="gtk_text_iter_is_end">
<description>
-Returns %TRUE if @iter is the end iterator, i.e. one past the last
-dereferenceable iterator in the buffer. gtk_text_iter_is_end() is
-the most efficient way to check whether an iterator is the end
-iterator.
+Returns %TRUE if @iter is the end iterator.
+
+This means it is one past the last dereferenceable iterator
+in the buffer. gtk_text_iter_is_end() is the most efficient
+way to check whether an iterator is the end iterator.
</description>
@@ -73923,8 +77742,7 @@ iterator.
<function name="gtk_text_iter_is_start">
<description>
-Returns %TRUE if @iter is the first iterator in the buffer, that is
-if @iter has a character offset of 0.
+Returns %TRUE if @iter is the first iterator in the buffer.
</description>
@@ -73941,21 +77759,23 @@ if @iter has a character offset of 0.
<function name="gtk_text_iter_order">
<description>
Swaps the value of @first and @second if @second comes before
-@first in the buffer. That is, ensures that @first and @second are
-in sequence. Most text buffer functions that take a range call this
-automatically on your behalf, so there’s no real reason to call it yourself
-in those cases. There are some exceptions, such as gtk_text_iter_in_range(),
-that expect a pre-sorted range.
+@first in the buffer.
+That is, ensures that @first and @second are in sequence.
+Most text buffer functions that take a range call this
+automatically on your behalf, so there’s no real reason to
+call it yourself in those cases. There are some exceptions,
+such as [method@Gtk.TextIter.in_range], that expect a
+pre-sorted range.
</description>
<parameters>
<parameter name="first">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="second">
-<parameter_description> another #GtkTextIter
+<parameter_description> another `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -73964,15 +77784,15 @@ that expect a pre-sorted range.
<function name="gtk_text_iter_set_line">
<description>
-Moves iterator @iter to the start of the line @line_number. If
-@line_number is negative or larger than the number of lines in the
-buffer, moves @iter to the start of the last line in the buffer.
+Moves iterator @iter to the start of the line @line_number.
+If @line_number is negative or larger than the number of lines
+in the buffer, moves @iter to the start of the last line in the buffer.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="line_number">
@@ -73990,11 +77810,10 @@ byte index. The given byte index must be at
the start of a character, it can’t be in the middle of a UTF-8
encoded character.
-
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="byte_on_line">
@@ -74007,18 +77826,17 @@ encoded character.
<function name="gtk_text_iter_set_line_offset">
<description>
-Moves @iter within a line, to a new character
-(not byte) offset. The given character offset must be less than or
-equal to the number of characters in the line; if equal, @iter
-moves to the start of the next line. See
-gtk_text_iter_set_line_index() if you have a byte index rather than
-a character offset.
+Moves @iter within a line, to a new character (not byte) offset.
+The given character offset must be less than or equal to the number
+of characters in the line; if equal, @iter moves to the start of the
+next line. See [method@Gtk.TextIter.set_line_index] if you have a byte
+index rather than a character offset.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="char_on_line">
@@ -74031,13 +77849,15 @@ a character offset.
<function name="gtk_text_iter_set_offset">
<description>
-Sets @iter to point to @char_offset. @char_offset counts from the start
+Sets @iter to point to @char_offset.
+
+@char_offset counts from the start
of the entire text buffer, starting with 0.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="char_offset">
@@ -74057,7 +77877,7 @@ in the index.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="byte_on_line">
@@ -74077,7 +77897,7 @@ counted in the offset.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="char_on_line">
@@ -74090,11 +77910,13 @@ counted in the offset.
<function name="gtk_text_iter_starts_line">
<description>
-Returns %TRUE if @iter begins a paragraph,
-i.e. if gtk_text_iter_get_line_offset() would return 0.
-However this function is potentially more efficient than
-gtk_text_iter_get_line_offset() because it doesn’t have to compute
-the offset, it just has to see whether it’s 0.
+Returns %TRUE if @iter begins a paragraph.
+
+This is the case if [method@Gtk.TextIter.get_line_offset]
+would return 0. However this function is potentially more
+efficient than [method@Gtk.TextIter.get_line_offset], because
+it doesn’t have to compute the offset, it just has to see
+whether it’s 0.
</description>
@@ -74110,16 +77932,16 @@ the offset, it just has to see whether it’s 0.
<function name="gtk_text_iter_starts_sentence">
<description>
-Determines whether @iter begins a sentence. Sentence boundaries are
-determined by Pango and should be correct for nearly any language
-(if not, the correct fix would be to the Pango text boundary
-algorithms).
+Determines whether @iter begins a sentence.
+
+Sentence boundaries are determined by Pango and
+should be correct for nearly any language.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -74129,15 +77951,16 @@ algorithms).
<function name="gtk_text_iter_starts_tag">
<description>
-Returns %TRUE if @tag is toggled on at exactly this point. If @tag
-is %NULL, returns %TRUE if any tag is toggled on at this point.
+Returns %TRUE if @tag is toggled on at exactly this point.
-Note that if gtk_text_iter_starts_tag() returns %TRUE, it means that @iter is
-at the beginning of the tagged range, and that the
+If @tag is %NULL, returns %TRUE if any tag is toggled on at this point.
+
+Note that if this function returns %TRUE, it means that
+@iter is at the beginning of the tagged range, and that the
character at @iter is inside the tagged range. In other
-words, unlike gtk_text_iter_ends_tag(), if gtk_text_iter_starts_tag() returns
-%TRUE, gtk_text_iter_has_tag() will also return %TRUE for the same
-parameters.
+words, unlike [method@Gtk.TextIter.ends_tag], if
+this function returns %TRUE, [method@Gtk.TextIter.has_tag
+will also return %TRUE for the same parameters.
</description>
@@ -74147,7 +77970,7 @@ parameters.
</parameter_description>
</parameter>
<parameter name="tag">
-<parameter_description> a #GtkTextTag, or %NULL
+<parameter_description> a `GtkTextTag`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -74157,16 +77980,16 @@ parameters.
<function name="gtk_text_iter_starts_word">
<description>
-Determines whether @iter begins a natural-language word. Word
-breaks are determined by Pango and should be correct for nearly any
-language (if not, the correct fix would be to the Pango word break
-algorithms).
+Determines whether @iter begins a natural-language word.
+
+Word breaks are determined by Pango and should be correct
+for nearly any language.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -74176,9 +77999,11 @@ algorithms).
<function name="gtk_text_iter_toggles_tag">
<description>
+Gets whether a range with @tag applied to it begins
+or ends at @iter.
+
This is equivalent to (gtk_text_iter_starts_tag() ||
-gtk_text_iter_ends_tag()), i.e. it tells you whether a range with
-@tag applied to it begins or ends at @iter.
+gtk_text_iter_ends_tag())
</description>
@@ -74188,7 +78013,7 @@ gtk_text_iter_ends_tag()), i.e. it tells you whether a range with
</parameter_description>
</parameter>
<parameter name="tag">
-<parameter_description> a #GtkTextTag, or %NULL
+<parameter_description> a `GtkTextTag`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -74653,32 +78478,32 @@ after validation.)
<function name="gtk_text_mark_get_buffer">
<description>
-Gets the buffer this mark is located inside,
-or %NULL if the mark is deleted.
+Gets the buffer this mark is located inside.
</description>
<parameters>
<parameter name="mark">
-<parameter_description> a #GtkTextMark
+<parameter_description> a `GtkTextMark`
</parameter_description>
</parameter>
</parameters>
-<return> the mark’s #GtkTextBuffer
+<return> the mark’s `GtkTextBuffer`
</return>
</function>
<function name="gtk_text_mark_get_deleted">
<description>
-Returns %TRUE if the mark has been removed from its buffer
-with gtk_text_buffer_delete_mark(). See gtk_text_buffer_add_mark()
-for a way to add it to a buffer again.
+Returns %TRUE if the mark has been removed from its buffer.
+
+See [method@Gtk.TextBuffer.add_mark] for a way to add it
+to a buffer again.
</description>
<parameters>
<parameter name="mark">
-<parameter_description> a #GtkTextMark
+<parameter_description> a `GtkTextMark`
</parameter_description>
</parameter>
</parameters>
@@ -74694,7 +78519,7 @@ Determines whether the mark has left gravity.
</description>
<parameters>
<parameter name="mark">
-<parameter_description> a #GtkTextMark
+<parameter_description> a `GtkTextMark`
</parameter_description>
</parameter>
</parameters>
@@ -74704,13 +78529,13 @@ Determines whether the mark has left gravity.
<function name="gtk_text_mark_get_name">
<description>
-Returns the mark name; returns NULL for anonymous marks.
+Returns the mark name.
</description>
<parameters>
<parameter name="mark">
-<parameter_description> a #GtkTextMark
+<parameter_description> a `GtkTextMark`
</parameter_description>
</parameter>
</parameters>
@@ -74720,14 +78545,15 @@ Returns the mark name; returns NULL for anonymous marks.
<function name="gtk_text_mark_get_visible">
<description>
-Returns %TRUE if the mark is visible (i.e. a cursor is displayed
-for it).
+Returns %TRUE if the mark is visible.
+
+A cursor is displayed for visible marks.
</description>
<parameters>
<parameter name="mark">
-<parameter_description> a #GtkTextMark
+<parameter_description> a `GtkTextMark`
</parameter_description>
</parameter>
</parameters>
@@ -74737,15 +78563,17 @@ for it).
<function name="gtk_text_mark_new">
<description>
-Creates a text mark. Add it to a buffer using gtk_text_buffer_add_mark().
-If @name is %NULL, the mark is anonymous; otherwise, the mark can be
-retrieved by name using gtk_text_buffer_get_mark(). If a mark has left
-gravity, and text is inserted at the mark’s current location, the mark
-will be moved to the left of the newly-inserted text. If the mark has
-right gravity (@left_gravity = %FALSE), the mark will end up on the
-right of newly-inserted text. The standard left-to-right cursor is a
-mark with right gravity (when you type, the cursor stays on the right
-side of the text you’re typing).
+Creates a text mark.
+
+Add it to a buffer using [method@Gtk.TextBuffer.add_mark].
+If @name is %NULL, the mark is anonymous; otherwise, the mark can be
+retrieved by name using [method@Gtk.TextBuffer.get_mark]. If a mark
+has left gravity, and text is inserted at the mark’s current location,
+the mark will be moved to the left of the newly-inserted text. If the
+mark has right gravity (@left_gravity = %FALSE), the mark will end up
+on the right of newly-inserted text. The standard left-to-right cursor
+is a mark with right gravity (when you type, the cursor stays on the
+right side of the text you’re typing).
</description>
@@ -74759,7 +78587,7 @@ side of the text you’re typing).
</parameter_description>
</parameter>
</parameters>
-<return> new #GtkTextMark
+<return> new `GtkTextMark`
</return>
</function>
@@ -74788,43 +78616,45 @@ Marks are not visible by default.
<function name="gtk_text_new">
<description>
-Creates a new self.
+Creates a new `GtkText`.
</description>
<parameters>
</parameters>
-<return> a new #GtkText.
+<return> a new `GtkText`.
</return>
</function>
<function name="gtk_text_new_with_buffer">
<description>
-Creates a new self with the specified text buffer.
+Creates a new `GtkText` with the specified text buffer.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> The buffer to use for the new #GtkText.
+<parameter_description> The buffer to use for the new `GtkText`.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkText
+<return> a new `GtkText`
</return>
</function>
<function name="gtk_text_set_activates_default">
<description>
-If @activates is %TRUE, pressing Enter in the @self will activate the default
-widget for the window containing the self. This usually means that
-the dialog box containing the self will be closed, since the default
-widget is usually one of the dialog buttons.
+If @activates is %TRUE, pressing Enter in the @self will
+activate the default widget for the window containing @self.
+
+This usually means that the dialog containing the `GtkText`
+will be closed, since the default widget is usually one of
+the dialog buttons.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
<parameter name="activates">
@@ -74837,17 +78667,16 @@ widget is usually one of the dialog buttons.
<function name="gtk_text_set_attributes">
<description>
-Sets a #PangoAttrList; the attributes in the list are applied to the
-text.
+Sets attributes that are applied to the text.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
<parameter name="attrs">
-<parameter_description> a #PangoAttrList or %NULL to unset
+<parameter_description> a `PangoAttrList` or %NULL to unset
</parameter_description>
</parameter>
</parameters>
@@ -74856,17 +78685,17 @@ text.
<function name="gtk_text_set_buffer">
<description>
-Set the #GtkEntryBuffer object which holds the text for
+Set the `GtkEntryBuffer` object which holds the text for
this widget.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter_description> a `GtkEntryBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -74875,14 +78704,16 @@ this widget.
<function name="gtk_text_set_enable_emoji_completion">
<description>
-Sets whether Emoji completion is enabled. If it is,
-typing ':', followed by a recognized keyword, will pop
-up a window with suggested Emojis matching the keyword.
+Sets whether Emoji completion is enabled.
+
+If it is, typing ':', followed by a recognized keyword,
+will pop up a window with suggested Emojis matching the
+keyword.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
<parameter name="enable_emoji_completion">
@@ -74901,11 +78732,11 @@ the context menu for @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
<parameter name="model">
-<parameter_description> a #GMenuModel
+<parameter_description> a `GMenuModel`
</parameter_description>
</parameter>
</parameters>
@@ -74914,13 +78745,13 @@ the context menu for @self.
<function name="gtk_text_set_input_hints">
<description>
-Sets the #GtkText:input-hints property, which
-allows input methods to fine-tune their behaviour.
+Sets input hints that allow input methods
+to fine-tune their behaviour.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
<parameter name="hints">
@@ -74933,14 +78764,15 @@ allows input methods to fine-tune their behaviour.
<function name="gtk_text_set_input_purpose">
<description>
-Sets the #GtkText:input-purpose property which
-can be used by on-screen keyboards and other input
-methods to adjust their behaviour.
+Sets the input purpose of the `GtkText`.
+
+This can be used by on-screen keyboards and other
+input methods to adjust their behaviour.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
<parameter name="purpose">
@@ -74954,9 +78786,7 @@ methods to adjust their behaviour.
<function name="gtk_text_set_invisible_char">
<description>
Sets the character to use in place of the actual text when
-gtk_text_set_visibility() has been called to set text visibility
-to %FALSE. i.e. this is the character used in “password mode” to
-show the user how many characters have been typed.
+in “password mode”.
By default, GTK picks the best invisible char available in the
current font. If you set the invisible char to 0, then the user
@@ -74966,7 +78796,7 @@ as they type.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
<parameter name="ch">
@@ -74984,20 +78814,19 @@ Sets the maximum allowed length of the contents of the widget.
If the current contents are longer than the given length, then
they will be truncated to fit.
-This is equivalent to getting @self's #GtkEntryBuffer and
-calling gtk_entry_buffer_set_max_length() on it.
-]|
+This is equivalent to getting @self's `GtkEntryBuffer` and
+calling [method@Gtk.EntryBuffer.set_max_length] on it.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
<parameter name="length">
-<parameter_description> the maximum length of the self, or 0 for no maximum.
-(other than the maximum length of entries.) The value passed in will
-be clamped to the range 0-65536.
+<parameter_description> the maximum length of the `GtkText`, or 0 for no maximum.
+(other than the maximum length of entries.) The value passed
+in will be clamped to the range 0-65536.
</parameter_description>
</parameter>
</parameters>
@@ -75006,12 +78835,13 @@ be clamped to the range 0-65536.
<function name="gtk_text_set_overwrite_mode">
<description>
-Sets whether the text is overwritten when typing in the #GtkText.
+Sets whether the text is overwritten when typing
+in the `GtkText`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
<parameter name="overwrite">
@@ -75027,16 +78857,17 @@ Sets whether the text is overwritten when typing in the #GtkText.
Sets text to be displayed in @self when it is empty.
This can be used to give a visual hint of the expected
-contents of the self.
+contents of the `GtkText`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
<parameter name="text">
-<parameter_description> a string to be displayed when @self is empty and unfocused, or %NULL
+<parameter_description> a string to be displayed when @self
+is empty and unfocused, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -75045,12 +78876,12 @@ contents of the self.
<function name="gtk_text_set_propagate_text_width">
<description>
-Sets whether the GtkText should grow and shrink with the content.
+Sets whether the `GtkText` should grow and shrink with the content.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
<parameter name="propagate_text_width">
@@ -75063,17 +78894,16 @@ Sets whether the GtkText should grow and shrink with the content.
<function name="gtk_text_set_tabs">
<description>
-Sets a #PangoTabArray; the tabstops in the array are applied to the self
-text.
+Sets tabstops that are applied to the text.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
<parameter name="tabs">
-<parameter_description> a #PangoTabArray
+<parameter_description> a `PangoTabArray`
</parameter_description>
</parameter>
</parameters>
@@ -75082,13 +78912,13 @@ text.
<function name="gtk_text_set_truncate_multiline">
<description>
-Sets whether the GtkText should truncate multi-line text
+Sets whether the `GtkText` should truncate multi-line text
that is pasted into the widget.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
<parameter name="truncate_multiline">
@@ -75101,16 +78931,17 @@ that is pasted into the widget.
<function name="gtk_text_set_visibility">
<description>
-Sets whether the contents of the self are visible or not.
+Sets whether the contents of the `GtkText` are visible or not.
+
When visibility is set to %FALSE, characters are displayed
as the invisible char, and will also appear that way when
-the text in the self widget is copied to the clipboard.
+the text in the widget is copied to the clipboard.
By default, GTK picks the best invisible character available
in the current font, but it can be changed with
-gtk_text_set_invisible_char().
+[method Gtk Text.set_invisible_char].
-Note that you probably want to set #GtkText:input-purpose
+Note that you probably want to set [property Gtk Text:input-purpose]
to %GTK_INPUT_PURPOSE_PASSWORD or %GTK_INPUT_PURPOSE_PIN to
inform input methods about the purpose of this self,
in addition to setting visibility to %FALSE.
@@ -75118,11 +78949,11 @@ in addition to setting visibility to %FALSE.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
<parameter name="visible">
-<parameter_description> %TRUE if the contents of the self are displayed
+<parameter_description> %TRUE if the contents of the `GtkText` are displayed
as plaintext
</parameter_description>
</parameter>
@@ -75132,20 +78963,20 @@ as plaintext
<function name="gtk_text_tag_changed">
<description>
-Emits the #GtkTextTagTable::tag-changed signal on the #GtkTextTagTable where
-the tag is included.
+Emits the [signal@Gtk.TextTagTable::tag-changed] signal on the
+`GtkTextTagTable` where the tag is included.
-The signal is already emitted when setting a #GtkTextTag property. This
-function is useful for a #GtkTextTag subclass.
+The signal is already emitted when setting a `GtkTextTag` property.
+This function is useful for a `GtkTextTag` subclass.
</description>
<parameters>
<parameter name="tag">
-<parameter_description> a #GtkTextTag.
+<parameter_description> a `GtkTextTag`
</parameter_description>
</parameter>
<parameter name="size_changed">
-<parameter_description> whether the change affects the #GtkTextView layout.
+<parameter_description> whether the change affects the `GtkTextView` layout
</parameter_description>
</parameter>
</parameters>
@@ -75160,7 +78991,7 @@ Get the tag priority.
</description>
<parameters>
<parameter name="tag">
-<parameter_description> a #GtkTextTag
+<parameter_description> a `GtkTextTag`
</parameter_description>
</parameter>
</parameters>
@@ -75170,8 +79001,7 @@ Get the tag priority.
<function name="gtk_text_tag_new">
<description>
-Creates a #GtkTextTag. Configure the tag using object arguments,
-i.e. using g_object_set().
+Creates a `GtkTextTag`.
</description>
@@ -75181,28 +79011,31 @@ i.e. using g_object_set().
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkTextTag
+<return> a new `GtkTextTag`
</return>
</function>
<function name="gtk_text_tag_set_priority">
<description>
-Sets the priority of a #GtkTextTag. Valid priorities
-start at 0 and go to one less than gtk_text_tag_table_get_size().
-Each tag in a table has a unique priority; setting the priority
-of one tag shifts the priorities of all the other tags in the
-table to maintain a unique priority for each tag. Higher priority
-tags “win” if two tags both set the same text attribute. When adding
-a tag to a tag table, it will be assigned the highest priority in
-the table by default; so normally the precedence of a set of tags
-is the order in which they were added to the table, or created with
-gtk_text_buffer_create_tag(), which adds the tag to the buffer’s table
-automatically.
+Sets the priority of a `GtkTextTag`.
+
+Valid priorities start at 0 and go to one less than
+[method@Gtk.TextTagTable.get_size]. Each tag in a table
+has a unique priority; setting the priority of one tag shifts
+the priorities of all the other tags in the table to maintain
+a unique priority for each tag.
+
+Higher priority tags “win” if two tags both set the same text
+attribute. When adding a tag to a tag table, it will be assigned
+the highest priority in the table by default; so normally the
+precedence of a set of tags is the order in which they were added
+to the table, or created with [method@Gtk.TextBuffer.create_tag],
+which adds the tag to the buffer’s table automatically.
</description>
<parameters>
<parameter name="tag">
-<parameter_description> a #GtkTextTag
+<parameter_description> a `GtkTextTag`
</parameter_description>
</parameter>
<parameter name="priority">
@@ -75215,8 +79048,9 @@ automatically.
<function name="gtk_text_tag_table_add">
<description>
-Add a tag to the table. The tag is assigned the highest priority
-in the table.
+Add a tag to the table.
+
+The tag is assigned the highest priority in the table.
@tag must not be in a tag table already, and may not have
the same name as an already-added tag.
@@ -75225,11 +79059,11 @@ the same name as an already-added tag.
</description>
<parameters>
<parameter name="table">
-<parameter_description> a #GtkTextTagTable
+<parameter_description> a `GtkTextTagTable`
</parameter_description>
</parameter>
<parameter name="tag">
-<parameter_description> a #GtkTextTag
+<parameter_description> a `GtkTextTag`
</parameter_description>
</parameter>
</parameters>
@@ -75240,13 +79074,14 @@ the same name as an already-added tag.
<function name="gtk_text_tag_table_foreach">
<description>
Calls @func on each tag in @table, with user data @data.
-Note that the table may not be modified while iterating
+
+Note that the table may not be modified while iterating
over it (you can’t add/remove tags).
</description>
<parameters>
<parameter name="table">
-<parameter_description> a #GtkTextTagTable
+<parameter_description> a `GtkTextTagTable`
</parameter_description>
</parameter>
<parameter name="func">
@@ -75269,7 +79104,7 @@ Returns the size of the table (number of tags)
</description>
<parameters>
<parameter name="table">
-<parameter_description> a #GtkTextTagTable
+<parameter_description> a `GtkTextTagTable`
</parameter_description>
</parameter>
</parameters>
@@ -75285,7 +79120,7 @@ Look up a named tag.
</description>
<parameters>
<parameter name="table">
-<parameter_description> a #GtkTextTagTable
+<parameter_description> a `GtkTextTagTable`
</parameter_description>
</parameter>
<parameter name="name">
@@ -75293,39 +79128,42 @@ Look up a named tag.
</parameter_description>
</parameter>
</parameters>
-<return> The tag, or %NULL if none by that
-name is in the table.
+<return> The tag,
+or %NULL if none by that name is in the table.
</return>
</function>
<function name="gtk_text_tag_table_new">
<description>
-Creates a new #GtkTextTagTable. The table contains no tags by
-default.
+Creates a new `GtkTextTagTable`.
+
+The table contains no tags by default.
</description>
<parameters>
</parameters>
-<return> a new #GtkTextTagTable
+<return> a new `GtkTextTagTable`
</return>
</function>
<function name="gtk_text_tag_table_remove">
<description>
-Remove a tag from the table. If a #GtkTextBuffer has @table as its tag table,
-the tag is removed from the buffer. The table’s reference to the tag is
-removed, so the tag will end up destroyed if you don’t have a reference to
-it.
+Remove a tag from the table.
+
+If a `GtkTextBuffer` has @table as its tag table, the tag is
+removed from the buffer. The table’s reference to the tag is
+removed, so the tag will end up destroyed if you don’t have
+a reference to it.
</description>
<parameters>
<parameter name="table">
-<parameter_description> a #GtkTextTagTable
+<parameter_description> a `GtkTextTagTable`
</parameter_description>
</parameter>
<parameter name="tag">
-<parameter_description> a #GtkTextTag
+<parameter_description> a `GtkTextTag`
</parameter_description>
</parameter>
</parameters>
@@ -75334,14 +79172,15 @@ it.
<function name="gtk_text_unset_invisible_char">
<description>
-Unsets the invisible char previously set with
-gtk_text_set_invisible_char(). So that the
-default invisible char is used again.
+Unsets the invisible char.
+
+After calling this, the default invisible
+char is used again.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkText
+<parameter_description> a `GtkText`
</parameter_description>
</parameter>
</parameters>
@@ -75379,15 +79218,15 @@ Adds a child widget in the text buffer, at the given @anchor.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="anchor">
-<parameter_description> a #GtkTextChildAnchor in the #GtkTextBuffer for @text_view
+<parameter_description> a `GtkTextChildAnchor` in the `GtkTextBuffer` for @text_view
</parameter_description>
</parameter>
</parameters>
@@ -75396,19 +79235,21 @@ Adds a child widget in the text buffer, at the given @anchor.
<function name="gtk_text_view_add_overlay">
<description>
-Adds @child at a fixed coordinate in the #GtkTextView's text window. The
-@xpos and @ypos must be in buffer coordinates (see
-gtk_text_view_get_iter_location() to convert to buffer coordinates).
+Adds @child at a fixed coordinate in the `GtkTextView`'s text window.
+
+The @xpos and @ypos must be in buffer coordinates (see
+[method@Gtk.TextView.get_iter_location] to convert to
+buffer coordinates).
@child will scroll with the text view.
-If instead you want a widget that will not move with the #GtkTextView
-contents see #GtkOverlay.
+If instead you want a widget that will not move with the
+`GtkTextView` contents see #GtkOverlay.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="child">
@@ -75430,23 +79271,24 @@ contents see #GtkOverlay.
<function name="gtk_text_view_backward_display_line">
<description>
Moves the given @iter backward by one display (wrapped) line.
+
A display line is different from a paragraph. Paragraphs are
separated by newlines or other paragraph separator characters.
Display lines are created by line-wrapping a paragraph. If
wrapping is turned off, display lines and paragraphs will be the
same. Display lines are divided differently for each view, since
they depend on the view’s width; paragraphs are the same in all
-views, since they depend on the contents of the #GtkTextBuffer.
+views, since they depend on the contents of the `GtkTextBuffer`.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -75457,23 +79299,24 @@ views, since they depend on the contents of the #GtkTextBuffer.
<function name="gtk_text_view_backward_display_line_start">
<description>
Moves the given @iter backward to the next display line start.
+
A display line is different from a paragraph. Paragraphs are
separated by newlines or other paragraph separator characters.
Display lines are created by line-wrapping a paragraph. If
wrapping is turned off, display lines and paragraphs will be the
same. Display lines are divided differently for each view, since
they depend on the view’s width; paragraphs are the same in all
-views, since they depend on the contents of the #GtkTextBuffer.
+views, since they depend on the contents of the `GtkTextBuffer`.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -75483,13 +79326,12 @@ views, since they depend on the contents of the #GtkTextBuffer.
<function name="gtk_text_view_buffer_to_window_coords">
<description>
-Converts coordinate (@buffer_x, @buffer_y) to coordinates for the window
-@win, and stores the result in (@window_x, @window_y).
+Converts buffer coordinates to window coordinates.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="win">
@@ -75519,23 +79361,24 @@ Converts coordinate (@buffer_x, @buffer_y) to coordinates for the window
<function name="gtk_text_view_forward_display_line">
<description>
Moves the given @iter forward by one display (wrapped) line.
+
A display line is different from a paragraph. Paragraphs are
separated by newlines or other paragraph separator characters.
Display lines are created by line-wrapping a paragraph. If
wrapping is turned off, display lines and paragraphs will be the
same. Display lines are divided differently for each view, since
they depend on the view’s width; paragraphs are the same in all
-views, since they depend on the contents of the #GtkTextBuffer.
+views, since they depend on the contents of the `GtkTextBuffer`.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -75546,23 +79389,24 @@ views, since they depend on the contents of the #GtkTextBuffer.
<function name="gtk_text_view_forward_display_line_end">
<description>
Moves the given @iter forward to the next display line end.
+
A display line is different from a paragraph. Paragraphs are
separated by newlines or other paragraph separator characters.
Display lines are created by line-wrapping a paragraph. If
wrapping is turned off, display lines and paragraphs will be the
same. Display lines are divided differently for each view, since
they depend on the view’s width; paragraphs are the same in all
-views, since they depend on the contents of the #GtkTextBuffer.
+views, since they depend on the contents of the `GtkTextBuffer`.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -75573,17 +79417,18 @@ views, since they depend on the contents of the #GtkTextBuffer.
<function name="gtk_text_view_get_accepts_tab">
<description>
Returns whether pressing the Tab key inserts a tab characters.
-gtk_text_view_set_accepts_tab().
+
+See [method@Gtk.TextView.set_accepts_tab].
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> A #GtkTextView
+<parameter_description> A `GtkTextView`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if pressing the Tab key inserts a tab character,
+<return> %TRUE if pressing the Tab key inserts a tab character,
%FALSE if pressing the Tab key moves the keyboard focus.
</return>
</function>
@@ -75596,7 +79441,7 @@ Gets the bottom margin for text in the @text_view.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -75606,7 +79451,8 @@ Gets the bottom margin for text in the @text_view.
<function name="gtk_text_view_get_buffer">
<description>
-Returns the #GtkTextBuffer being displayed by this text view.
+Returns the `GtkTextBuffer` being displayed by this text view.
+
The reference count on the buffer is not incremented; the caller
of this function won’t own a new reference.
@@ -75614,24 +79460,25 @@ of this function won’t own a new reference.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkTextBuffer
+<return> a `GtkTextBuffer`
</return>
</function>
<function name="gtk_text_view_get_cursor_locations">
<description>
-Given an @iter within a text layout, determine the positions of the
-strong and weak cursors if the insertion point is at that
-iterator. The position of each cursor is stored as a zero-width
-rectangle. The strong cursor location is the location where
-characters of the directionality equal to the base direction of the
-paragraph are inserted. The weak cursor location is the location
-where characters of the directionality opposite to the base
-direction of the paragraph are inserted.
+Determine the positions of the strong and weak cursors if the
+insertion point is at @iter.
+
+The position of each cursor is stored as a zero-width rectangle.
+The strong cursor location is the location where characters of
+the directionality equal to the base direction of the paragraph
+are inserted. The weak cursor location is the location where
+characters of the directionality opposite to the base direction
+of the paragraph are inserted.
If @iter is %NULL, the actual cursor position is used.
@@ -75641,17 +79488,17 @@ returned locations will be adjusted to account for the preedit
cursor’s offset within the preedit sequence.
The rectangle position is in buffer coordinates; use
-gtk_text_view_buffer_to_window_coords() to convert these
+[method@Gtk.TextView.buffer_to_window_coords] to convert these
coordinates to coordinates for one of the windows in the text view.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="strong">
@@ -75676,7 +79523,7 @@ Find out whether the cursor should be displayed.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -75686,14 +79533,15 @@ Find out whether the cursor should be displayed.
<function name="gtk_text_view_get_editable">
<description>
-Returns the default editability of the #GtkTextView. Tags in the
-buffer may override this setting for some ranges of text.
+Returns the default editability of the `GtkTextView`.
+
+Tags in the buffer may override this setting for some ranges of text.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -75703,14 +79551,14 @@ buffer may override this setting for some ranges of text.
<function name="gtk_text_view_get_extra_menu">
<description>
-Gets the menu model set with gtk_text_view_set_extra_menu()
+Gets the menu model that gets added to the context menu
or %NULL if none has been set.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -75720,8 +79568,9 @@ or %NULL if none has been set.
<function name="gtk_text_view_get_gutter">
<description>
-Gets a #GtkWidget that has previously been set with
-gtk_text_view_set_gutter().
+Gets a `GtkWidget` that has previously been set as gutter.
+
+See [method@Gtk.TextView.set_gutter].
@win must be one of %GTK_TEXT_WINDOW_LEFT, %GTK_TEXT_WINDOW_RIGHT,
%GTK_TEXT_WINDOW_TOP, or %GTK_TEXT_WINDOW_BOTTOM.
@@ -75730,21 +79579,22 @@ gtk_text_view_set_gutter().
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="win">
-<parameter_description> a #GtkTextWindowType
+<parameter_description> a `GtkTextWindowType`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkWidget or %NULL
+<return> a `GtkWidget` or %NULL
</return>
</function>
<function name="gtk_text_view_get_indent">
<description>
Gets the default indentation of paragraphs in @text_view.
+
Tags in the view’s buffer may override the default.
The indentation may be negative.
@@ -75752,7 +79602,7 @@ The indentation may be negative.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -75762,12 +79612,12 @@ The indentation may be negative.
<function name="gtk_text_view_get_input_hints">
<description>
-Gets the value of the #GtkTextView:input-hints property.
+Gets the `input-hints` of the `GtkTextView`.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -75776,12 +79626,12 @@ Gets the value of the #GtkTextView:input-hints property.
<function name="gtk_text_view_get_input_purpose">
<description>
-Gets the value of the #GtkTextView:input-purpose property.
+Gets the `input-purpose` of the `GtkTextView`.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -75790,21 +79640,22 @@ Gets the value of the #GtkTextView:input-purpose property.
<function name="gtk_text_view_get_iter_at_location">
<description>
-Retrieves the iterator at buffer coordinates @x and @y. Buffer
-coordinates are coordinates for the entire buffer, not just the
-currently-displayed portion. If you have coordinates from an
+Retrieves the iterator at buffer coordinates @x and @y.
+
+Buffer coordinates are coordinates for the entire buffer, not just
+the currently-displayed portion. If you have coordinates from an
event, you have to convert those to buffer coordinates with
-gtk_text_view_window_to_buffer_coords().
+[method@Gtk.TextView.window_to_buffer_coords].
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="x">
@@ -75823,31 +79674,31 @@ gtk_text_view_window_to_buffer_coords().
<function name="gtk_text_view_get_iter_at_position">
<description>
Retrieves the iterator pointing to the character at buffer
-coordinates @x and @y. Buffer coordinates are coordinates for
-the entire buffer, not just the currently-displayed portion.
-If you have coordinates from an event, you have to convert
-those to buffer coordinates with
-gtk_text_view_window_to_buffer_coords().
+coordinates @x and @y.
-Note that this is different from gtk_text_view_get_iter_at_location(),
-which returns cursor locations, i.e. positions between
-characters.
+Buffer coordinates are coordinates for the entire buffer, not just
+the currently-displayed portion. If you have coordinates from an event,
+you have to convert those to buffer coordinates with
+[method@Gtk.TextView.window_to_buffer_coords].
+
+Note that this is different from [method@Gtk.TextView.get_iter_at_location],
+which returns cursor locations, i.e. positions between characters.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="trailing">
-<parameter_description> if non-%NULL, location to store an integer indicating where
-in the grapheme the user clicked. It will either be
-zero, or the number of characters in the grapheme.
+<parameter_description> if non-%NULL, location to store
+an integer indicating where in the grapheme the user clicked.
+It will either be zero, or the number of characters in the grapheme.
0 represents the trailing edge of the grapheme.
</parameter_description>
</parameter>
@@ -75867,18 +79718,19 @@ zero, or the number of characters in the grapheme.
<function name="gtk_text_view_get_iter_location">
<description>
Gets a rectangle which roughly contains the character at @iter.
+
The rectangle position is in buffer coordinates; use
-gtk_text_view_buffer_to_window_coords() to convert these
+[method@Gtk.TextView.buffer_to_window_coords] to convert these
coordinates to coordinates for one of the windows in the text view.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="location">
@@ -75892,13 +79744,14 @@ coordinates to coordinates for one of the windows in the text view.
<function name="gtk_text_view_get_justification">
<description>
Gets the default justification of paragraphs in @text_view.
+
Tags in the buffer may override the default.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -75909,13 +79762,14 @@ Tags in the buffer may override the default.
<function name="gtk_text_view_get_left_margin">
<description>
Gets the default left margin size of paragraphs in the @text_view.
+
Tags in the buffer may override the default.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -75925,20 +79779,22 @@ Tags in the buffer may override the default.
<function name="gtk_text_view_get_line_at_y">
<description>
-Gets the #GtkTextIter at the start of the line containing
-the coordinate @y. @y is in buffer coordinates, convert from
-window coordinates with gtk_text_view_window_to_buffer_coords().
-If non-%NULL, @line_top will be filled with the coordinate of the top
-edge of the line.
+Gets the `GtkTextIter` at the start of the line containing
+the coordinate @y.
+
+@y is in buffer coordinates, convert from window coordinates with
+[method@Gtk.TextView.window_to_buffer_coords]. If non-%NULL,
+@line_top will be filled with the coordinate of the top edge
+of the line.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="target_iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="y">
@@ -75956,17 +79812,19 @@ edge of the line.
<function name="gtk_text_view_get_line_yrange">
<description>
Gets the y coordinate of the top of the line containing @iter,
-and the height of the line. The coordinate is a buffer coordinate;
-convert to window coordinates with gtk_text_view_buffer_to_window_coords().
+and the height of the line.
+
+The coordinate is a buffer coordinate; convert to window
+coordinates with [method@Gtk.TextView.buffer_to_window_coords].
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="y">
@@ -75983,14 +79841,14 @@ convert to window coordinates with gtk_text_view_buffer_to_window_coords().
<function name="gtk_text_view_get_monospace">
<description>
-Gets the value of the #GtkTextView:monospace property.
+Gets whether the `GtkTextView` uses monospace styling.
Return: %TRUE if monospace fonts are desired
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -75999,13 +79857,13 @@ Return: %TRUE if monospace fonts are desired
<function name="gtk_text_view_get_overwrite">
<description>
-Returns whether the #GtkTextView is in overwrite mode or not.
+Returns whether the `GtkTextView` is in overwrite mode or not.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -76016,14 +79874,15 @@ Returns whether the #GtkTextView is in overwrite mode or not.
<function name="gtk_text_view_get_pixels_above_lines">
<description>
Gets the default number of pixels to put above paragraphs.
-Adding this function with gtk_text_view_get_pixels_below_lines()
+
+Adding this function with [method@Gtk.TextView.get_pixels_below_lines]
is equal to the line space between each paragraph.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -76033,16 +79892,16 @@ is equal to the line space between each paragraph.
<function name="gtk_text_view_get_pixels_below_lines">
<description>
-Gets the value set by gtk_text_view_set_pixels_below_lines().
+Gets the default number of pixels to put below paragraphs.
-The line space is the sum of the value returned by this function and the
-value returned by gtk_text_view_get_pixels_above_lines().
+The line space is the sum of the value returned by this function and
+the value returned by [method@Gtk.TextView.get_pixels_above_lines].
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -76052,13 +79911,14 @@ value returned by gtk_text_view_get_pixels_above_lines().
<function name="gtk_text_view_get_pixels_inside_wrap">
<description>
-Gets the value set by gtk_text_view_set_pixels_inside_wrap().
+Gets the default number of pixels to put between wrapped lines
+inside a paragraph.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -76068,14 +79928,15 @@ Gets the value set by gtk_text_view_set_pixels_inside_wrap().
<function name="gtk_text_view_get_right_margin">
<description>
-Gets the default right margin for text in @text_view. Tags
-in the buffer may override the default.
+Gets the default right margin for text in @text_view.
+
+Tags in the buffer may override the default.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -76085,21 +79946,23 @@ in the buffer may override the default.
<function name="gtk_text_view_get_tabs">
<description>
-Gets the default tabs for @text_view. Tags in the buffer may
-override the defaults. The returned array will be %NULL if
-“standard” (8-space) tabs are used. Free the return value
-with pango_tab_array_free().
+Gets the default tabs for @text_view.
+
+Tags in the buffer may override the defaults. The returned array
+will be %NULL if “standard” (8-space) tabs are used. Free the
+return value with [method Pango TabArray free].
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
-<return> copy of default tab array, or %NULL if
-“standard" tabs are used; must be freed with pango_tab_array_free().
+<return> copy of default tab array,
+or %NULL if standard tabs are used; must be freed with
+[method Pango TabArray free].
</return>
</function>
@@ -76111,7 +79974,7 @@ Gets the top margin for text in the @text_view.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -76122,13 +79985,15 @@ Gets the top margin for text in the @text_view.
<function name="gtk_text_view_get_visible_rect">
<description>
Fills @visible_rect with the currently-visible
-region of the buffer, in buffer coordinates. Convert to window coordinates
-with gtk_text_view_buffer_to_window_coords().
+region of the buffer, in buffer coordinates.
+
+Convert to window coordinates with
+[method@Gtk.TextView.buffer_to_window_coords].
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="visible_rect">
@@ -76147,7 +80012,7 @@ Gets the line wrapping for the view.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -76157,17 +80022,18 @@ Gets the line wrapping for the view.
<function name="gtk_text_view_im_context_filter_keypress">
<description>
-Allow the #GtkTextView input method to internally handle key press
-and release events. If this function returns %TRUE, then no further
-processing should be done for this key event. See
-gtk_im_context_filter_keypress().
+Allow the `GtkTextView` input method to internally handle key press
+and release events.
+
+If this function returns %TRUE, then no further processing should be
+done for this key event. See [method@Gtk.IMContext.filter_keypress].
Note that you are expected to call this function from your handler
when overriding key event handling. This is needed in the case when
you need to insert your own key handling between the input method
-and the default key event handling of the #GtkTextView.
+and the default key event handling of the `GtkTextView`.
-|[<!-- language="C" -->
+```c
static gboolean
gtk_foo_bar_key_press_event (GtkWidget *widget,
GdkEvent *event)
@@ -76186,13 +80052,13 @@ return TRUE;
return GTK_WIDGET_CLASS (gtk_foo_bar_parent_class)->key_press_event (widget, event);
}
-]|
+```
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="event">
@@ -76213,11 +80079,11 @@ located within the currently-visible text area.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="mark">
-<parameter_description> a #GtkTextMark
+<parameter_description> a `GtkTextMark`
</parameter_description>
</parameter>
</parameters>
@@ -76227,16 +80093,18 @@ located within the currently-visible text area.
<function name="gtk_text_view_move_overlay">
<description>
-Updates the position of a child, as for gtk_text_view_add_overlay().
+Updates the position of a child.
+
+See [method@Gtk.TextView.add_overlay].
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> a widget already added with gtk_text_view_add_overlay()
+<parameter_description> a widget already added with [method@Gtk.TextView.add_overlay]
</parameter_description>
</parameter>
<parameter name="xpos">
@@ -76254,11 +80122,12 @@ Updates the position of a child, as for gtk_text_view_add_overlay().
<function name="gtk_text_view_move_visually">
<description>
Move the iterator a given number of characters visually, treating
-it as the strong cursor position. If @count is positive, then the
-new strong cursor position will be @count positions to the right of
-the old cursor position. If @count is negative then the new strong
-cursor position will be @count positions to the left of the old
-cursor position.
+it as the strong cursor position.
+
+If @count is positive, then the new strong cursor position will
+be @count positions to the right of the old cursor position.
+If @count is negative then the new strong cursor position will
+be @count positions to the left of the old cursor position.
In the presence of bi-directional text, the correspondence
between logical and visual order will depend on the direction
@@ -76269,15 +80138,15 @@ is moved off of the end of a run.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="count">
-<parameter_description> number of characters to move (negative moves left,
+<parameter_description> number of characters to move (negative moves left,
positive moves right)
</parameter_description>
</parameter>
@@ -76288,50 +80157,52 @@ positive moves right)
<function name="gtk_text_view_new">
<description>
-Creates a new #GtkTextView. If you don’t call gtk_text_view_set_buffer()
-before using the text view, an empty default buffer will be created
-for you. Get the buffer with gtk_text_view_get_buffer(). If you want
-to specify your own buffer, consider gtk_text_view_new_with_buffer().
+Creates a new `GtkTextView`.
+
+If you don’t call [method@Gtk.TextView.set_buffer] before using the
+text view, an empty default buffer will be created for you. Get the
+buffer with [method@Gtk.TextView.get_buffer]. If you want to specify
+your own buffer, consider [ctor@Gtk.TextView.new_with_buffer].
</description>
<parameters>
</parameters>
-<return> a new #GtkTextView
+<return> a new `GtkTextView`
</return>
</function>
<function name="gtk_text_view_new_with_buffer">
<description>
-Creates a new #GtkTextView widget displaying the buffer
-@buffer. One buffer can be shared among many widgets.
-@buffer may be %NULL to create a default buffer, in which case
-this function is equivalent to gtk_text_view_new(). The
-text view adds its own reference count to the buffer; it does not
-take over an existing reference.
+Creates a new `GtkTextView` widget displaying the buffer @buffer.
+
+One buffer can be shared among many widgets. @buffer may be %NULL
+to create a default buffer, in which case this function is equivalent
+to [ctor Gtk TextView new]. The text view adds its own reference count
+to the buffer; it does not take over an existing reference.
</description>
<parameters>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkTextView.
+<return> a new `GtkTextView`.
</return>
</function>
<function name="gtk_text_view_place_cursor_onscreen">
<description>
Moves the cursor to the currently visible region of the
-buffer, if it isn’t there already.
+buffer.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -76346,7 +80217,7 @@ Removes a child widget from @text_view.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="child">
@@ -76359,8 +80230,9 @@ Removes a child widget from @text_view.
<function name="gtk_text_view_reset_cursor_blink">
<description>
-Ensures that the cursor is shown (i.e. not in an 'off' blink
-interval) and resets the time that it will stay blinking (or
+Ensures that the cursor is shown.
+
+This also resets the time that it will stay blinking (or
visible, in case blinking is disabled).
This function should be called in response to user input
@@ -76370,7 +80242,7 @@ event handlers).
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -76387,7 +80259,7 @@ would confuse on-going input method behavior.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
</parameters>
@@ -76402,7 +80274,7 @@ within the visible area of the widget.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="mark">
@@ -76416,29 +80288,30 @@ within the visible area of the widget.
<function name="gtk_text_view_scroll_to_iter">
<description>
Scrolls @text_view so that @iter is on the screen in the position
-indicated by @xalign and @yalign. An alignment of 0.0 indicates
-left or top, 1.0 indicates right or bottom, 0.5 means center.
-If @use_align is %FALSE, the text scrolls the minimal distance to
-get the mark onscreen, possibly not scrolling at all. The effective
-screen for purposes of this function is reduced by a margin of size
-@within_margin.
+indicated by @xalign and @yalign.
+
+An alignment of 0.0 indicates left or top, 1.0 indicates right or
+bottom, 0.5 means center. If @use_align is %FALSE, the text scrolls
+the minimal distance to get the mark onscreen, possibly not scrolling
+at all. The effective screen for purposes of this function is reduced
+by a margin of size @within_margin.
Note that this function uses the currently-computed height of the
lines in the text buffer. Line heights are computed in an idle
handler; so this function may not have the desired effect if it’s
called before the height computations. To avoid oddness, consider
-using gtk_text_view_scroll_to_mark() which saves a point to be
+using [method@Gtk.TextView.scroll_to_mark] which saves a point to be
scrolled to after line validation.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
<parameter name="within_margin">
@@ -76466,21 +80339,22 @@ just get the mark onscreen)
<function name="gtk_text_view_scroll_to_mark">
<description>
Scrolls @text_view so that @mark is on the screen in the position
-indicated by @xalign and @yalign. An alignment of 0.0 indicates
-left or top, 1.0 indicates right or bottom, 0.5 means center.
-If @use_align is %FALSE, the text scrolls the minimal distance to
-get the mark onscreen, possibly not scrolling at all. The effective
-screen for purposes of this function is reduced by a margin of size
-@within_margin.
+indicated by @xalign and @yalign.
+
+An alignment of 0.0 indicates left or top, 1.0 indicates right or
+bottom, 0.5 means center. If @use_align is %FALSE, the text scrolls
+the minimal distance to get the mark onscreen, possibly not scrolling
+at all. The effective screen for purposes of this function is reduced
+by a margin of size @within_margin.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="mark">
-<parameter_description> a #GtkTextMark
+<parameter_description> a `GtkTextMark`
</parameter_description>
</parameter>
<parameter name="within_margin">
@@ -76488,7 +80362,7 @@ screen for purposes of this function is reduced by a margin of size
</parameter_description>
</parameter>
<parameter name="use_align">
-<parameter_description> whether to use alignment arguments (if %FALSE, just
+<parameter_description> whether to use alignment arguments (if %FALSE, just
get the mark onscreen)
</parameter_description>
</parameter>
@@ -76506,20 +80380,21 @@ get the mark onscreen)
<function name="gtk_text_view_set_accepts_tab">
<description>
-Sets the behavior of the text widget when the Tab key is pressed.
-If @accepts_tab is %TRUE, a tab character is inserted. If @accepts_tab
-is %FALSE the keyboard focus is moved to the next widget in the focus
+Sets the behavior of the text widget when the Tab key is pressed.
+
+If @accepts_tab is %TRUE, a tab character is inserted. If @accepts_tab
+is %FALSE the keyboard focus is moved to the next widget in the focus
chain.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> A #GtkTextView
+<parameter_description> A `GtkTextView`
</parameter_description>
</parameter>
<parameter name="accepts_tab">
-<parameter_description> %TRUE if pressing the Tab key should insert a tab
-character, %FALSE, if pressing the Tab key should move the
+<parameter_description> %TRUE if pressing the Tab key should insert a tab
+character, %FALSE, if pressing the Tab key should move the
keyboard focus.
</parameter_description>
</parameter>
@@ -76537,7 +80412,7 @@ In CSS terms, the value set here is padding.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="bottom_margin">
@@ -76550,20 +80425,21 @@ In CSS terms, the value set here is padding.
<function name="gtk_text_view_set_buffer">
<description>
-Sets @buffer as the buffer being displayed by @text_view. The previous
-buffer displayed by the text view is unreferenced, and a reference is
-added to @buffer. If you owned a reference to @buffer before passing it
-to this function, you must remove that reference yourself; #GtkTextView
-will not “adopt” it.
+Sets @buffer as the buffer being displayed by @text_view.
+
+The previous buffer displayed by the text view is unreferenced, and
+a reference is added to @buffer. If you owned a reference to @buffer
+before passing it to this function, you must remove that reference
+yourself; `GtkTextView` will not “adopt” it.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter_description> a `GtkTextBuffer`
</parameter_description>
</parameter>
</parameters>
@@ -76572,17 +80448,18 @@ will not “adopt” it.
<function name="gtk_text_view_set_cursor_visible">
<description>
-Toggles whether the insertion point should be displayed. A buffer with
-no editable text probably shouldn’t have a visible cursor, so you may
-want to turn the cursor off.
+Toggles whether the insertion point should be displayed.
+
+A buffer with no editable text probably shouldn’t have a visible
+cursor, so you may want to turn the cursor off.
Note that this property may be overridden by the
-#GtkSettings:gtk-keynav-use-caret settings.
+[property@GtkSettings:gtk-keynav-use-caret] setting.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -76595,14 +80472,15 @@ Note that this property may be overridden by the
<function name="gtk_text_view_set_editable">
<description>
-Sets the default editability of the #GtkTextView. You can override
-this default setting with tags in the buffer, using the “editable”
-attribute of tags.
+Sets the default editability of the `GtkTextView`.
+
+You can override this default setting with tags in the buffer,
+using the “editable” attribute of tags.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -76615,18 +80493,19 @@ attribute of tags.
<function name="gtk_text_view_set_extra_menu">
<description>
-Sets a menu model to add when constructing
-the context menu for @text_view. You can pass
-%NULL to remove a previously set extra menu.
+Sets a menu model to add when constructing the context
+menu for @text_view.
+
+You can pass %NULL to remove a previously set extra menu.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="model">
-<parameter_description> a #GMenuModel
+<parameter_description> a `GMenuModel`
</parameter_description>
</parameter>
</parameters>
@@ -76643,15 +80522,15 @@ Places @widget into the gutter specified by @win.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="win">
-<parameter_description> a #GtkTextWindowType
+<parameter_description> a `GtkTextWindowType`
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> a #GtkWidget or %NULL
+<parameter_description> a `GtkWidget` or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -76661,12 +80540,13 @@ Places @widget into the gutter specified by @win.
<function name="gtk_text_view_set_indent">
<description>
Sets the default indentation for paragraphs in @text_view.
+
Tags in the buffer may override the default.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="indent">
@@ -76679,13 +80559,15 @@ Tags in the buffer may override the default.
<function name="gtk_text_view_set_input_hints">
<description>
-Sets the #GtkTextView:input-hints property, which
-allows input methods to fine-tune their behaviour.
+Sets the `input-hints` of the `GtkTextView`.
+
+The `input-hints` allow input methods to fine-tune
+their behaviour.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="hints">
@@ -76698,14 +80580,15 @@ allows input methods to fine-tune their behaviour.
<function name="gtk_text_view_set_input_purpose">
<description>
-Sets the #GtkTextView:input-purpose property which
-can be used by on-screen keyboards and other input
-methods to adjust their behaviour.
+Sets the `input-purpose` of the `GtkTextView`.
+
+The `input-purpose` can be used by on-screen keyboards
+and other input methods to adjust their behaviour.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="purpose">
@@ -76719,13 +80602,13 @@ methods to adjust their behaviour.
<function name="gtk_text_view_set_justification">
<description>
Sets the default justification of text in @text_view.
-Tags in the view’s buffer may override the default.
+Tags in the view’s buffer may override the default.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="justification">
@@ -76739,6 +80622,7 @@ Tags in the view’s buffer may override the default.
<function name="gtk_text_view_set_left_margin">
<description>
Sets the default left margin for text in @text_view.
+
Tags in the buffer may override the default.
Note that this function is confusingly named.
@@ -76747,7 +80631,7 @@ In CSS terms, the value set here is padding.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="left_margin">
@@ -76760,14 +80644,13 @@ In CSS terms, the value set here is padding.
<function name="gtk_text_view_set_monospace">
<description>
-Sets the #GtkTextView:monospace property, which
-indicates that the text view should use monospace
-fonts.
+Sets whether the `GtkTextView` should display text in
+monospace styling.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="monospace">
@@ -76780,12 +80663,12 @@ fonts.
<function name="gtk_text_view_set_overwrite">
<description>
-Changes the #GtkTextView overwrite mode.
+Changes the `GtkTextView` overwrite mode.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="overwrite">
@@ -76799,12 +80682,13 @@ Changes the #GtkTextView overwrite mode.
<function name="gtk_text_view_set_pixels_above_lines">
<description>
Sets the default number of blank pixels above paragraphs in @text_view.
+
Tags in the buffer for @text_view may override the defaults.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="pixels_above_lines">
@@ -76818,17 +80702,18 @@ Tags in the buffer for @text_view may override the defaults.
<function name="gtk_text_view_set_pixels_below_lines">
<description>
Sets the default number of pixels of blank space
-to put below paragraphs in @text_view. May be overridden
-by tags applied to @text_view’s buffer.
+to put below paragraphs in @text_view.
+
+May be overridden by tags applied to @text_view’s buffer.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="pixels_below_lines">
-<parameter_description> pixels below paragraphs
+<parameter_description> pixels below paragraphs
</parameter_description>
</parameter>
</parameters>
@@ -76838,13 +80723,14 @@ by tags applied to @text_view’s buffer.
<function name="gtk_text_view_set_pixels_inside_wrap">
<description>
Sets the default number of pixels of blank space to leave between
-display/wrapped lines within a paragraph. May be overridden by
-tags in @text_view’s buffer.
+display/wrapped lines within a paragraph.
+
+May be overridden by tags in @text_view’s buffer.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="pixels_inside_wrap">
@@ -76858,6 +80744,7 @@ tags in @text_view’s buffer.
<function name="gtk_text_view_set_right_margin">
<description>
Sets the default right margin for text in the text view.
+
Tags in the buffer may override the default.
Note that this function is confusingly named.
@@ -76866,7 +80753,7 @@ In CSS terms, the value set here is padding.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="right_margin">
@@ -76880,12 +80767,13 @@ In CSS terms, the value set here is padding.
<function name="gtk_text_view_set_tabs">
<description>
Sets the default tab stops for paragraphs in @text_view.
+
Tags in the buffer may override the default.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="tabs">
@@ -76906,7 +80794,7 @@ In CSS terms, the value set here is padding.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="top_margin">
@@ -76924,11 +80812,11 @@ Sets the line wrapping for the view.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="wrap_mode">
-<parameter_description> a #GtkWrapMode
+<parameter_description> a `GtkWrapMode`
</parameter_description>
</parameter>
</parameters>
@@ -76938,18 +80826,19 @@ Sets the line wrapping for the view.
<function name="gtk_text_view_starts_display_line">
<description>
Determines whether @iter is at the start of a display line.
-See gtk_text_view_forward_display_line() for an explanation of
-display lines vs. paragraphs.
+
+See [method@Gtk.TextView.forward_display_line] for an
+explanation of display lines vs. paragraphs.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a `GtkTextIter`
</parameter_description>
</parameter>
</parameters>
@@ -76960,12 +80849,12 @@ display lines vs. paragraphs.
<function name="gtk_text_view_window_to_buffer_coords">
<description>
Converts coordinates on the window identified by @win to buffer
-coordinates, storing the result in (@buffer_x,@buffer_y).
+coordinates.
</description>
<parameters>
<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter_description> a `GtkTextView`
</parameter_description>
</parameter>
<parameter name="win">
@@ -76994,24 +80883,25 @@ coordinates, storing the result in (@buffer_x,@buffer_y).
<function name="gtk_toggle_button_get_active">
<description>
-Queries a #GtkToggleButton and returns its current state. Returns %TRUE if
-the toggle button is pressed in and %FALSE if it is raised.
+Queries a `GtkToggleButton` and returns its current state.
</description>
<parameters>
<parameter name="toggle_button">
-<parameter_description> a #GtkToggleButton.
+<parameter_description> a `GtkToggleButton`.
</parameter_description>
</parameter>
</parameters>
-<return> a #gboolean value.
+<return> whether the button is pressed
</return>
</function>
<function name="gtk_toggle_button_new">
<description>
-Creates a new toggle button. A widget should be packed into the button, as in gtk_button_new().
+Creates a new toggle button.
+
+A widget should be packed into the button, as in [ctor Gtk Button new].
</description>
@@ -77039,9 +80929,10 @@ Creates a new toggle button with a text label.
<function name="gtk_toggle_button_new_with_mnemonic">
<description>
-Creates a new #GtkToggleButton containing a label. The label
-will be created using gtk_label_new_with_mnemonic(), so underscores
-in @label indicate the mnemonic for the button.
+Creates a new `GtkToggleButton` containing a label.
+
+The label will be created using [ctor@Gtk.Label.new_with_mnemonic],
+so underscores in @label indicate the mnemonic for the button.
</description>
@@ -77052,22 +80943,24 @@ mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkToggleButton
+<return> a new `GtkToggleButton`
</return>
</function>
<function name="gtk_toggle_button_set_active">
<description>
-Sets the status of the toggle button. Set to %TRUE if you want the
-GtkToggleButton to be “pressed in”, and %FALSE to raise it.
+Sets the status of the toggle button.
+
+Set to %TRUE if you want the `GtkToggleButton` to be “pressed in”,
+and %FALSE to raise it.
If the status of the button changes, this action causes the
-#GtkToggleButton::toggled signal to be emitted.
+[signal@GtkToggleButton::toggled] signal to be emitted.
</description>
<parameters>
<parameter name="toggle_button">
-<parameter_description> a #GtkToggleButton.
+<parameter_description> a `GtkToggleButton`.
</parameter_description>
</parameter>
<parameter name="is_active">
@@ -77080,23 +80973,26 @@ If the status of the button changes, this action causes the
<function name="gtk_toggle_button_set_group">
<description>
-Adds @self to the group of @group. In a group of multiple toggle buttons,
-only one button can be active at a time.
+Adds @self to the group of @group.
+
+In a group of multiple toggle buttons, only one button can be active
+at a time.
-Note that the same effect can be achieved via the #GtkActionable
-api, by using the same action with parameter type and state type 's'
+Setting up groups in a cycle leads to undefined behavior.
+
+Note that the same effect can be achieved via the [interface@Gtk.Actionable]
+API, by using the same action with parameter type and state type 's'
for all buttons in the group, and giving each button its own target
value.
-
</description>
<parameters>
<parameter name="toggle_button">
-<parameter_description> a #GtkToggleButton
+<parameter_description> a `GtkToggleButton`
</parameter_description>
</parameter>
<parameter name="group">
-<parameter_description> another #GtkToggleButton to
+<parameter_description> another `GtkToggleButton` to
form a group with
</parameter_description>
</parameter>
@@ -77106,14 +81002,14 @@ form a group with
<function name="gtk_toggle_button_toggled">
<description>
-Emits the #GtkToggleButton::toggled signal on the
-#GtkToggleButton. There is no good reason for an
-application ever to call this function.
+Emits the ::toggled signal on the `GtkToggleButton`.
+
+There is no good reason for an application ever to call this function.
</description>
<parameters>
<parameter name="toggle_button">
-<parameter_description> a #GtkToggleButton.
+<parameter_description> a `GtkToggleButton`.
</parameter_description>
</parameter>
</parameters>
@@ -77204,18 +81100,19 @@ by @size. If @icon_name is %NULL, the image will be hidden.
<function name="gtk_tooltip_set_markup">
<description>
-Sets the text of the tooltip to be @markup, which is marked up
-with the [Pango text markup language][PangoMarkupFormat].
+Sets the text of the tooltip to be @markup.
+
+The string must be marked up with Pango markup.
If @markup is %NULL, the label will be hidden.
</description>
<parameters>
<parameter name="tooltip">
-<parameter_description> a #GtkTooltip
+<parameter_description> a `GtkTooltip`
</parameter_description>
</parameter>
<parameter name="markup">
-<parameter_description> a markup string (see [Pango markup format][PangoMarkupFormat]) or %NULL
+<parameter_description> a string with Pango markup or %NLL
</parameter_description>
</parameter>
</parameters>
@@ -77224,13 +81121,15 @@ If @markup is %NULL, the label will be hidden.
<function name="gtk_tooltip_set_text">
<description>
-Sets the text of the tooltip to be @text. If @text is %NULL, the label
-will be hidden. See also gtk_tooltip_set_markup().
+Sets the text of the tooltip to be @text.
+
+If @text is %NULL, the label will be hidden.
+See also [method@Gtk.Tooltip.set_markup].
</description>
<parameters>
<parameter name="tooltip">
-<parameter_description> a #GtkTooltip
+<parameter_description> a `GtkTooltip`
</parameter_description>
</parameter>
<parameter name="text">
@@ -77420,7 +81319,7 @@ Gets the child widget displayed by @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeExpander
+<parameter_description> a `GtkTreeExpander`
</parameter_description>
</parameter>
</parameters>
@@ -77430,19 +81329,19 @@ Gets the child widget displayed by @self.
<function name="gtk_tree_expander_get_item">
<description>
-Forwards the item set on the #GtkTreeListRow that @self is managing.
+Forwards the item set on the `GtkTreeListRow` that @self is managing.
This call is essentially equivalent to calling:
-|[<!-- language="C" -->
+```c
gtk_tree_list_row_get_item (gtk_tree_expander_get_list_row (@self));
-]|
+```
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeExpander
+<parameter_description> a `GtkTreeExpander`
</parameter_description>
</parameter>
</parameters>
@@ -77458,7 +81357,7 @@ Gets the list row managed by @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeExpander
+<parameter_description> a `GtkTreeExpander`
</parameter_description>
</parameter>
</parameters>
@@ -77468,13 +81367,13 @@ Gets the list row managed by @self.
<function name="gtk_tree_expander_new">
<description>
-Creates a new #GtkTreeExpander
+Creates a new `GtkTreeExpander`
</description>
<parameters>
</parameters>
-<return> a new #GtkTreeExpander
+<return> a new `GtkTreeExpander`
</return>
</function>
@@ -77485,11 +81384,11 @@ Sets the content widget to display.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeExpander widget
+<parameter_description> a `GtkTreeExpander`
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> a #GtkWidget, or %NULL
+<parameter_description> a `GtkWidget`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -77503,11 +81402,11 @@ Sets the tree list row that this expander should manage.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeExpander widget
+<parameter_description> a `GtkTreeExpander` widget
</parameter_description>
</parameter>
<parameter name="list_row">
-<parameter_description> a #GtkTreeListRow, or %NULL
+<parameter_description> a `GtkTreeListRow`, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -77582,14 +81481,16 @@ This function is mainly used for language bindings.
<function name="gtk_tree_list_model_get_autoexpand">
<description>
Gets whether the model is set to automatically expand new rows
-that get added. This can be either rows added by changes to the
-underlying models or via gtk_tree_list_row_set_expanded().
+that get added.
+
+This can be either rows added by changes to the underlying
+models or via [method@Gtk.TreeListRow.set_expanded].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListModel
+<parameter_description> a `GtkTreeListModel`
</parameter_description>
</parameter>
</parameters>
@@ -77605,13 +81506,13 @@ Gets the row item corresponding to the child at index @position for
If @position is greater than the number of children in the root model,
%NULL is returned.
-Do not confuse this function with gtk_tree_list_model_get_row().
+Do not confuse this function with [method@Gtk.TreeListModel.get_row].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListModel
+<parameter_description> a `GtkTreeListModel`
</parameter_description>
</parameter>
<parameter name="position">
@@ -77631,7 +81532,7 @@ Gets the root model that @self was created with.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListModel
+<parameter_description> a `GtkTreeListModel`
</parameter_description>
</parameter>
</parameters>
@@ -77641,20 +81542,22 @@ Gets the root model that @self was created with.
<function name="gtk_tree_list_model_get_passthrough">
<description>
-If this function returns %FALSE, the #GListModel functions for @self
-return custom #GtkTreeListRow objects. You need to call
-gtk_tree_list_row_get_item() on these objects to get the original
+Gets whether the model is passing through original row items.
+
+If this function returns %FALSE, the `GListModel` functions for @self
+return custom `GtkTreeListRow` objects. You need to call
+[method@Gtk.TreeListRow.get_item] on these objects to get the original
item.
If %TRUE, the values of the child models are passed through in their
-original state. You then need to call gtk_tree_list_model_get_row()
-to get the custom #GtkTreeListRows.
+original state. You then need to call [method@Gtk.TreeListModel.get_row]
+to get the custom `GtkTreeListRow`s.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListModel
+<parameter_description> a `GtkTreeListModel`
</parameter_description>
</parameter>
</parameters>
@@ -77664,26 +81567,29 @@ to get the custom #GtkTreeListRows.
<function name="gtk_tree_list_model_get_row">
<description>
-Gets the row object for the given row. If @position is greater than
-the number of items in @self, %NULL is returned.
+Gets the row object for the given row.
-The row object can be used to expand and collapse rows as well as
-to inspect its position in the tree. See its documentation for details.
+If @position is greater than the number of items in @self,
+%NULL is returned.
-This row object is persistent and will refer to the current item as
-long as the row is present in @self, independent of other rows being
-added or removed.
+The row object can be used to expand and collapse rows as
+well as to inspect its position in the tree. See its
+documentation for details.
-If @self is set to not be passthrough, this function is equivalent
-to calling g_list_model_get_item().
+This row object is persistent and will refer to the current
+item as long as the row is present in @self, independent of
+other rows being added or removed.
-Do not confuse this function with gtk_tree_list_model_get_child_row().
+If @self is set to not be passthrough, this function is
+equivalent to calling g_list_model_get_item().
+
+Do not confuse this function with [method@Gtk.TreeListModel.get_child_row].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListModel
+<parameter_description> a `GtkTreeListModel`
</parameter_description>
</parameter>
<parameter name="position">
@@ -77691,19 +81597,20 @@ Do not confuse this function with gtk_tree_list_model_get_child_row().
</parameter_description>
</parameter>
</parameters>
-<return> The row item
+<return> The row item
</return>
</function>
<function name="gtk_tree_list_model_new">
<description>
-Creates a new empty #GtkTreeListModel displaying @root with all rows collapsed.
+Creates a new empty `GtkTreeListModel` displaying @root
+with all rows collapsed.
</description>
<parameters>
<parameter name="root">
-<parameter_description> The #GListModel to use as root
+<parameter_description> The `GListModel` to use as root
</parameter_description>
</parameter>
<parameter name="passthrough">
@@ -77715,7 +81622,7 @@ Creates a new empty #GtkTreeListModel displaying @root with all rows collapsed.
</parameter_description>
</parameter>
<parameter name="create_func">
-<parameter_description> Function to call to create the #GListModel for the children
+<parameter_description> Function to call to create the `GListModel` for the children
of an item
</parameter_description>
</parameter>
@@ -77728,20 +81635,22 @@ of an item
</parameter_description>
</parameter>
</parameters>
-<return> a newly created #GtkTreeListModel.
+<return> a newly created `GtkTreeListModel`.
</return>
</function>
<function name="gtk_tree_list_model_set_autoexpand">
<description>
+Sets whether the model should autoexpand.
+
If set to %TRUE, the model will recursively expand all rows that
get added to the model. This can be either rows added by changes
-to the underlying models or via gtk_tree_list_row_set_expanded().
+to the underlying models or via [method@Gtk.TreeListRow.set_expanded].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListModel
+<parameter_description> a `GtkTreeListModel`
</parameter_description>
</parameter>
<parameter name="autoexpand">
@@ -77754,14 +81663,14 @@ to the underlying models or via gtk_tree_list_row_set_expanded().
<function name="gtk_tree_list_row_get_child_row">
<description>
-If @self is not expanded or @position is greater than the number of
-children, %NULL is returned.
+If @self is not expanded or @position is greater than the
+number of children, %NULL is returned.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListRow
+<parameter_description> a `GtkTreeListRow`
</parameter_description>
</parameter>
<parameter name="position">
@@ -77777,15 +81686,16 @@ children, %NULL is returned.
<description>
If the row is expanded, gets the model holding the children of @self.
-This model is the model created by the #GtkTreeListModelCreateModelFunc
+This model is the model created by the
+[callback@Gtk.TreeListModelCreateModelFunc]
and contains the original items, no matter what value
-#GtkTreeListModel:passthrough is set to.
+[property@Gtk.TreeListModel:passthrough] is set to.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListRow
+<parameter_description> a `GtkTreeListRow`
</parameter_description>
</parameter>
</parameters>
@@ -77795,10 +81705,11 @@ and contains the original items, no matter what value
<function name="gtk_tree_list_row_get_depth">
<description>
-Gets the depth of this row. Rows that correspond to items in
-the root model have a depth of zero, rows corresponding to items
-of models of direct children of the root model have a depth of
-1 and so on.
+Gets the depth of this row.
+
+Rows that correspond to items in the root model have a depth
+of zero, rows corresponding to items of models of direct children
+of the root model have a depth of 1 and so on.
The depth of a row never changes until the row is destroyed.
@@ -77806,7 +81717,7 @@ The depth of a row never changes until the row is destroyed.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListRow
+<parameter_description> a `GtkTreeListRow`
</parameter_description>
</parameter>
</parameters>
@@ -77822,7 +81733,7 @@ Gets if a row is currently expanded.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListRow
+<parameter_description> a `GtkTreeListRow`
</parameter_description>
</parameter>
</parameters>
@@ -77841,30 +81752,33 @@ row is destroyed.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListRow
+<parameter_description> a `GtkTreeListRow`
</parameter_description>
</parameter>
</parameters>
-<return> The item of this row
-or %NULL when the row was destroyed
+<return> The item
+of this row or %NULL when the row was destroyed
</return>
</function>
<function name="gtk_tree_list_row_get_parent">
<description>
-Gets the row representing the parent for @self. That is the row that would
-need to be collapsed to make this row disappear.
+Gets the row representing the parent for @self.
-If @self is a row corresponding to the root model, %NULL is returned.
+That is the row that would need to be collapsed
+to make this row disappear.
-The value returned by this function never changes until the
-row is destroyed.
+If @self is a row corresponding to the root model,
+%NULL is returned.
+
+The value returned by this function never changes
+until the row is destroyed.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListRow
+<parameter_description> a `GtkTreeListRow`
</parameter_description>
</parameter>
</parameters>
@@ -77874,14 +81788,14 @@ row is destroyed.
<function name="gtk_tree_list_row_get_position">
<description>
-Returns the position in the #GtkTreeListModel that @self occupies
+Returns the position in the `GtkTreeListModel` that @self occupies
at the moment.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListRow
+<parameter_description> a `GtkTreeListRow`
</parameter_description>
</parameter>
</parameters>
@@ -77891,9 +81805,10 @@ at the moment.
<function name="gtk_tree_list_row_is_expandable">
<description>
-Checks if a row can be expanded. This does not mean that the
-row is actually expanded, this can be checked with
-gtk_tree_list_row_get_expanded()
+Checks if a row can be expanded.
+
+This does not mean that the row is actually expanded,
+this can be checked with [method@Gtk.TreeListRow.get_expanded].
If a row is expandable never changes until the row is destroyed.
@@ -77901,7 +81816,7 @@ If a row is expandable never changes until the row is destroyed.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListRow
+<parameter_description> a `GtkTreeListRow`
</parameter_description>
</parameter>
</parameters>
@@ -77913,17 +81828,17 @@ If a row is expandable never changes until the row is destroyed.
<description>
Expands or collapses a row.
-If a row is expanded, the model of calling the
-#GtkTreeListModelCreateModelFunc for the row's item will
-be inserted after this row. If a row is collapsed, those
-items will be removed from the model.
+If a row is expanded, the model of calling the
+[callback@Gtk.TreeListModelCreateModelFunc] for the row's
+item will be inserted after this row. If a row is collapsed,
+those items will be removed from the model.
If the row is not expandable, this function does nothing.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListRow
+<parameter_description> a `GtkTreeListRow`
</parameter_description>
</parameter>
<parameter name="expanded">
@@ -77942,7 +81857,7 @@ Returns the sorter used by @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListRowSorter
+<parameter_description> a `GtkTreeListRowSorter`
</parameter_description>
</parameter>
</parameters>
@@ -77953,20 +81868,20 @@ Returns the sorter used by @self.
<function name="gtk_tree_list_row_sorter_new">
<description>
Create a special-purpose sorter that applies the sorting
-of @sorter to the levels of a #GtkTreeListModel.
+of @sorter to the levels of a `GtkTreeListModel`.
-Note that this sorter relies on #GtkTreeListModel:passthrough
-being %FALSE as it can only sort #GtkTreeListRows.
+Note that this sorter relies on [property@Gtk.TreeListModel:passthrough]
+being %FALSE as it can only sort [class@Gtk.TreeListRow]s.
</description>
<parameters>
<parameter name="sorter">
-<parameter_description> a #GtkSorter, or %NULL
+<parameter_description> a `GtkSorter`, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkTreeListRowSorter
+<return> a new `GtkTreeListRowSorter`
</return>
</function>
@@ -77974,13 +81889,13 @@ being %FALSE as it can only sort #GtkTreeListRows.
<description>
Sets the sorter to use for items with the same parent.
-This sorter will be passed the #GtkTreeListRow:item of the tree
-list rows passed to @self.
+This sorter will be passed the [property@Gtk.TreeListRow:item] of
+the tree list rows passed to @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkTreeListRowSorter
+<parameter_description> a `GtkTreeListRowSorter`
</parameter_description>
</parameter>
<parameter name="sorter">
@@ -84312,51 +88227,51 @@ gtk_tree_view_enable_model_drag_source(). Calling this method sets
<function name="gtk_value_dup_expression">
<description>
-Retrieves the #GtkExpression stored inside the given @value, and acquires
+Retrieves the `GtkExpression` stored inside the given `value`, and acquires
a reference to it.
</description>
<parameters>
<parameter name="value">
-<parameter_description> a #GValue initialized with type %GTK_TYPE_EXPRESSION
+<parameter_description> a `GValue` initialized with type `GTK_TYPE_EXPRESSION`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkExpression
+<return> a `GtkExpression`
</return>
</function>
<function name="gtk_value_get_expression">
<description>
-Retrieves the #GtkExpression stored inside the given @value.
+Retrieves the `GtkExpression` stored inside the given `value`.
</description>
<parameters>
<parameter name="value">
-<parameter_description> a #GValue initialized with type %GTK_TYPE_EXPRESSION
+<parameter_description> a `GValue` initialized with type `GTK_TYPE_EXPRESSION`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkExpression
+<return> a `GtkExpression`
</return>
</function>
<function name="gtk_value_set_expression">
<description>
-Stores the given #GtkExpression inside @value.
+Stores the given `GtkExpression` inside `value`.
-The #GValue will acquire a reference to the @expression.
+The `GValue` will acquire a reference to the `expression`.
</description>
<parameters>
<parameter name="value">
-<parameter_description> a #GValue initialized with type %GTK_TYPE_EXPRESSION
+<parameter_description> a `GValue` initialized with type `GTK_TYPE_EXPRESSION`
</parameter_description>
</parameter>
<parameter name="expression">
-<parameter_description> a #GtkExpression
+<parameter_description> a `GtkExpression`
</parameter_description>
</parameter>
</parameters>
@@ -84365,18 +88280,18 @@ The #GValue will acquire a reference to the @expression.
<function name="gtk_value_take_expression">
<description>
-Stores the given #GtkExpression inside @value.
+Stores the given `GtkExpression` inside `value`.
-This function transfers the ownership of the @expression to the #GValue.
+This function transfers the ownership of the `expression` to the `GValue`.
</description>
<parameters>
<parameter name="value">
-<parameter_description> a #GValue initialized with type %GTK_TYPE_EXPRESSION
+<parameter_description> a `GValue` initialized with type `GTK_TYPE_EXPRESSION`
</parameter_description>
</parameter>
<parameter name="expression">
-<parameter_description> a #GtkExpression
+<parameter_description> a `GtkExpression`
</parameter_description>
</parameter>
</parameters>
@@ -84385,13 +88300,13 @@ This function transfers the ownership of the @expression to the #GValue.
<function name="gtk_video_get_autoplay">
<description>
-Returns %TRUE if videos have been set to loop via gtk_video_set_loop().
+Returns %TRUE if videos have been set to loop.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkVideo
+<parameter_description> a `GtkVideo`
</parameter_description>
</parameter>
</parameters>
@@ -84408,7 +88323,7 @@ a file.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkVideo
+<parameter_description> a `GtkVideo`
</parameter_description>
</parameter>
</parameters>
@@ -84418,13 +88333,13 @@ a file.
<function name="gtk_video_get_loop">
<description>
-Returns %TRUE if videos have been set to loop via gtk_video_set_loop().
+Returns %TRUE if videos have been set to loop.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkVideo
+<parameter_description> a `GtkVideo`
</parameter_description>
</parameter>
</parameters>
@@ -84440,7 +88355,7 @@ Gets the media stream managed by @self or %NULL if none.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkVideo
+<parameter_description> a `GtkVideo`
</parameter_description>
</parameter>
</parameters>
@@ -84450,37 +88365,37 @@ Gets the media stream managed by @self or %NULL if none.
<function name="gtk_video_new">
<description>
-Creates a new empty #GtkVideo.
+Creates a new empty `GtkVideo`.
</description>
<parameters>
</parameters>
-<return> a new #GtkVideo
+<return> a new `GtkVideo`
</return>
</function>
<function name="gtk_video_new_for_file">
<description>
-Creates a #GtkVideo to play back the given @file.
+Creates a `GtkVideo` to play back the given @file.
</description>
<parameters>
<parameter name="file">
-<parameter_description> a #GFile
+<parameter_description> a `GFile`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkVideo
+<return> a new `GtkVideo`
</return>
</function>
<function name="gtk_video_new_for_filename">
<description>
-Creates a #GtkVideo to play back the given @filename.
+Creates a `GtkVideo` to play back the given @filename.
-This is a utility function that calls gtk_video_new_for_file(),
+This is a utility function that calls [ctor@Gtk.Video.new_for_file],
See that function for details.
@@ -84491,32 +88406,32 @@ See that function for details.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkVideo
+<return> a new `GtkVideo`
</return>
</function>
<function name="gtk_video_new_for_media_stream">
<description>
-Creates a #GtkVideo to play back the given @stream.
+Creates a `GtkVideo` to play back the given @stream.
</description>
<parameters>
<parameter name="stream">
-<parameter_description> a #GtkMediaStream
+<parameter_description> a `GtkMediaStream`
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkVideo
+<return> a new `GtkVideo`
</return>
</function>
<function name="gtk_video_new_for_resource">
<description>
-Creates a #GtkVideo to play back the resource at the
+Creates a `GtkVideo` to play back the resource at the
given @resource_path.
-This is a utility function that calls gtk_video_new_for_file(),
+This is a utility function that calls [ctor@Gtk.Video.new_for_file].
</description>
@@ -84526,19 +88441,19 @@ This is a utility function that calls gtk_video_new_for_file(),
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkVideo
+<return> a new `GtkVideo`
</return>
</function>
<function name="gtk_video_set_autoplay">
<description>
-Sets whether @self automatically starts playback when it becomes visible
-or when a new file gets loaded.
+Sets whether @self automatically starts playback when it
+becomes visible or when a new file gets loaded.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkVideo
+<parameter_description> a `GtkVideo`
</parameter_description>
</parameter>
<parameter name="autoplay">
@@ -84556,7 +88471,7 @@ Makes @self play the given @file.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkVideo
+<parameter_description> a `GtkVideo`
</parameter_description>
</parameter>
<parameter name="file">
@@ -84576,7 +88491,7 @@ This is a utility function that calls gtk_video_set_file(),
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkVideo
+<parameter_description> a `GtkVideo`
</parameter_description>
</parameter>
<parameter name="filename">
@@ -84594,7 +88509,7 @@ Sets whether new files loaded by @self should be set to loop.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkVideo
+<parameter_description> a `GtkVideo`
</parameter_description>
</parameter>
<parameter name="loop">
@@ -84607,17 +88522,19 @@ Sets whether new files loaded by @self should be set to loop.
<function name="gtk_video_set_media_stream">
<description>
-Sets the media stream to be played back. @self will take full control
-of managing the media stream. If you want to manage a media stream
-yourself, consider using a #GtkImage for display.
+Sets the media stream to be played back.
-If you want to display a file, consider using gtk_video_set_file()
+@self will take full control of managing the media stream. If you
+want to manage a media stream yourself, consider using a
+[class@Gtk.Picture] for display.
+
+If you want to display a file, consider using [method@Gtk.Video.set_file]
instead.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkVideo
+<parameter_description> a `GtkVideo`
</parameter_description>
</parameter>
<parameter name="stream">
@@ -84632,12 +88549,12 @@ instead.
<description>
Makes @self play the resource at the given @resource_path.
-This is a utility function that calls gtk_video_set_file(),
+This is a utility function that calls [method@Gtk.Video.set_file].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkVideo
+<parameter_description> a `GtkVideo`
</parameter_description>
</parameter>
<parameter name="resource_path">
@@ -84656,7 +88573,7 @@ Gets the child widget of @viewport.
</description>
<parameters>
<parameter name="viewport">
-<parameter_description> a #GtkViewport
+<parameter_description> a `GtkViewport`
</parameter_description>
</parameter>
</parameters>
@@ -84667,13 +88584,13 @@ Gets the child widget of @viewport.
<function name="gtk_viewport_get_scroll_to_focus">
<description>
Gets whether the viewport is scrolling to keep the focused
-child in view. See gtk_viewport_set_scroll_to_focus().
+child in view.
</description>
<parameters>
<parameter name="viewport">
-<parameter_description> a #GtkViewport
+<parameter_description> a `GtkViewport`
</parameter_description>
</parameter>
</parameters>
@@ -84683,7 +88600,9 @@ child in view. See gtk_viewport_set_scroll_to_focus().
<function name="gtk_viewport_new">
<description>
-Creates a new #GtkViewport with the given adjustments, or with default
+Creates a new `GtkViewport`.
+
+The new viewport uses the given adjustments, or default
adjustments if none are given.
@@ -84698,7 +88617,7 @@ adjustments if none are given.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkViewport
+<return> a new `GtkViewport`
</return>
</function>
@@ -84709,7 +88628,7 @@ Sets the child widget of @viewport.
</description>
<parameters>
<parameter name="viewport">
-<parameter_description> a #GtkViewport
+<parameter_description> a `GtkViewport`
</parameter_description>
</parameter>
<parameter name="child">
@@ -84728,7 +88647,7 @@ to keep the focused child in view.
</description>
<parameters>
<parameter name="viewport">
-<parameter_description> a #GtkViewport
+<parameter_description> a `GtkViewport`
</parameter_description>
</parameter>
<parameter name="scroll_to_focus">
@@ -84741,15 +88660,17 @@ to keep the focused child in view.
<function name="gtk_volume_button_new">
<description>
-Creates a #GtkVolumeButton, with a range between 0.0 and 1.0, with
-a stepping of 0.02. Volume values can be obtained and modified using
-the functions from #GtkScaleButton.
+Creates a `GtkVolumeButton`.
+
+The button has a range between 0.0 and 1.0, with a stepping of 0.02.
+Volume values can be obtained and modified using the functions from
+[class@Gtk.ScaleButton].
</description>
<parameters>
</parameters>
-<return> a new #GtkVolumeButton
+<return> a new `GtkVolumeButton`
</return>
</function>
@@ -84761,7 +88682,7 @@ gtk_widget_class_install_action().
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="action_name">
@@ -84779,9 +88700,10 @@ gtk_widget_class_install_action().
<function name="gtk_widget_activate">
<description>
For widgets that can be “activated” (buttons, menu items, etc.)
-this function activates them. The activation will emit the signal
-set using gtk_widget_class_set_activate_signal() during class
-initialization.
+this function activates them.
+
+The activation will emit the signal set using
+gtk_widget_class_set_activate_signal() during class initialization.
Activation is what happens when you press Enter on a widget during
key navigation.
@@ -84796,7 +88718,7 @@ If @widget isn't activatable, the function returns %FALSE.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget that’s activatable
+<parameter_description> a `GtkWidget` that’s activatable
</parameter_description>
</parameter>
</parameters>
@@ -84809,14 +88731,14 @@ If @widget isn't activatable, the function returns %FALSE.
Looks up the action in the action groups associated
with @widget and its ancestors, and activates it.
-This is a wrapper around gtk_widget_activate_action_variant()
+This is a wrapper around [method@Gtk.Widget.activate_action_variant]
that constructs the @args variant according to @format_string.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="name">
@@ -84833,29 +88755,29 @@ for no arguments
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the action was activated, %FALSE if the action does
-not exist.
+<return> %TRUE if the action was activated, %FALSE if the action
+does not exist
</return>
</function>
<function name="gtk_widget_activate_action_variant">
<description>
-Looks up the action in the action groups associated
-with @widget and its ancestors, and activates it.
+Looks up the action in the action groups associated with
+@widget and its ancestors, and activates it.
If the action is in an action group added with
-gtk_widget_insert_action_group(), the @name is
-expected to be prefixed with the prefix that was
-used when the group was inserted.
+[method@Gtk.Widget.insert_action_group], the @name is expected
+to be prefixed with the prefix that was used when the group was
+inserted.
-The arguments must match the actions expected parameter
-type, as returned by g_action_get_parameter_type().
+The arguments must match the actions expected parameter type,
+as returned by `g_action_get_parameter_type()`.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="name">
@@ -84867,19 +88789,19 @@ type, as returned by g_action_get_parameter_type().
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the action was activated, %FALSE if the action does
-not exist.
+<return> %TRUE if the action was activated, %FALSE if the
+action does not exist.
</return>
</function>
<function name="gtk_widget_activate_default">
<description>
-Activate the default.activate action from @widget.
+Activates the `default.activate` action from @widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -84888,14 +88810,15 @@ Activate the default.activate action from @widget.
<function name="gtk_widget_add_controller">
<description>
-Adds @controller to @widget so that it will receive events. You will
-usually want to call this function right after creating any kind of
-#GtkEventController.
+Adds @controller to @widget so that it will receive events.
+
+You will usually want to call this function right after
+creating any kind of [class@Gtk.EventController].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="controller">
@@ -84909,13 +88832,18 @@ added to a widget yet
<function name="gtk_widget_add_css_class">
<description>
-Adds @css_class to @widget. After calling this function, @widget's
-style will match for @css_class, after the CSS matching rules.
+Adds a style class to @widget.
+
+After calling this function, the widgets style will match
+for @css_class, according to CSS matching rules.
+
+Use [method@Gtk.Widget.remove_css_class] to remove the
+style again.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="css_class">
@@ -84929,21 +88857,22 @@ the leading '.' used for notation of style classes
<function name="gtk_widget_add_mnemonic_label">
<description>
-Adds a widget to the list of mnemonic labels for
-this widget. (See gtk_widget_list_mnemonic_labels()). Note the
+Adds a widget to the list of mnemonic labels for this widget.
+
+See [method@Gtk.Widget.list_mnemonic_labels]. Note the
list of mnemonic labels for the widget is cleared when the
widget is destroyed, so the caller must make sure to update
its internal state at this point as well, by using a connection
-to the #GtkWidget::destroy signal or a weak notifier.
+to the [signal@Gtk.Widget::destroy] signal or a weak notifier.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="label">
-<parameter_description> a #GtkWidget that acts as a mnemonic label for @widget
+<parameter_description> a `GtkWidget` that acts as a mnemonic label for @widget
</parameter_description>
</parameter>
</parameters>
@@ -84959,7 +88888,7 @@ changes.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="callback">
@@ -84976,39 +88905,41 @@ changes.
</parameter>
</parameters>
<return> an id for the connection of this callback. Remove the callback by
-passing the id returned from this funcction to
-gtk_widget_remove_surface_transform_changed_callback()
+passing the id returned from this function to
+[method@Gtk.Widget.remove_surface_transform_changed_callback]
</return>
</function>
<function name="gtk_widget_add_tick_callback">
<description>
Queues an animation frame update and adds a callback to be called
-before each frame. Until the tick callback is removed, it will be
-called frequently (usually at the frame rate of the output device
-or as quickly as the application can be repainted, whichever is
-slower). For this reason, is most suitable for handling graphics
-that change every frame or every few frames. The tick callback does
-not automatically imply a relayout or repaint. If you want a
-repaint or relayout, and aren’t changing widget properties that
-would trigger that (for example, changing the text of a #GtkLabel),
-then you will have to call gtk_widget_queue_resize() or
-gtk_widget_queue_draw() yourself.
-
-gdk_frame_clock_get_frame_time() should generally be used for timing
-continuous animations and
-gdk_frame_timings_get_predicted_presentation_time() if you are
+before each frame.
+
+Until the tick callback is removed, it will be called frequently
+(usually at the frame rate of the output device or as quickly as
+the application can be repainted, whichever is slower). For this
+reason, is most suitable for handling graphics that change every
+frame or every few frames. The tick callback does not automatically
+imply a relayout or repaint. If you want a repaint or relayout, and
+aren’t changing widget properties that would trigger that (for example,
+changing the text of a #GtkLabel), then you will have to call
+[method@Gtk.Widget.queue_resize] or [method@Gtk.Widget.queue_draw]
+yourself.
+
+[method@Gdk.FrameClock.get_frame_time] should generally be used
+for timing continuous animations and
+[method@Gdk.FrameTimings.get_predicted_presentation_time] if you are
trying to display isolated frames at particular times.
This is a more convenient alternative to connecting directly to the
-#GdkFrameClock::update signal of #GdkFrameClock, since you don't
-have to worry about when a #GdkFrameClock is assigned to a widget.
+[signal@Gdk.FrameClock::update] signal of `GdkFrameClock`, since you
+don't have to worry about when a `GdkFrameClock` is assigned to a widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="callback">
@@ -85026,25 +88957,27 @@ have to worry about when a #GdkFrameClock is assigned to a widget.
</parameters>
<return> an id for the connection of this callback. Remove the callback
by passing the id returned from this function to
-gtk_widget_remove_tick_callback()
+[method@Gtk.Widget.remove_tick_callback]
</return>
</function>
<function name="gtk_widget_allocate">
<description>
-This function is only used by #GtkWidget subclasses, to assign a size,
-position and (optionally) baseline to their child widgets.
+This function is only used by `GtkWidget` subclasses, to
+assign a size, position and (optionally) baseline to their
+child widgets.
-In this function, the allocation and baseline may be adjusted. The given
-allocation will be forced to be bigger than the widget's minimum size,
-as well as at least 0×0 in size.
+In this function, the allocation and baseline may be adjusted.
+The given allocation will be forced to be bigger than the
+widget's minimum size, as well as at least 0×0 in size.
-For a version that does not take a transform, see gtk_widget_size_allocate()
+For a version that does not take a transform, see
+[method@Gtk.Widget.size_allocate].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> A #GtkWidget
+<parameter_description> A `GtkWidget`
</parameter_description>
</parameter>
<parameter name="width">
@@ -85069,29 +89002,32 @@ For a version that does not take a transform, see gtk_widget_size_allocate()
<function name="gtk_widget_child_focus">
<description>
-This function is used by custom widget implementations; if you're
-writing an app, you’d use gtk_widget_grab_focus() to move the focus
-to a particular widget.
+Called by widgets as the user moves around the window using
+keyboard shortcuts.
+
+The @direction argument indicates what kind of motion is taking place (up,
+down, left, right, tab forward, tab backward).
+
+This function calls the [vfunc@Gtk.Widget.focus] virtual function; widgets
+can override the virtual function in order to implement appropriate focus
+behavior.
-gtk_widget_child_focus() is called by widgets as the user moves
-around the window using keyboard shortcuts. @direction indicates
-what kind of motion is taking place (up, down, left, right, tab
-forward, tab backward). gtk_widget_child_focus() calls the
-#GtkWidgetClass.focus() vfunc; widgets override this vfunc
-in order to implement appropriate focus behavior.
+The default `focus()` virtual function for a widget should return `TRUE` if
+moving in @direction left the focus on a focusable location inside that
+widget, and `FALSE` if moving in @direction moved the focus outside the
+widget. When returning `TRUE`, widgets normallycall [method@Gtk.Widget.grab_focus]
+to place the focus accordingly; when returning `FALSE`, they don’t modify
+the current focus location.
-The default focus() vfunc for a widget should return %TRUE if
-moving in @direction left the focus on a focusable location inside
-that widget, and %FALSE if moving in @direction moved the focus
-outside the widget. If returning %TRUE, widgets normally
-call gtk_widget_grab_focus() to place the focus accordingly;
-if returning %FALSE, they don’t modify the current focus location.
+This function is used by custom widget implementations; if you're
+writing an app, you’d use [method@Gtk.Widget.grab_focus] to move
+the focus to a particular widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="direction">
@@ -85107,6 +89043,7 @@ if returning %FALSE, they don’t modify the current focus location.
<description>
Creates a new shortcut for @widget_class that calls the given @callback
with arguments read according to @format_string.
+
The arguments and format string must be provided in the same way as
with g_variant_new().
@@ -85151,6 +89088,7 @@ no arguments
<description>
Creates a new shortcut for @widget_class that activates the given
@action_name with arguments read according to @format_string.
+
The arguments and format string must be provided in the same way as
with g_variant_new().
@@ -85193,6 +89131,7 @@ no arguments
<description>
Creates a new shortcut for @widget_class that emits the given action
@signal with arguments read according to @format_string.
+
The arguments and format string must be provided in the same way as
with g_variant_new().
@@ -85233,11 +89172,12 @@ no arguments
<function name="gtk_widget_class_add_shortcut">
<description>
-Installs a shortcut in @widget_class. Every instance created for
-@widget_class or its subclasses will inherit this shortcut and
-trigger it.
+Installs a shortcut in @widget_class.
+
+Every instance created for @widget_class or its subclasses will
+inherit this shortcut and trigger it.
-Shortcuts added this way will be triggered in the @GTK_PHASE_BUBBLE
+Shortcuts added this way will be triggered in the %GTK_PHASE_BUBBLE
phase, which means they may also trigger if child widgets have focus.
This function must only be used in class initialization functions
@@ -85282,18 +89222,19 @@ on @widget_class.
<function name="gtk_widget_class_bind_template_callback_full">
<description>
-Declares a @callback_symbol to handle @callback_name from the template XML
-defined for @widget_type. This function is not supported after
-gtk_widget_class_set_template_scope() has been used on @widget_class.
-See gtk_builder_cscope_add_callback_symbol().
+Declares a @callback_symbol to handle @callback_name from
+the template XML defined for @widget_type.
-Note that this must be called from a composite widget classes class
-initializer after calling gtk_widget_class_set_template().
+This function is not supported after [method@Gtk.WidgetClass.set_template_scope]
+has been used on @widget_class. See [method@Gtk.BuilderCScope.add_callback_symbol].
+
+Note that this must be called from a composite widget classes
+class initializer after calling [method@Gtk.WidgetClass.set_template].
</description>
<parameters>
<parameter name="widget_class">
-<parameter_description> A #GtkWidgetClass
+<parameter_description> A `GtkWidgetClass`
</parameter_description>
</parameter>
<parameter name="callback_name">
@@ -85338,33 +89279,39 @@ instance structure.
<function name="gtk_widget_class_bind_template_child_full">
<description>
-Automatically assign an object declared in the class template XML to be set to a location
-on a freshly built instance’s private data, or alternatively accessible via gtk_widget_get_template_child().
-
-The struct can point either into the public instance, then you should use G_STRUCT_OFFSET(WidgetType, member)
-for @struct_offset, or in the private struct, then you should use G_PRIVATE_OFFSET(WidgetType, member).
-
-An explicit strong reference will be held automatically for the duration of your
-instance’s life cycle, it will be released automatically when #GObjectClass.dispose() runs
-on your instance and if a @struct_offset that is != 0 is specified, then the automatic location
-in your instance public or private data will be set to %NULL. You can however access an automated child
-pointer the first time your classes #GObjectClass.dispose() runs, or alternatively in
-#GtkWidgetClass.destroy().
-
-If @internal_child is specified, #GtkBuildableIface.get_internal_child() will be automatically
-implemented by the #GtkWidget class so there is no need to implement it manually.
-
-The wrapper macros gtk_widget_class_bind_template_child(), gtk_widget_class_bind_template_child_internal(),
-gtk_widget_class_bind_template_child_private() and gtk_widget_class_bind_template_child_internal_private()
+Automatically assign an object declared in the class template XML to be
+set to a location on a freshly built instance’s private data, or
+alternatively accessible via [method@Gtk.Widget.get_template_child].
+
+The struct can point either into the public instance, then you should
+use `G_STRUCT_OFFSET(WidgetType, member)` for @struct_offset, or in the
+private struct, then you should use `G_PRIVATE_OFFSET(WidgetType, member)`.
+
+An explicit strong reference will be held automatically for the duration
+of your instance’s life cycle, it will be released automatically when
+`GObjectClass.dispose()` runs on your instance and if a @struct_offset
+that is `!= 0` is specified, then the automatic location in your instance
+public or private data will be set to %NULL. You can however access an
+automated child pointer the first time your classes `GObjectClass.dispose()`
+runs, or alternatively in [signal@Gtk.Widget::destroy].
+
+If @internal_child is specified, [vfunc@Gtk.Buildable.get_internal_child]
+will be automatically implemented by the `GtkWidget` class so there is no
+need to implement it manually.
+
+The wrapper macros [func@Gtk.widget_class_bind_template_child],
+[func@Gtk.widget_class_bind_template_child_internal],
+[func@Gtk.widget_class_bind_template_child_private] and
+[func@Gtk.widget_class_bind_template_child_internal_private]
might be more convenient to use.
Note that this must be called from a composite widget classes class
-initializer after calling gtk_widget_class_set_template().
+initializer after calling [method@Gtk.WidgetClass.set_template].
</description>
<parameters>
<parameter name="widget_class">
-<parameter_description> A #GtkWidgetClass
+<parameter_description> A `GtkWidgetClass`
</parameter_description>
</parameter>
<parameter name="name">
@@ -85476,18 +89423,18 @@ must be added with G_ADD_PRIVATE()).
<function name="gtk_widget_class_get_accessible_role">
<description>
-Retrieves the accessible role used by the given #GtkWidget class.
+Retrieves the accessible role used by the given `GtkWidget` class.
Different accessible roles have different states, and are rendered
differently by assistive technologies.
-See also: gtk_accessible_get_accessible_role()
+See also: [method@Gtk.Accessible.get_accessible_role].
</description>
<parameters>
<parameter name="widget_class">
-<parameter_description> a #GtkWidgetClass
+<parameter_description> a `GtkWidgetClass`
</parameter_description>
</parameter>
</parameters>
@@ -85504,7 +89451,7 @@ gtk_widget_class_set_activate_signal().
</description>
<parameters>
<parameter name="widget_class">
-<parameter_description> a #GtkWidgetClass
+<parameter_description> a `GtkWidgetClass`
</parameter_description>
</parameter>
</parameters>
@@ -85515,8 +89462,9 @@ specify an activation signal
<function name="gtk_widget_class_get_css_name">
<description>
-Gets the name used by this class for matching in CSS code. See
-gtk_widget_class_set_css_name() for details.
+Gets the name used by this class for matching in CSS code.
+
+See gtk_widget_class_set_css_name() for details.
</description>
@@ -85532,7 +89480,8 @@ gtk_widget_class_set_css_name() for details.
<function name="gtk_widget_class_get_layout_manager_type">
<description>
-Retrieves the type of the #GtkLayoutManager used by the #GtkWidget class.
+Retrieves the type of the [class@Gtk.LayoutManager]
+used by the `GtkWidget` class.
See also: gtk_widget_class_set_layout_manager_type()
@@ -85540,11 +89489,11 @@ See also: gtk_widget_class_set_layout_manager_type()
</description>
<parameters>
<parameter name="widget_class">
-<parameter_description> a #GtkWidgetClass
+<parameter_description> a `GtkWidgetClass`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkLayoutManager subclass, or %G_TYPE_INVALID
+<return> type of a `GtkLayoutManager` subclass, or %G_TYPE_INVALID
</return>
</function>
@@ -85559,7 +89508,7 @@ they have is whether they are enabled or not.
</description>
<parameters>
<parameter name="widget_class">
-<parameter_description> a #GtkWidgetClass
+<parameter_description> a `GtkWidgetClass`
</parameter_description>
</parameter>
<parameter name="action_name">
@@ -85580,8 +89529,8 @@ they have is whether they are enabled or not.
<function name="gtk_widget_class_install_property_action">
<description>
-Installs an action called @action_name on @widget_class and binds its
-state to the value of the @property_name property.
+Installs an action called @action_name on @widget_class and
+binds its state to the value of the @property_name property.
This function will perform a few santity checks on the property selected
via @property_name. Namely, the property must exist, must be readable,
@@ -85599,7 +89548,7 @@ of the same type as the property.
</description>
<parameters>
<parameter name="widget_class">
-<parameter_description> a #GtkWidgetClass
+<parameter_description> a `GtkWidgetClass`
</parameter_description>
</parameter>
<parameter name="action_name">
@@ -85618,7 +89567,7 @@ or any parent class.
<function name="gtk_widget_class_query_action">
<description>
Queries the actions that have been installed for
-a widget class using gtk_widget_class_install_action()
+a widget class using [method@Gtk.WidgetClass.install_action]
during class initialization.
Note that this function will also return actions defined
@@ -85629,7 +89578,7 @@ at @owner.
</description>
<parameters>
<parameter name="widget_class">
-<parameter_description> a #GtkWidgetClass
+<parameter_description> a `GtkWidget` class
</parameter_description>
</parameter>
<parameter name="index_">
@@ -85660,19 +89609,19 @@ at @owner.
<function name="gtk_widget_class_set_accessible_role">
<description>
-Sets the accessible role used by the given #GtkWidget class.
+Sets the accessible role used by the given `GtkWidget` class.
-Different accessible roles have different states, and are rendered
-differently by assistive technologies.
+Different accessible roles have different states, and are
+rendered differently by assistive technologies.
</description>
<parameters>
<parameter name="widget_class">
-<parameter_description> a #GtkWidgetClass
+<parameter_description> a `GtkWidgetClass`
</parameter_description>
</parameter>
<parameter name="accessible_role">
-<parameter_description> the #GtkAccessibleRole used by the @widget_class
+<parameter_description> the `GtkAccessibleRole` used by the @widget_class
</parameter_description>
</parameter>
</parameters>
@@ -85681,7 +89630,7 @@ differently by assistive technologies.
<function name="gtk_widget_class_set_activate_signal">
<description>
-Sets the #GtkWidgetClass.activate_signal field with the
+Sets the GtkWidgetClass.activate_signal field with the
given @signal_id; the signal will be emitted when calling
gtk_widget_activate().
@@ -85691,7 +89640,7 @@ or g_signal_newv() before calling this function.
</description>
<parameters>
<parameter name="widget_class">
-<parameter_description> a #GtkWidgetClass
+<parameter_description> a `GtkWidgetClass`
</parameter_description>
</parameter>
<parameter name="signal_id">
@@ -85704,7 +89653,7 @@ or g_signal_newv() before calling this function.
<function name="gtk_widget_class_set_activate_signal_from_name">
<description>
-Sets the #GtkWidgetClass.activate_signal field with the signal id for
+Sets the GtkWidgetClass.activate_signal field with the signal id for
the given @signal_name; the signal will be emitted when calling
gtk_widget_activate().
@@ -85714,7 +89663,7 @@ g_signal_new() or g_signal_newv() before calling this function.
</description>
<parameters>
<parameter name="widget_class">
-<parameter_description> a #GtkWidgetClass
+<parameter_description> a `GtkWidgetClass`
</parameter_description>
</parameter>
<parameter name="signal_name">
@@ -85730,8 +89679,8 @@ g_signal_new() or g_signal_newv() before calling this function.
Sets the name to be used for CSS matching of widgets.
If this function is not called for a given class, the name
-set on the parent class is used. By default, GtkWidget uses
-the name "widget".
+set on the parent class is used. By default, `GtkWidget`
+uses the name "widget".
</description>
<parameters>
@@ -85750,18 +89699,22 @@ the name "widget".
<function name="gtk_widget_class_set_layout_manager_type">
<description>
Sets the type to be used for creating layout managers for widgets of
-@widget_class. The given @type must be a subtype of #GtkLayoutManager.
+@widget_class.
+
+The given @type must be a subtype of [class@Gtk.LayoutManager].
-This function should only be called from class init functions of widgets.
+This function should only be called from class init functions
+of widgets.
</description>
<parameters>
<parameter name="widget_class">
-<parameter_description> class to set the layout manager type for
+<parameter_description> a `GtkWidgetClass`
</parameter_description>
</parameter>
<parameter name="type">
-<parameter_description> The object type that implements the #GtkLayoutManager for @widget_class
+<parameter_description> The object type that implements the `GtkLayoutManager`
+for @widget_class
</parameter_description>
</parameter>
</parameters>
@@ -85771,21 +89724,22 @@ This function should only be called from class init functions of widgets.
<function name="gtk_widget_class_set_template">
<description>
This should be called at class initialization time to specify
-the GtkBuilder XML to be used to extend a widget.
+the `GtkBuilder` XML to be used to extend a widget.
-For convenience, gtk_widget_class_set_template_from_resource() is also provided.
+For convenience, [method@Gtk.WidgetClass.set_template_from_resource]
+is also provided.
-Note that any class that installs templates must call gtk_widget_init_template()
-in the widget’s instance initializer.
+Note that any class that installs templates must call
+[method@Gtk.Widget.init_template] in the widget’s instance initializer.
</description>
<parameters>
<parameter name="widget_class">
-<parameter_description> A #GtkWidgetClass
+<parameter_description> A `GtkWidgetClass`
</parameter_description>
</parameter>
<parameter name="template_bytes">
-<parameter_description> A #GBytes holding the #GtkBuilder XML
+<parameter_description> A #GBytes holding the #GtkBuilder XML
</parameter_description>
</parameter>
</parameters>
@@ -85794,15 +89748,17 @@ in the widget’s instance initializer.
<function name="gtk_widget_class_set_template_from_resource">
<description>
-A convenience function to call gtk_widget_class_set_template().
+A convenience function that calls [method@Gtk.WidgetClass.set_template]
+with the contents of a `GResource`.
-Note that any class that installs templates must call gtk_widget_init_template()
-in the widget’s instance initializer.
+Note that any class that installs templates must call
+[method@Gtk.Widget.init_template] in the widget’s instance
+initializer.
</description>
<parameters>
<parameter name="widget_class">
-<parameter_description> A #GtkWidgetClass
+<parameter_description> A `GtkWidgetClass`
</parameter_description>
</parameter>
<parameter name="resource_name">
@@ -85815,8 +89771,9 @@ in the widget’s instance initializer.
<function name="gtk_widget_class_set_template_scope">
<description>
-For use in language bindings, this will override the default #GtkBuilderScope to be
-used when parsing GtkBuilder XML from this class’s template data.
+For use in language bindings, this will override the default
+`GtkBuilderScope` to be used when parsing GtkBuilder XML from
+this class’s template data.
Note that this must be called from a composite widget classes class
initializer after calling gtk_widget_class_set_template().
@@ -85824,11 +89781,12 @@ initializer after calling gtk_widget_class_set_template().
</description>
<parameters>
<parameter name="widget_class">
-<parameter_description> A #GtkWidgetClass
+<parameter_description> A `GtkWidgetClass`
</parameter_description>
</parameter>
<parameter name="scope">
-<parameter_description> The #GtkBuilderScope to use when loading the class template
+<parameter_description> The `GtkBuilderScope` to use when loading
+the class template
</parameter_description>
</parameter>
</parameters>
@@ -85844,11 +89802,11 @@ is closest to the two widgets.
</description>
<parameters>
<parameter name="widget_a">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="widget_b">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -85861,6 +89819,7 @@ share a common ancestor.
<function name="gtk_widget_compute_bounds">
<description>
Computes the bounds for @widget in the coordinate space of @target.
+
FIXME: Explain what "bounds" are.
If the operation is successful, %TRUE is returned. If @widget has no
@@ -85874,11 +89833,11 @@ It is valid for @widget and @target to be the same widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> the #GtkWidget to query
+<parameter_description> the `GtkWidget` to query
</parameter_description>
</parameter>
<parameter name="target">
-<parameter_description> the #GtkWidget
+<parameter_description> the `GtkWidget`
</parameter_description>
</parameter>
<parameter name="out_bounds">
@@ -85892,9 +89851,11 @@ It is valid for @widget and @target to be the same widget.
<function name="gtk_widget_compute_expand">
<description>
-Computes whether a container should give this widget extra space
-when possible. Containers should check this, rather than
-looking at gtk_widget_get_hexpand() or gtk_widget_get_vexpand().
+Computes whether a container should give this widget
+extra space when possible.
+
+Containers should check this, rather than looking at
+[method@Gtk.Widget.get_hexpand] or [method@Gtk.Widget.get_vexpand].
This function already checks whether the widget is visible, so
visibility does not need to be checked separately. Non-visible
@@ -85923,18 +89884,20 @@ the widget may expand if some of its children do.
<function name="gtk_widget_compute_point">
<description>
Translates the given @point in @widget's coordinates to coordinates
-relative to @target’s coordinate system. In order to perform this
-operation, both widgets must share a common root.
+relative to @target’s coordinate system.
+
+In order to perform this operation, both widgets must share a
+common ancestor.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> the #GtkWidget to query
+<parameter_description> the `GtkWidget` to query
</parameter_description>
</parameter>
<parameter name="target">
-<parameter_description> the #GtkWidget to transform into
+<parameter_description> the `GtkWidget` to transform into
</parameter_description>
</parameter>
<parameter name="point">
@@ -85961,7 +89924,7 @@ Computes a matrix suitable to describe a transformation from
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="target">
@@ -86010,38 +89973,40 @@ The coordinates for (@x, @y) must be in widget coordinates, so
<function name="gtk_widget_create_pango_context">
<description>
-Creates a new #PangoContext with the appropriate font map,
+Creates a new `PangoContext` with the appropriate font map,
font options, font description, and base direction for drawing
-text for this widget. See also gtk_widget_get_pango_context().
+text for this widget.
+
+See also [method@Gtk.Widget.get_pango_context].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> the new #PangoContext
+<return> the new `PangoContext`
</return>
</function>
<function name="gtk_widget_create_pango_layout">
<description>
-Creates a new #PangoLayout with the appropriate font map,
+Creates a new `PangoLayout` with the appropriate font map,
font description, and base direction for drawing text for
this widget.
-If you keep a #PangoLayout created in this way around, you need
-to re-create it when the widget #PangoContext is replaced.
-This can be tracked by listening to changes of the #GtkWidget:root property
-on the widget.
+If you keep a `PangoLayout` created in this way around,
+you need to re-create it when the widget `PangoContext`
+is replaced. This can be tracked by listening to changes
+of the [property@Gtk.Widget:root] property on the widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="text">
@@ -86049,24 +90014,25 @@ on the widget.
</parameter_description>
</parameter>
</parameters>
-<return> the new #PangoLayout
+<return> the new `PangoLayout`
</return>
</function>
<function name="gtk_widget_error_bell">
<description>
Notifies the user about an input-related error on this widget.
-If the #GtkSettings:gtk-error-bell setting is %TRUE, it calls
-gdk_surface_beep(), otherwise it does nothing.
-Note that the effect of gdk_surface_beep() can be configured in many
-ways, depending on the windowing backend and the desktop environment
-or window manager that is used.
+If the [property@Gtk.Settings:gtk-error-bell] setting is %TRUE,
+it calls [method Gdk Surface beep], otherwise it does nothing.
+
+Note that the effect of [method Gdk Surface beep] can be configured
+in many ways, depending on the windowing backend and the desktop
+environment or window manager that is used.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86076,9 +90042,10 @@ or window manager that is used.
<function name="gtk_widget_get_allocated_baseline">
<description>
Returns the baseline that has currently been allocated to @widget.
+
This function is intended to be used when implementing handlers
-for the #GtkWidgetClass.snapshot() function, and when allocating child
-widgets in #GtkWidgetClass.size_allocate().
+for the `GtkWidget`Class.snapshot() function, and when allocating
+child widgets in `GtkWidget`Class.size_allocate().
</description>
@@ -86130,13 +90097,13 @@ Retrieves the widget’s allocation.
Note, when implementing a layout container: a widget’s allocation
will be its “adjusted” allocation, that is, the widget’s parent
-typically calls gtk_widget_size_allocate() with an allocation,
+typically calls [method@Gtk.Widget.size_allocate] with an allocation,
and that allocation is then adjusted (to handle margin
and alignment for example) before assignment to the widget.
-gtk_widget_get_allocation() returns the adjusted allocation that
+[method@Gtk.Widget.get_allocation] returns the adjusted allocation that
was actually assigned to the widget. The adjusted allocation is
guaranteed to be completely contained within the
-gtk_widget_size_allocate() allocation, however.
+[method@Gtk.Widget.size_allocate] allocation, however.
So a layout container is guaranteed that its children stay inside
the assigned bounds, but not that they have exactly the bounds the
@@ -86145,11 +90112,11 @@ container assigned.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="allocation">
-<parameter_description> a pointer to a #GtkAllocation to copy to
+<parameter_description> a pointer to a `GtkAllocation` to copy to
</parameter_description>
</parameter>
</parameters>
@@ -86158,19 +90125,21 @@ container assigned.
<function name="gtk_widget_get_ancestor">
<description>
-Gets the first ancestor of @widget with type @widget_type. For example,
-`gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)` gets
-the first #GtkBox that’s an ancestor of @widget. No reference will be
-added to the returned widget; it should not be unreferenced.
+Gets the first ancestor of @widget with type @widget_type.
+
+For example, `gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)`
+gets the first `GtkBox` that’s an ancestor of @widget. No
+reference will be added to the returned widget; it should
+not be unreferenced.
-Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor()
+Note that unlike [method@Gtk.Widget.is_ancestor], this function
considers @widget to be an ancestor of itself.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="widget_type">
@@ -86178,7 +90147,8 @@ considers @widget to be an ancestor of itself.
</parameter_description>
</parameter>
</parameters>
-<return> the ancestor widget, or %NULL if not found
+<return> the ancestor widget,
+or %NULL if not found
</return>
</function>
@@ -86187,13 +90157,13 @@ considers @widget to be an ancestor of itself.
Determines whether the input focus can enter @widget or any
of its children.
-See gtk_widget_set_focusable().
+See [method@Gtk.Widget.set_focusable].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86209,7 +90179,7 @@ Queries whether @widget can be the target of pointer events.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86220,17 +90190,18 @@ Queries whether @widget can be the target of pointer events.
<function name="gtk_widget_get_child_visible">
<description>
Gets the value set with gtk_widget_set_child_visible().
+
If you feel a need to use this function, your code probably
needs reorganization.
-This function is only useful for container implementations and
-never should be called by an application.
+This function is only useful for container implementations
+and should never be called by an application.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86240,8 +90211,10 @@ never should be called by an application.
<function name="gtk_widget_get_clipboard">
<description>
+Gets the clipboard object for @widget.
+
This is a utility function to get the clipboard object for the
-#GdkDisplay that @widget is using.
+`GdkDisplay` that @widget is using.
Note that this function always works, even when @widget is not
realized yet.
@@ -86250,7 +90223,7 @@ realized yet.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86260,13 +90233,13 @@ realized yet.
<function name="gtk_widget_get_css_classes">
<description>
-Returns the list of css classes applied to @widget.
+Returns the list of style classes applied to @widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86284,7 +90257,7 @@ Returns the CSS name that is used for @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86294,26 +90267,28 @@ Returns the CSS name that is used for @self.
<function name="gtk_widget_get_cursor">
<description>
-Queries the cursor set via gtk_widget_set_cursor(). See that function for
-details.
+Queries the cursor set on @widget.
+
+See [method@Gtk.Widget.set_cursor] for details.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> the cursor currently in use or %NULL
-to use the default.
+<return> the cursor
+currently in use or %NULL to use the default.
</return>
</function>
<function name="gtk_widget_get_default_direction">
<description>
-Obtains the current default reading direction. See
-gtk_widget_set_default_direction().
+Obtains the current default reading direction.
+
+See [func@Gtk.Widget.set_default_direction].
</description>
@@ -86325,14 +90300,15 @@ gtk_widget_set_default_direction().
<function name="gtk_widget_get_direction">
<description>
-Gets the reading direction for a particular widget. See
-gtk_widget_set_direction().
+Gets the reading direction for a particular widget.
+
+See [method@Gtk.Widget.set_direction].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86342,9 +90318,11 @@ gtk_widget_set_direction().
<function name="gtk_widget_get_display">
<description>
-Get the #GdkDisplay for the toplevel window associated with
-this widget. This function can only be called after the widget
-has been added to a widget hierarchy with a #GtkWindow at the top.
+Get the `GdkDisplay` for the toplevel window associated with
+this widget.
+
+This function can only be called after the widget has been
+added to a widget hierarchy with a `GtkWindow` at the top.
In general, you should only create display specific
resources when a widget has been realized, and you should
@@ -86354,11 +90332,12 @@ free those resources when the widget is unrealized.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkDisplay for the toplevel for this widget.
+<return> the `GdkDisplay` for the toplevel
+for this widget.
</return>
</function>
@@ -86372,7 +90351,7 @@ This API is primarily meant for widget implementations.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86388,43 +90367,46 @@ Returns the current focus child of @widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> The current focus child of @widget,
-or %NULL in case the focus child is unset.
+<return> The current focus
+child of @widget, or %NULL in case the focus child is unset.
</return>
</function>
<function name="gtk_widget_get_focus_on_click">
<description>
-Returns whether the widget should grab focus when it is clicked with the mouse.
-See gtk_widget_set_focus_on_click().
+Returns whether the widget should grab focus when it is clicked
+with the mouse.
+
+See [method@Gtk.Widget.set_focus_on_click].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget should grab focus when it is clicked with
-the mouse.
+<return> %TRUE if the widget should grab focus when it is
+clicked with the mouse
</return>
</function>
<function name="gtk_widget_get_focusable">
<description>
Determines whether @widget can own the input focus.
-See gtk_widget_set_focusable().
+
+See [method@Gtk.Widget.set_focusable].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86434,51 +90416,57 @@ See gtk_widget_set_focusable().
<function name="gtk_widget_get_font_map">
<description>
-Gets the font map that has been set with gtk_widget_set_font_map().
+Gets the font map of @widget.
+
+See [method@Gtk.Widget.set_font_map].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> A #PangoFontMap, or %NULL
+<return> A `PangoFontMap`, or %NULL
</return>
</function>
<function name="gtk_widget_get_font_options">
<description>
-Returns the #cairo_font_options_t used for Pango rendering. When not set,
-the defaults font options for the #GdkDisplay will be used.
+Returns the `cairo_font_options_t` used for Pango rendering.
+
+When not set, the defaults font options for the `GdkDisplay`
+will be used.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> the #cairo_font_options_t or %NULL if not set
+<return> the `cairo_font_options_t`
+or %NULL if not set
</return>
</function>
<function name="gtk_widget_get_frame_clock">
<description>
-Obtains the frame clock for a widget. The frame clock is a global
-“ticker” that can be used to drive animations and repaints. The
-most common reason to get the frame clock is to call
-gdk_frame_clock_get_frame_time(), in order to get a time to use for
-animating. For example you might record the start of the animation
-with an initial value from gdk_frame_clock_get_frame_time(), and
-then update the animation by calling
-gdk_frame_clock_get_frame_time() again during each repaint.
+Obtains the frame clock for a widget.
-gdk_frame_clock_request_phase() will result in a new frame on the
+The frame clock is a global “ticker” that can be used to drive
+animations and repaints. The most common reason to get the frame
+clock is to call [method@Gdk.FrameClock.get_frame_time], in order
+to get a time to use for animating. For example you might record
+the start of the animation with an initial value from
+[method@Gdk.FrameClock.get_frame_time], and then update the animation
+by calling [method@Gdk.FrameClock.get_frame_time] again during each repaint.
+
+[method@Gdk.FrameClock.request_phase] will result in a new frame on the
clock, but won’t necessarily repaint any widgets. To repaint a
-widget, you have to use gtk_widget_queue_draw() which invalidates
+widget, you have to use [method@Gtk.Widget.queue_draw] which invalidates
the widget (thus scheduling it to receive a draw on the next
frame). gtk_widget_queue_draw() will also end up requesting a frame
on the appropriate frame clock.
@@ -86493,18 +90481,18 @@ Unrealized widgets do not have a frame clock.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkFrameClock,
+<return> a `GdkFrameClock`,
or %NULL if widget is unrealized
</return>
</function>
<function name="gtk_widget_get_halign">
<description>
-Gets the value of the #GtkWidget:halign property.
+Gets the horizontal alignment of @widget.
For backwards compatibility reasons this method will never return
%GTK_ALIGN_BASELINE, but instead it will convert it to
@@ -86515,7 +90503,7 @@ alignment.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86525,32 +90513,35 @@ alignment.
<function name="gtk_widget_get_has_tooltip">
<description>
-Returns the current value of the has-tooltip property. See
-#GtkWidget:has-tooltip for more information.
+Returns the current value of the `has-tooltip` property.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> current value of has-tooltip on @widget.
+<return> current value of `has-tooltip` on @widget.
</return>
</function>
<function name="gtk_widget_get_height">
<description>
-Returns the content height of the widget, as passed to its size-allocate implementation.
-This is the size you should be using in GtkWidgetClass.snapshot(). For pointer
-events, see gtk_widget_contains().
+Returns the content height of the widget.
+
+This function returns the size passed to its
+size-allocate implementation, which is the size you
+should be using in GtkWidgetClass.snapshot().
+
+For pointer events, see [method@Gtk.Widget.contains].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86561,13 +90552,15 @@ events, see gtk_widget_contains().
<function name="gtk_widget_get_hexpand">
<description>
Gets whether the widget would like any available extra horizontal
-space. When a user resizes a #GtkWindow, widgets with expand=TRUE
+space.
+
+When a user resizes a `GtkWindow`, widgets with expand=TRUE
generally receive the extra space. For example, a list or
scrollable area or document in your window would often be set to
expand.
-Containers should use gtk_widget_compute_expand() rather than
-this function, to see whether a widget, or any of its children,
+Containers should use [method@Gtk.Widget.compute_expand] rather
+than this function, to see whether a widget, or any of its children,
has the expand flag set. If any child of a widget wants to
expand, the parent may ask to expand also.
@@ -86589,13 +90582,13 @@ wants to expand.
<function name="gtk_widget_get_hexpand_set">
<description>
-Gets whether gtk_widget_set_hexpand() has been used to
-explicitly set the expand flag on this widget.
+Gets whether gtk_widget_set_hexpand() has been used
+to explicitly set the expand flag on this widget.
-If hexpand is set, then it overrides any computed
-expand value based on child widgets. If hexpand is not
-set, then the expand value depends on whether any
-children of the widget would like to expand.
+If [property@Gtk.Widget:hexpand] property is set, then it
+overrides any computed expand value based on child widgets.
+If `hexpand` is not set, then the expand value depends on
+whether any children of the widget would like to expand.
There are few reasons to use this function, but it’s here
for completeness and consistency.
@@ -86622,7 +90615,7 @@ This API is primarily meant for widget implementations.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86632,17 +90625,19 @@ This API is primarily meant for widget implementations.
<function name="gtk_widget_get_layout_manager">
<description>
-Retrieves the layout manager set using gtk_widget_set_layout_manager().
+Retrieves the layout manager used by @widget
+
+See [method@Gtk.Widget.set_layout_manager].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkLayoutManager
+<return> a `GtkLayoutManager`
</return>
</function>
@@ -86654,7 +90649,7 @@ Whether the widget is mapped.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86664,13 +90659,13 @@ Whether the widget is mapped.
<function name="gtk_widget_get_margin_bottom">
<description>
-Gets the value of the #GtkWidget:margin-bottom property.
+Gets the bottom margin of @widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86680,13 +90675,13 @@ Gets the value of the #GtkWidget:margin-bottom property.
<function name="gtk_widget_get_margin_end">
<description>
-Gets the value of the #GtkWidget:margin-end property.
+Gets the end margin of @widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86696,13 +90691,13 @@ Gets the value of the #GtkWidget:margin-end property.
<function name="gtk_widget_get_margin_start">
<description>
-Gets the value of the #GtkWidget:margin-start property.
+Gets the start margin of @widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86712,13 +90707,13 @@ Gets the value of the #GtkWidget:margin-start property.
<function name="gtk_widget_get_margin_top">
<description>
-Gets the value of the #GtkWidget:margin-top property.
+Gets the top margin of @widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86728,14 +90723,15 @@ Gets the value of the #GtkWidget:margin-top property.
<function name="gtk_widget_get_name">
<description>
-Retrieves the name of a widget. See gtk_widget_set_name() for the
-significance of widget names.
+Retrieves the name of a widget.
+
+See [method@Gtk.Widget.set_name] for the significance of widget names.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86746,21 +90742,22 @@ should not be modified or freed
<function name="gtk_widget_get_native">
<description>
-Returns the GtkNative widget that contains @widget,
-or %NULL if the widget is not contained inside a
-widget tree with a native ancestor.
+Returns the `GtkNative` widget that contains @widget.
-#GtkNative widgets will return themselves here.
+This function will return %NULL if the widget is not
+contained inside a widget tree with a native ancestor.
+
+`GtkNative` widgets will return themselves here.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkNative
+<return> the `GtkNative`
widget of @widget, or %NULL
</return>
</function>
@@ -86775,7 +90772,7 @@ This API is primarily meant for widget implementations.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86785,14 +90782,15 @@ This API is primarily meant for widget implementations.
<function name="gtk_widget_get_opacity">
<description>
-Fetches the requested opacity for this widget.
-See gtk_widget_set_opacity().
+#Fetches the requested opacity for this widget.
+
+See [method@Gtk.Widget.set_opacity].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86802,13 +90800,13 @@ See gtk_widget_set_opacity().
<function name="gtk_widget_get_overflow">
<description>
-Returns the value set via gtk_widget_set_overflow().
+Returns the widgets overflow value.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86818,23 +90816,25 @@ Returns the value set via gtk_widget_set_overflow().
<function name="gtk_widget_get_pango_context">
<description>
-Gets a #PangoContext with the appropriate font map, font description,
-and base direction for this widget. Unlike the context returned
-by gtk_widget_create_pango_context(), this context is owned by
-the widget (it can be used until the screen for the widget changes
-or the widget is removed from its toplevel), and will be updated to
-match any changes to the widget’s attributes. This can be tracked
-by listening to changes of the #GtkWidget:root property on the widget.
+Gets a `PangoContext` with the appropriate font map, font description,
+and base direction for this widget.
+
+Unlike the context returned by [method@Gtk.Widget.create_pango_context],
+this context is owned by the widget (it can be used until the screen
+for the widget changes or the widget is removed from its toplevel),
+and will be updated to match any changes to the widget’s attributes.
+This can be tracked by listening to changes of the
+[property@Gtk.Widget:root] property on the widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> the #PangoContext for the widget.
+<return> the `PangoContext` for the widget.
</return>
</function>
@@ -86846,11 +90846,12 @@ Returns the parent widget of @widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> the parent widget of @widget, or %NULL
+<return> the parent widget of @widget,
+or %NULL
</return>
</function>
@@ -86862,20 +90863,19 @@ into account the widget’s preference for height-for-width management.
This is used to retrieve a suitable size by container widgets which do
not impose any restrictions on the child placement. It can be used
to deduce toplevel window and menu sizes as well as child widgets in
-free-form containers such as GtkLayout.
+free-form containers such as `GtkFixed`.
Handle with care. Note that the natural height of a height-for-width
-widget will generally be a smaller size than the minimum height, since the required
-height for the natural width is generally smaller than the required height for
-the minimum width.
+widget will generally be a smaller size than the minimum height, since
+the required height for the natural width is generally smaller than the
+required height for the minimum width.
-Use gtk_widget_measure() if you want to support
-baseline alignment.
+Use [id@gtk_widget_measure] if you want to support baseline alignment.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget instance
+<parameter_description> a `GtkWidget` instance
</parameter_description>
</parameter>
<parameter name="minimum_size">
@@ -86900,7 +90900,7 @@ This API is primarily meant for widget implementations.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86910,8 +90910,10 @@ This API is primarily meant for widget implementations.
<function name="gtk_widget_get_primary_clipboard">
<description>
-This is a utility function to get the primary clipboard object
-for the #GdkDisplay that @widget is using.
+Gets the primary clipboard of @widget.
+
+This is a utility function to get the primary clipboard object
+for the `GdkDisplay` that @widget is using.
Note that this function always works, even when @widget is not
realized yet.
@@ -86920,7 +90922,7 @@ realized yet.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86936,7 +90938,7 @@ Determines whether @widget is realized.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86950,13 +90952,13 @@ Determines whether @widget is always treated as the default widget
within its toplevel when it has the focus, even if another widget
is the default.
-See gtk_widget_set_receives_default().
+See [method@Gtk.Widget.set_receives_default].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -86970,55 +90972,60 @@ See gtk_widget_set_receives_default().
Gets whether the widget prefers a height-for-width layout
or a width-for-height layout.
-#GtkBin widgets generally propagate the preference of
-their child, container widgets need to request something either in
-context of their children or in context of their allocation
-capabilities.
+Single-child widgets generally propagate the preference of
+their child, more complex widgets need to request something
+either in context of their children or in context of their
+allocation capabilities.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget instance
+<parameter_description> a `GtkWidget` instance
</parameter_description>
</parameter>
</parameters>
-<return> The #GtkSizeRequestMode preferred by @widget.
+<return> The `GtkSizeRequestMode` preferred by @widget.
</return>
</function>
<function name="gtk_widget_get_root">
<description>
-Returns the #GtkRoot widget of @widget or %NULL if the widget is not contained
+Returns the `GtkRoot` widget of @widget.
+
+This function will return %NULL if the widget is not contained
inside a widget tree with a root widget.
-#GtkRoot widgets will return themselves here.
+`GtkRoot` widgets will return themselves here.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> the root widget of @widget, or %NULL
+<return> the root widget of @widget,
+or %NULL
</return>
</function>
<function name="gtk_widget_get_scale_factor">
<description>
-Retrieves the internal scale factor that maps from window coordinates
-to the actual device pixels. On traditional systems this is 1, on
-high density outputs, it can be a higher value (typically 2).
+Retrieves the internal scale factor that maps from window
+coordinates to the actual device pixels.
-See gdk_surface_get_scale_factor().
+On traditional systems this is 1, on high density outputs,
+it can be a higher value (typically 2).
+
+See [method@Gdk.Surface.get_scale_factor].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87028,17 +91035,20 @@ See gdk_surface_get_scale_factor().
<function name="gtk_widget_get_sensitive">
<description>
-Returns the widget’s sensitivity (in the sense of returning
-the value that has been set using gtk_widget_set_sensitive()).
+Returns the widget’s sensitivity.
-The effective sensitivity of a widget is however determined by both its
-own and its parent widget’s sensitivity. See gtk_widget_is_sensitive().
+This function returns the value that has been set using
+[method@Gtk.Widget.set_sensitive]).
+
+The effective sensitivity of a widget is however determined
+by both its own and its parent widget’s sensitivity.
+See [method@Gtk.Widget.is_sensitive].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87050,16 +91060,16 @@ own and its parent widget’s sensitivity. See gtk_widget_is_sensitive().
<description>
Gets the settings object holding the settings used for this widget.
-Note that this function can only be called when the #GtkWidget
+Note that this function can only be called when the `GtkWidget`
is attached to a toplevel, since the settings object is specific
-to a particular #GdkDisplay. If you want to monitor the widget for
+to a particular `GdkDisplay`. If you want to monitor the widget for
changes in its settings, connect to notify::display.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87069,17 +91079,21 @@ changes in its settings, connect to notify::display.
<function name="gtk_widget_get_size">
<description>
-Returns the content width or height of the widget, depending on @orientation.
-This is equivalent to calling gtk_widget_get_width() for %GTK_ORIENTATION_HORIZONTAL
-or gtk_widget_get_height() for %GTK_ORIENTATION_VERTICAL, but can be used when
-writing orientation-independent code, such as when implementing #GtkOrientable
-widgets.
+Returns the content width or height of the widget.
+
+Which dimension is returned depends on @orientation.
+
+This is equivalent to calling [method@Gtk.Widget.get_width]
+for %GTK_ORIENTATION_HORIZONTAL or [method@Gtk.Widget.get_height]
+for %GTK_ORIENTATION_VERTICAL, but can be used when
+writing orientation-independent code, such as when
+implementing [iface@Gtk.Orientable] widgets.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="orientation">
@@ -87094,17 +91108,19 @@ widgets.
<function name="gtk_widget_get_size_request">
<description>
Gets the size request that was explicitly set for the widget using
-gtk_widget_set_size_request(). A value of -1 stored in @width or
-@height indicates that that dimension has not been set explicitly
-and the natural requisition of the widget will be used instead. See
-gtk_widget_set_size_request(). To get the size a widget will
-actually request, call gtk_widget_measure() instead of
+gtk_widget_set_size_request().
+
+A value of -1 stored in @width or @height indicates that that
+dimension has not been set explicitly and the natural requisition
+of the widget will be used instead. See
+[method@Gtk.Widget.set_size_request]. To get the size a widget will
+actually request, call [method@Gtk.Widget.measure] instead of
this function.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="width">
@@ -87121,20 +91137,21 @@ this function.
<function name="gtk_widget_get_state_flags">
<description>
-Returns the widget state as a flag set. It is worth mentioning
-that the effective %GTK_STATE_FLAG_INSENSITIVE state will be
-returned, that is, also based on parent insensitivity, even if
-@widget itself is sensitive.
+Returns the widget state as a flag set.
+
+It is worth mentioning that the effective %GTK_STATE_FLAG_INSENSITIVE
+state will be returned, that is, also based on parent insensitivity,
+even if @widget itself is sensitive.
Also note that if you are looking for a way to obtain the
-#GtkStateFlags to pass to a #GtkStyleContext method, you
-should look at gtk_style_context_get_state().
+[flags@Gtk.StateFlags] to pass to a [class@Gtk.StyleContext]
+method, you should look at [method@Gtk.StyleContext.get_state].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87144,39 +91161,42 @@ should look at gtk_style_context_get_state().
<function name="gtk_widget_get_style_context">
<description>
-Returns the style context associated to @widget. The returned object is
-guaranteed to be the same for the lifetime of @widget.
+Returns the style context associated to @widget.
+
+The returned object is guaranteed to be the same
+for the lifetime of @widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkStyleContext. This memory is owned by @widget and
-must not be freed.
+<return> a `GtkStyleContext`. This memory
+is owned by @widget and must not be freed.
</return>
</function>
<function name="gtk_widget_get_template_child">
<description>
-Fetch an object build from the template XML for @widget_type in this @widget instance.
+Fetch an object build from the template XML for @widget_type in
+this @widget instance.
-This will only report children which were previously declared with
-gtk_widget_class_bind_template_child_full() or one of its
+This will only report children which were previously declared
+with [method@Gtk.WidgetClass.bind_template_child_full] or one of its
variants.
-This function is only meant to be called for code which is private to the @widget_type which
-declared the child and is meant for language bindings which cannot easily make use
-of the GObject structure offsets.
+This function is only meant to be called for code which is private
+to the @widget_type which declared the child and is meant for language
+bindings which cannot easily make use of the GObject structure offsets.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> A #GtkWidget
+<parameter_description> A `GtkWidget`
</parameter_description>
</parameter>
<parameter name="widget_type">
@@ -87188,20 +91208,24 @@ of the GObject structure offsets.
</parameter_description>
</parameter>
</parameters>
-<return> The object built in the template XML with the id @name
+<return> The object built in the template XML with
+the id @name
</return>
</function>
<function name="gtk_widget_get_tooltip_markup">
<description>
-Gets the contents of the tooltip for @widget set using
-gtk_widget_set_tooltip_markup().
+Gets the contents of the tooltip for @widget.
+
+If the tooltip has not been set using
+[method@Gtk.Widget.set_tooltip_markup], this
+function returns %NULL.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87213,14 +91237,15 @@ gtk_widget_set_tooltip_markup().
<description>
Gets the contents of the tooltip for @widget.
-If the @widget's tooltip was set using gtk_widget_set_tooltip_markup(),
+If the @widget's tooltip was set using
+[method@Gtk.Widget.set_tooltip_markup],
this function will return the escaped text.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87230,13 +91255,13 @@ this function will return the escaped text.
<function name="gtk_widget_get_valign">
<description>
-Gets the value of the #GtkWidget:valign property.
+Gets the vertical alignment of @widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87249,7 +91274,7 @@ Gets the value of the #GtkWidget:valign property.
Gets whether the widget would like any available extra vertical
space.
-See gtk_widget_get_hexpand() for more detail.
+See [method@Gtk.Widget.get_hexpand] for more detail.
</description>
@@ -87268,7 +91293,7 @@ See gtk_widget_get_hexpand() for more detail.
Gets whether gtk_widget_set_vexpand() has been used to
explicitly set the expand flag on this widget.
-See gtk_widget_get_hexpand_set() for more detail.
+See [method@Gtk.Widget.get_hexpand_set] for more detail.
</description>
@@ -87284,19 +91309,22 @@ See gtk_widget_get_hexpand_set() for more detail.
<function name="gtk_widget_get_visible">
<description>
-Determines whether the widget is visible. If you want to
-take into account whether the widget’s parent is also marked as
-visible, use gtk_widget_is_visible() instead.
+Determines whether the widget is visible.
-This function does not check if the widget is obscured in any way.
+If you want to take into account whether the widget’s
+parent is also marked as visible, use
+[method@Gtk.Widget.is_visible] instead.
+
+This function does not check if the widget is
+obscured in any way.
-See gtk_widget_set_visible().
+See [method@Gtk.Widget.set_visible].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87306,15 +91334,19 @@ See gtk_widget_set_visible().
<function name="gtk_widget_get_width">
<description>
-Returns the content width of the widget, as passed to its size-allocate implementation.
-This is the size you should be using in GtkWidgetClass.snapshot(). For pointer
-events, see gtk_widget_contains().
+Returns the content width of the widget.
+
+This function returns the size passed to its
+size-allocate implementation, which is the size you
+should be using in GtkWidgetClass.snapshot().
+
+For pointer events, see [method@Gtk.Widget.contains].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87324,21 +91356,20 @@ events, see gtk_widget_contains().
<function name="gtk_widget_grab_focus">
<description>
-Causes @widget (or one of its descendents) to have the keyboard focus
-for the #GtkWindow it's inside.
+Causes @widget to have the keyboard focus for the `GtkWindow` it's inside.
If @widget is not focusable, or its ::grab_focus implementation cannot
transfer the focus to a descendant of @widget that is focusable, it will
not take focus and %FALSE will be returned.
-Calling gtk_widget_grab_focus() on an already focused widget is allowed,
-should not have an effect, and return %TRUE.
+Calling [method@Gtk.Widget.grab_focus] on an already focused widget
+is allowed, should not have an effect, and return %TRUE.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87354,11 +91385,11 @@ Returns whether @css_class is currently applied to @widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="css_class">
-<parameter_description> A CSS style class, without the leading '.'
+<parameter_description> A style class, without the leading '.'
used for notation of style classes
</parameter_description>
</parameter>
@@ -87370,33 +91401,35 @@ used for notation of style classes
<function name="gtk_widget_has_default">
<description>
-Determines whether @widget is the current default widget within its
-toplevel.
+Determines whether @widget is the current default widget
+within its toplevel.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @widget is the current default widget within
-its toplevel, %FALSE otherwise
+<return> %TRUE if @widget is the current default widget
+within its toplevel, %FALSE otherwise
</return>
</function>
<function name="gtk_widget_has_focus">
<description>
-Determines if the widget has the global input focus. See
-gtk_widget_is_focus() for the difference between having the global
-input focus, and only having the focus within a toplevel.
+Determines if the widget has the global input focus.
+
+See [method@Gtk.Widget.is_focus] for the difference between
+having the global input focus, and only having the focus
+within a toplevel.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87407,20 +91440,21 @@ input focus, and only having the focus within a toplevel.
<function name="gtk_widget_has_visible_focus">
<description>
Determines if the widget should show a visible indication that
-it has the global input focus. This is a convenience function
-that takes into account whether focus indication should currently
-be shown in the toplevel window of @widget.
-See gtk_window_get_focus_visible() for more information
-about focus indication.
+it has the global input focus.
+
+This is a convenience function that takes into account whether
+focus indication should currently be shown in the toplevel window
+of @widget. See [method@Gtk.Window.get_focus_visible] for more
+information about focus indication.
To find out if the widget has the global input focus, use
-gtk_widget_has_focus().
+[method@Gtk.Widget.has_focus].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87430,13 +91464,14 @@ gtk_widget_has_focus().
<function name="gtk_widget_hide">
<description>
-Reverses the effects of gtk_widget_show(), causing the widget to be
-hidden (invisible to the user).
+Reverses the effects of gtk_widget_show().
+
+This is causing the widget to be hidden (invisible to the user).
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87446,6 +91481,7 @@ hidden (invisible to the user).
<function name="gtk_widget_in_destruction">
<description>
Returns whether the widget is currently being destroyed.
+
This information can sometimes be used to avoid doing
unnecessary work.
@@ -87453,7 +91489,7 @@ unnecessary work.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87463,27 +91499,31 @@ unnecessary work.
<function name="gtk_widget_init_template">
<description>
-Creates and initializes child widgets defined in templates. This
-function must be called in the instance initializer for any
-class which assigned itself a template using gtk_widget_class_set_template()
+Creates and initializes child widgets defined in templates.
+
+This function must be called in the instance initializer
+for any class which assigned itself a template using
+[method@Gtk.WidgetClass.set_template].
It is important to call this function in the instance initializer
-of a #GtkWidget subclass and not in #GObject.constructed() or
-#GObject.constructor() for two reasons.
+of a `GtkWidget` subclass and not in `GObject.constructed()` or
+`GObject.constructor()` for two reasons:
-One reason is that generally derived widgets will assume that parent
-class composite widgets have been created in their instance
-initializers.
+- derived widgets will assume that the composite widgets
+defined by its parent classes have been created in their
+relative instance initializers
+- when calling `g_object_new()` on a widget with composite templates,
+it’s important to build the composite widgets before the construct
+properties are set. Properties passed to `g_object_new()` should
+take precedence over properties set in the private template XML
-Another reason is that when calling g_object_new() on a widget with
-composite templates, it’s important to build the composite widgets
-before the construct properties are set. Properties passed to g_object_new()
-should take precedence over properties set in the private template XML.
+A good rule of thumb is to call this function as the first thing in
+an instance initialization function.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87492,9 +91532,11 @@ should take precedence over properties set in the private template XML.
<function name="gtk_widget_insert_action_group">
<description>
-Inserts @group into @widget. Children of @widget that implement
-#GtkActionable can then be associated with actions in @group by
-setting their “action-name” to @prefix.`action-name`.
+Inserts @group into @widget.
+
+Children of @widget that implement [iface@Gtk.Actionable] can
+then be associated with actions in @group by setting their
+“action-name” to @prefix.`action-name`.
Note that inheritance is defined for individual actions. I.e.
even if you insert a group with prefix @prefix, actions with
@@ -87507,7 +91549,7 @@ removed from @widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="name">
@@ -87529,11 +91571,12 @@ Inserts @widget into the child widget list of @parent.
It will be placed after @previous_sibling, or at the beginning if
@previous_sibling is %NULL.
-After calling this function, gtk_widget_get_prev_sibling(widget) will
-return @previous_sibling.
+After calling this function, `gtk_widget_get_prev_sibling(widget)`
+will return @previous_sibling.
-If @parent is already set as the parent widget of @widget, this function
-can also be used to reorder @widget in the child widget list of @parent.
+If @parent is already set as the parent widget of @widget, this
+function can also be used to reorder @widget in the child widget
+list of @parent.
This API is primarily meant for widget implementations; if you are
just using a widget, you *must* use its own API for adding children.
@@ -87541,11 +91584,11 @@ just using a widget, you *must* use its own API for adding children.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="parent">
-<parameter_description> the parent #GtkWidget to insert @widget into
+<parameter_description> the parent `GtkWidget` to insert @widget into
</parameter_description>
</parameter>
<parameter name="previous_sibling">
@@ -87563,7 +91606,7 @@ Inserts @widget into the child widget list of @parent.
It will be placed before @next_sibling, or at the end if
@next_sibling is %NULL.
-After calling this function, gtk_widget_get_next_sibling(widget)
+After calling this function, `gtk_widget_get_next_sibling(widget)`
will return @next_sibling.
If @parent is already set as the parent widget of @widget, this function
@@ -87575,11 +91618,11 @@ just using a widget, you *must* use its own API for adding children.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="parent">
-<parameter_description> the parent #GtkWidget to insert @widget into
+<parameter_description> the parent `GtkWidget` to insert @widget into
</parameter_description>
</parameter>
<parameter name="next_sibling">
@@ -87592,18 +91635,18 @@ just using a widget, you *must* use its own API for adding children.
<function name="gtk_widget_is_ancestor">
<description>
-Determines whether @widget is somewhere inside @ancestor, possibly with
-intermediate containers.
+Determines whether @widget is somewhere inside @ancestor,
+possibly with intermediate containers.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="ancestor">
-<parameter_description> another #GtkWidget
+<parameter_description> another `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87614,14 +91657,15 @@ grandchild, great grandchild, etc.
<function name="gtk_widget_is_drawable">
<description>
-Determines whether @widget can be drawn to. A widget can be drawn
-if it is mapped and visible.
+Determines whether @widget can be drawn to.
+
+A widget can be drawn if it is mapped and visible.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87632,15 +91676,18 @@ if it is mapped and visible.
<function name="gtk_widget_is_focus">
<description>
Determines if the widget is the focus widget within its
-toplevel. (This does not mean that the #GtkWidget:has-focus property is
-necessarily set; #GtkWidget:has-focus will only be set if the
-toplevel widget additionally has the global input focus.)
+toplevel.
+
+This does not mean that the [property@Gtk.Widget:has-focus]
+property is necessarily set; [property@Gtk,Widget:has-focus]
+will only be set if the toplevel widget additionally has the
+global input focus.)
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87650,14 +91697,16 @@ toplevel widget additionally has the global input focus.)
<function name="gtk_widget_is_sensitive">
<description>
-Returns the widget’s effective sensitivity, which means
-it is sensitive itself and also its parent widget is sensitive
+Returns the widget’s effective sensitivity.
+
+This means it is sensitive itself and also its
+parent widget is sensitive.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87672,13 +91721,14 @@ visible.
This function does not check if the widget is obscured in any way.
-See also gtk_widget_get_visible() and gtk_widget_set_visible()
+See also [method@Gtk.Widget.get_visible] and
+[method@Gtk.Widget.set_visible].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87688,39 +91738,39 @@ See also gtk_widget_get_visible() and gtk_widget_set_visible()
<function name="gtk_widget_keynav_failed">
<description>
-This function should be called whenever keyboard navigation within
-a single widget hits a boundary. The function emits the
-#GtkWidget::keynav-failed signal on the widget and its return
-value should be interpreted in a way similar to the return value of
-gtk_widget_child_focus():
+Emits the `::keynav-failed` signal on the widget.
-When %TRUE is returned, stay in the widget, the failed keyboard
-navigation is OK and/or there is nowhere we can/should move the
-focus to.
+This function should be called whenever keyboard navigation
+within a single widget hits a boundary.
-When %FALSE is returned, the caller should continue with keyboard
-navigation outside the widget, e.g. by calling
-gtk_widget_child_focus() on the widget’s toplevel.
+The return value of this function should be interpreted
+in a way similar to the return value of
+[method@Gtk.Widget.child_focus]. When %TRUE is returned,
+stay in the widget, the failed keyboard navigation is OK
+and/or there is nowhere we can/should move the focus to.
+When %FALSE is returned, the caller should continue with
+keyboard navigation outside the widget, e.g. by calling
+[method@Gtk.Widget.child_focus] on the widget’s toplevel.
-The default ::keynav-failed handler returns %FALSE for
-%GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other
-values of #GtkDirectionType it returns %TRUE.
+The default [signal@Gtk.Widget::keynav-failed] handler returns
+%FALSE for %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD.
+For the other values of #GtkDirectionType it returns %TRUE.
Whenever the default handler returns %TRUE, it also calls
-gtk_widget_error_bell() to notify the user of the failed keyboard
-navigation.
+[method@Gtk.Widget.error_bell] to notify the user of the
+failed keyboard navigation.
A use case for providing an own implementation of ::keynav-failed
(either by connecting to it or by overriding it) would be a row of
-#GtkEntry widgets where the user should be able to navigate the
-entire row with the cursor keys, as e.g. known from user interfaces
-that require entering license keys.
+[class@Gtk.Entry] widgets where the user should be able to navigate
+the entire row with the cursor keys, as e.g. known from user
+interfaces that require entering license keys.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="direction">
@@ -87736,40 +91786,42 @@ navigation attempt in its parent container(s).
<function name="gtk_widget_list_mnemonic_labels">
<description>
-Returns a newly allocated list of the widgets, normally labels, for
-which this widget is the target of a mnemonic (see for example,
-gtk_label_set_mnemonic_widget()).
+Returns the widgets for which this widget is the target of a
+mnemonic.
+
+Typically, these widgets will be labels. See, for example,
+[method@Gtk.Label.set_mnemonic_widget].
-The widgets in the list are not individually referenced. If you
-want to iterate through the list and perform actions involving
-callbacks that might destroy the widgets, you
-must call `g_list_foreach (result,
-(GFunc)g_object_ref, NULL)` first, and then unref all the
-widgets afterwards.
+The widgets in the list are not individually referenced.
+If you want to iterate through the list and perform actions
+involving callbacks that might destroy the widgets, you
+must call `g_list_foreach (result, (GFunc)g_object_ref, NULL)`
+first, and then unref all the widgets afterwards.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> the list of
-mnemonic labels; free this list
-with g_list_free() when you are done with it.
+<return> the list
+of mnemonic labels; free this list with g_list_free() when you
+are done with it.
</return>
</function>
<function name="gtk_widget_map">
<description>
-This function is only for use in widget implementations. Causes
-a widget to be mapped if it isn’t already.
+Causes a widget to be mapped if it isn’t already.
+
+This function is only for use in widget implementations.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -87779,11 +91831,12 @@ a widget to be mapped if it isn’t already.
<function name="gtk_widget_measure">
<description>
Measures @widget in the orientation @orientation and for the given @for_size.
-As an example, if @orientation is %GTK_ORIENTATION_HORIZONTAL and @for_size is 300,
-this functions will compute the minimum and natural width of @widget if
-it is allocated at a height of 300 pixels.
-See [GtkWidget’s geometry management section][geometry-management] for
+As an example, if @orientation is %GTK_ORIENTATION_HORIZONTAL and @for_size
+is 300, this functions will compute the minimum and natural width of @widget
+if it is allocated at a height of 300 pixels.
+
+See [GtkWidget’s geometry management section](class.Widget.html#height-for-width-geometry-management) for
a more details on implementing #GtkWidgetClass.measure().
</description>
@@ -87828,13 +91881,13 @@ position for the natural size, or %NULL
<function name="gtk_widget_mnemonic_activate">
<description>
-Emits the #GtkWidget::mnemonic-activate signal.
+Emits the `GtkWidget`::mnemonic-activate signal.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="group_cycling">
@@ -87848,62 +91901,62 @@ Emits the #GtkWidget::mnemonic-activate signal.
<function name="gtk_widget_observe_children">
<description>
-Returns a #GListModel to track the children of @widget.
+Returns a `GListModel` to track the children of @widget.
-Calling this function will enable extra internal bookkeeping to track
-children and emit signals on the returned listmodel. It may slow down
-operations a lot.
+Calling this function will enable extra internal bookkeeping
+to track children and emit signals on the returned listmodel.
+It may slow down operations a lot.
-Applications should try hard to avoid calling this function because of
-the slowdowns.
+Applications should try hard to avoid calling this function
+because of the slowdowns.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> a #GListModel
-tracking @widget's children
+<return>
+a `GListModel` tracking @widget's children
</return>
</function>
<function name="gtk_widget_observe_controllers">
<description>
-Returns a #GListModel to track the #GtkEventControllers of @widget.
+Returns a `GListModel` to track the [class@Gtk.EventController]s
+of @widget.
-Calling this function will enable extra internal bookkeeping to track
-controllers and emit signals on the returned listmodel. It may slow down
-operations a lot.
+Calling this function will enable extra internal bookkeeping
+to track controllers and emit signals on the returned listmodel.
+It may slow down operations a lot.
-Applications should try hard to avoid calling this function because of
-the slowdowns.
+Applications should try hard to avoid calling this function
+because of the slowdowns.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
-<return> a
-#GListModel tracking @widget's controllers
+<return>
+a `GListModel` tracking @widget's controllers
</return>
</function>
<function name="gtk_widget_paintable_get_widget">
<description>
-Returns the widget that is observed or %NULL
-if none.
+Returns the widget that is observed or %NULL if none.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkWidgetPaintable
+<parameter_description> a `GtkWidgetPaintable`
</parameter_description>
</parameter>
</parameters>
@@ -87919,11 +91972,11 @@ Creates a new widget paintable observing the given widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget or %NULL
+<parameter_description> a `GtkWidget` or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkWidgetPaintable
+<return> a new `GtkWidgetPaintable`
</return>
</function>
@@ -87934,7 +91987,7 @@ Sets the widget that should be observed.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkWidgetPaintable
+<parameter_description> a `GtkWidgetPaintable`
</parameter_description>
</parameter>
<parameter name="widget">
@@ -87947,18 +92000,21 @@ Sets the widget that should be observed.
<function name="gtk_widget_pick">
<description>
-Finds the descendant of @widget (including @widget itself) closest
-to the screen at the point (@x, @y). The point must be given in
-widget coordinates, so (0, 0) is assumed to be the top left of
-@widget's content area.
+Finds the descendant of @widget closest
+to the screen at the point (@x, @y).
+
+The point must be given in widget coordinates, so (0, 0) is assumed
+to be the top left of @widget's content area.
Usually widgets will return %NULL if the given coordinate is not
-contained in @widget checked via gtk_widget_contains(). Otherwise
-they will recursively try to find a child that does not return %NULL.
-Widgets are however free to customize their picking algorithm.
+contained in @widget checked via [method@Gtk.Widget.contains].
+Otherwise they will recursively try to find a child that does
+not return %NULL. Widgets are however free to customize their
+picking algorithm.
-This function is used on the toplevel to determine the widget below
-the mouse cursor for purposes of hover highlighting and delivering events.
+This function is used on the toplevel to determine the widget
+below the mouse cursor for purposes of hover highlighting and
+delivering events.
</description>
@@ -87980,26 +92036,28 @@ the mouse cursor for purposes of hover highlighting and delivering events.
</parameter_description>
</parameter>
</parameters>
-<return> The widget descendant at the given
-coordinate or %NULL if none.
+<return> The widget descendant at
+the given coordinate or %NULL if none.
</return>
</function>
<function name="gtk_widget_queue_allocate">
<description>
-This function is only for use in widget implementations.
-
Flags the widget for a rerun of the GtkWidgetClass::size_allocate
-function. Use this function instead of gtk_widget_queue_resize()
+function.
+
+Use this function instead of [method@Gtk.Widget.queue_resize]
when the @widget's size request didn't change but it wants to
reposition its contents.
-An example user of this function is gtk_widget_set_halign().
+An example user of this function is [method@Gtk.Widget.set_halign].
+
+This function is only for use in widget implementations.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -88008,16 +92066,17 @@ An example user of this function is gtk_widget_set_halign().
<function name="gtk_widget_queue_compute_expand">
<description>
-Mark @widget as needing to recompute its expand flags. Call
-this function when setting legacy expand child properties
-on the child of a container.
+Mark @widget as needing to recompute its expand flags.
-See gtk_widget_compute_expand().
+Call this function when setting legacy expand child
+properties on the child of a container.
+
+See [method@Gtk.Widget.compute_expand].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -88027,13 +92086,15 @@ See gtk_widget_compute_expand().
<function name="gtk_widget_queue_draw">
<description>
Schedules this widget to be redrawn in paint phase of the
-current or the next frame. This means @widget's GtkWidgetClass.snapshot()
+current or the next frame.
+
+This means @widget's GtkWidgetClass.snapshot()
implementation will be called.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -88042,21 +92103,24 @@ implementation will be called.
<function name="gtk_widget_queue_resize">
<description>
-This function is only for use in widget implementations.
-Flags a widget to have its size renegotiated; should
-be called when a widget for some reason has a new size request.
-For example, when you change the text in a #GtkLabel, #GtkLabel
-queues a resize to ensure there’s enough space for the new text.
+Flags a widget to have its size renegotiated.
+
+This should be called when a widget for some reason has a new
+size request. For example, when you change the text in a
+[class@Gtk.Label], the label queues a resize to ensure there’s
+enough space for the new text.
Note that you cannot call gtk_widget_queue_resize() on a widget
-from inside its implementation of the GtkWidgetClass::size_allocate
+from inside its implementation of the GtkWidgetClass::size_allocate
virtual method. Calls to gtk_widget_queue_resize() from inside
GtkWidgetClass::size_allocate will be silently ignored.
+This function is only for use in widget implementations.
+
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -88065,27 +92129,27 @@ GtkWidgetClass::size_allocate will be silently ignored.
<function name="gtk_widget_realize">
<description>
-Creates the GDK (windowing system) resources associated with a
-widget. Normally realization happens implicitly; if you show
-a widget and all its parent containers, then the widget will be
-realized and mapped automatically.
+Creates the GDK resources associated with a widget.
+
+Normally realization happens implicitly; if you show a widget
+and all its parent containers, then the widget will be realized
+and mapped automatically.
-Realizing a widget requires all
-the widget’s parent widgets to be realized; calling
-gtk_widget_realize() realizes the widget’s parents in addition to
-@widget itself. If a widget is not yet inside a toplevel window
-when you realize it, bad things will happen.
+Realizing a widget requires all the widget’s parent widgets to be
+realized; calling this function realizes the widget’s parents
+in addition to @widget itself. If a widget is not yet inside a
+toplevel window when you realize it, bad things will happen.
This function is primarily used in widget implementations, and
isn’t very useful otherwise. Many times when you think you might
need it, a better approach is to connect to a signal that will be
called after the widget is realized automatically, such as
-#GtkWidget::realize.
+[signal@Gtk.Widget::realize].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -88095,7 +92159,9 @@ called after the widget is realized automatically, such as
<function name="gtk_widget_remove_controller">
<description>
Removes @controller from @widget, so that it doesn't process
-events anymore. It should not be used again.
+events anymore.
+
+It should not be used again.
Widgets will remove all event controllers automatically when they
are destroyed, there is normally no need to call this function.
@@ -88103,7 +92169,7 @@ are destroyed, there is normally no need to call this function.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="controller">
@@ -88116,13 +92182,14 @@ are destroyed, there is normally no need to call this function.
<function name="gtk_widget_remove_css_class">
<description>
-Removes @css_class from @widget. After this, the style of @widget
-will stop matching for @css_class.
+Removes a style from @widget.
+
+After this, the style of @widget will stop matching for @css_class.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="css_class">
@@ -88136,20 +92203,21 @@ the leading '.' used for notation of style classes
<function name="gtk_widget_remove_mnemonic_label">
<description>
-Removes a widget from the list of mnemonic labels for
-this widget. (See gtk_widget_list_mnemonic_labels()). The widget
-must have previously been added to the list with
-gtk_widget_add_mnemonic_label().
+Removes a widget from the list of mnemonic labels for this widget.
+
+See [method@Gtk.Widget.list_mnemonic_labels]. The widget must
+have previously been added to the list with
+[method@Gtk.Widget.add_mnemonic_label].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="label">
-<parameter_description> a #GtkWidget that was previously set as a mnemonic label for
-@widget with gtk_widget_add_mnemonic_label().
+<parameter_description> a `GtkWidget` that was previously set as a mnemonic
+label for @widget with [method@Gtk.Widget.add_mnemonic_label]
</parameter_description>
</parameter>
</parameters>
@@ -88164,11 +92232,11 @@ gtk_widget_add_surface_transform_changed_callback().
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="id">
-<parameter_description> an id returned by gtk_widget_add_surface_transform_changed_callback()
+<parameter_description> an id returned by [method@Gtk.Widget.add_surface_transform_changed_callback]
</parameter_description>
</parameter>
</parameters>
@@ -88183,11 +92251,11 @@ gtk_widget_add_tick_callback().
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="id">
-<parameter_description> an id returned by gtk_widget_add_tick_callback()
+<parameter_description> an id returned by [method@Gtk.Widget.add_tick_callback]
</parameter_description>
</parameter>
</parameters>
@@ -88208,13 +92276,13 @@ also be sensitive and focusable and not have an ancestor
that is marked as not can-focus in order to receive input
focus.
-See gtk_widget_grab_focus() for actually setting the input
-focus on a widget.
+See [method@Gtk.Widget.grab_focus] for actually setting
+the input focus on a widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="can_focus">
@@ -88233,11 +92301,12 @@ Sets whether @widget can be the target of pointer events.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="can_target">
-<parameter_description> whether this widget should be able to receive pointer events
+<parameter_description> whether this widget should be able to
+receive pointer events
</parameter_description>
</parameter>
</parameters>
@@ -88246,14 +92315,13 @@ Sets whether @widget can be the target of pointer events.
<function name="gtk_widget_set_child_visible">
<description>
-Sets whether @widget should be mapped along with its when its parent
-is mapped and @widget has been shown with gtk_widget_show().
+Sets whether @widget should be mapped along with its parent.
-The child visibility can be set for widget before it is added to
-a container with gtk_widget_set_parent(), to avoid mapping
-children unnecessary before immediately unmapping them. However
-it will be reset to its default state of %TRUE when the widget
-is removed from a container.
+The child visibility can be set for widget before it is added
+to a container with [method@Gtk.Widget.set_parent], to avoid
+mapping children unnecessary before immediately unmapping them.
+However it will be reset to its default state of %TRUE when the
+widget is removed from a container.
Note that changing the child visibility of a widget does not
queue a resize on the widget. Most of the time, the size of
@@ -88261,17 +92329,18 @@ a widget is computed from all visible children, whether or
not they are mapped. If this is not the case, the container
can queue a resize itself.
-This function is only useful for container implementations and
-never should be called by an application.
+This function is only useful for container implementations
+and should never be called by an application.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="child_visible">
-<parameter_description> if %TRUE, @widget should be mapped along with its parent.
+<parameter_description> if %TRUE, @widget should be mapped along
+with its parent.
</parameter_description>
</parameter>
</parameters>
@@ -88280,18 +92349,18 @@ never should be called by an application.
<function name="gtk_widget_set_css_classes">
<description>
-Will clear all css classes applied to @widget
+Will clear all style classes applied to @widget
and replace them with @classes.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="classes">
-<parameter_description> %NULL-terminated list
-of css classes to apply to @widget.
+<parameter_description>
+%NULL-terminated list of style classes to apply to @widget.
</parameter_description>
</parameter>
</parameters>
@@ -88300,20 +92369,21 @@ of css classes to apply to @widget.
<function name="gtk_widget_set_cursor">
<description>
-Sets the cursor to be shown when pointer devices point towards @widget.
+Sets the cursor to be shown when pointer devices point
+towards @widget.
-If the @cursor is NULL, @widget will use the cursor inherited from the
-parent widget.
+If the @cursor is NULL, @widget will use the cursor
+inherited from the parent widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="cursor">
-<parameter_description> the new cursor or %NULL to use the default
-cursor
+<parameter_description> the new cursor or %NULL to use
+the default cursor
</parameter_description>
</parameter>
</parameters>
@@ -88322,24 +92392,27 @@ cursor
<function name="gtk_widget_set_cursor_from_name">
<description>
-Sets a named cursor to be shown when pointer devices point towards @widget.
+Sets a named cursor to be shown when pointer devices point
+towards @widget.
This is a utility function that creates a cursor via
-gdk_cursor_new_from_name() and then sets it on @widget with
-gtk_widget_set_cursor(). See those 2 functions for details.
+[ctor@Gdk.Cursor.new_from_name] and then sets it on @widget
+with [method@Gtk.Widget.set_cursor]. See those functions for
+details.
-On top of that, this function allows @name to be %NULL, which will
-do the same as calling gtk_widget_set_cursor() with a %NULL cursor.
+On top of that, this function allows @name to be %NULL, which
+will do the same as calling [method@Gtk.Widget.set_cursor]
+with a %NULL cursor.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="name">
-<parameter_description> The name of the cursor or %NULL to use the default
-cursor
+<parameter_description> The name of the cursor or %NULL to use
+the default cursor
</parameter_description>
</parameter>
</parameters>
@@ -88348,14 +92421,14 @@ cursor
<function name="gtk_widget_set_default_direction">
<description>
-Sets the default reading direction for widgets where the
-direction has not been explicitly set by gtk_widget_set_direction().
+Sets the default reading direction for widgets.
+
+See [method@Gtk.Widget.set_direction].
</description>
<parameters>
<parameter name="dir">
-<parameter_description> the new default direction. This cannot be
-%GTK_TEXT_DIR_NONE.
+<parameter_description> the new default direction. This cannot be %GTK_TEXT_DIR_NONE.
</parameter_description>
</parameter>
</parameters>
@@ -88364,27 +92437,28 @@ direction has not been explicitly set by gtk_widget_set_direction().
<function name="gtk_widget_set_direction">
<description>
-Sets the reading direction on a particular widget. This direction
-controls the primary direction for widgets containing text,
-and also the direction in which the children of a container are
-packed. The ability to set the direction is present in order
-so that correct localization into languages with right-to-left
-reading directions can be done. Generally, applications will
-let the default reading direction present, except for containers
+Sets the reading direction on a particular widget.
+
+This direction controls the primary direction for widgets
+containing text, and also the direction in which the children
+of a container are packed. The ability to set the direction is
+present in order so that correct localization into languages with
+right-to-left reading directions can be done. Generally, applications
+will let the default reading direction present, except for containers
where the containers are arranged in an order that is explicitly
visual rather than logical (such as buttons for text justification).
If the direction is set to %GTK_TEXT_DIR_NONE, then the value
-set by gtk_widget_set_default_direction() will be used.
+set by [func@Gtk.Widget.set_default_direction] will be used.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="dir">
-<parameter_description> the new direction
+<parameter_description> the new direction
</parameter_description>
</parameter>
</parameters>
@@ -88393,17 +92467,18 @@ set by gtk_widget_set_default_direction() will be used.
<function name="gtk_widget_set_focus_child">
<description>
-Set @child as the current focus child of @widget. The previous
-focus child will be unset.
+Set @child as the current focus child of @widget.
+
+The previous focus child will be unset.
This function is only suitable for widget implementations.
If you want a certain widget to get the input focus, call
-gtk_widget_grab_focus() on it.
+[method@Gtk.Widget.grab_focus] on it.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="child">
@@ -88417,19 +92492,22 @@ to unset the focus child of @widget
<function name="gtk_widget_set_focus_on_click">
<description>
-Sets whether the widget should grab focus when it is clicked with the mouse.
-Making mouse clicks not grab focus is useful in places like toolbars where
-you don’t want the keyboard focus removed from the main area of the
-application.
+Sets whether the widget should grab focus when it is clicked
+with the mouse.
+
+Making mouse clicks not grab focus is useful in places like
+toolbars where you don’t want the keyboard focus removed from
+the main area of the application.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="focus_on_click">
-<parameter_description> whether the widget should grab focus when clicked with the mouse
+<parameter_description> whether the widget should grab focus when clicked
+with the mouse
</parameter_description>
</parameter>
</parameters>
@@ -88449,13 +92527,13 @@ also be sensitive and can-focus and not have an ancestor
that is marked as not can-focus in order to receive input
focus.
-See gtk_widget_grab_focus() for actually setting the input
-focus on a widget.
+See [method@Gtk.Widget.grab_focus] for actually setting
+the input focus on a widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="focusable">
@@ -88468,22 +92546,24 @@ focus on a widget.
<function name="gtk_widget_set_font_map">
<description>
-Sets the font map to use for Pango rendering. The font map is the
-object that is used to look up fonts. Setting a custom font map
-can be useful in special situations, e.g. when you need to add
-application-specific fonts to the set of available fonts.
+Sets the font map to use for Pango rendering.
+
+The font map is the object that is used to look up fonts.
+Setting a custom font map can be useful in special situations,
+e.g. when you need to add application-specific fonts to the set
+of available fonts.
When not set, the widget will inherit the font map from its parent.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="font_map">
-<parameter_description> a #PangoFontMap, or %NULL to unset any previously
-set font map
+<parameter_description> a `PangoFontMap`, or %NULL to unset any
+previously set font map
</parameter_description>
</parameter>
</parameters>
@@ -88492,18 +92572,21 @@ set font map
<function name="gtk_widget_set_font_options">
<description>
-Sets the #cairo_font_options_t used for Pango rendering in this widget.
-When not set, the default font options for the #GdkDisplay will be used.
+Sets the `cairo_font_options_t` used for Pango rendering
+in this widget.
+
+When not set, the default font options for the `GdkDisplay`
+will be used.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="options">
-<parameter_description> a #cairo_font_options_t, or %NULL to unset any
-previously set default font options.
+<parameter_description> a #cairo_font_options_t, or %NULL
+to unset any previously set default font options.
</parameter_description>
</parameter>
</parameters>
@@ -88513,12 +92596,11 @@ previously set default font options.
<function name="gtk_widget_set_halign">
<description>
Sets the horizontal alignment of @widget.
-See the #GtkWidget:halign property.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="align">
@@ -88531,13 +92613,12 @@ See the #GtkWidget:halign property.
<function name="gtk_widget_set_has_tooltip">
<description>
-Sets the has-tooltip property on @widget to @has_tooltip. See
-#GtkWidget:has-tooltip for more information.
+Sets the `has-tooltip` property on @widget to @has_tooltip.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="has_tooltip">
@@ -88551,7 +92632,9 @@ Sets the has-tooltip property on @widget to @has_tooltip. See
<function name="gtk_widget_set_hexpand">
<description>
Sets whether the widget would like any available extra horizontal
-space. When a user resizes a #GtkWindow, widgets with expand=TRUE
+space.
+
+When a user resizes a `GtkWindow`, widgets with expand=TRUE
generally receive the extra space. For example, a list or
scrollable area or document in your window would often be set to
expand.
@@ -88562,18 +92645,18 @@ room.
By default, widgets automatically expand if any of their children
want to expand. (To see if a widget will automatically expand given
-its current children and state, call gtk_widget_compute_expand(). A
-container can decide how the expandability of children affects the
+its current children and state, call [method@Gtk.Widget.compute_expand].
+A container can decide how the expandability of children affects the
expansion of the container by overriding the compute_expand virtual
-method on #GtkWidget.).
+method on `GtkWidget`.).
Setting hexpand explicitly with this function will override the
automatic expand behavior.
This function forces the widget to expand or not to expand,
regardless of children. The override occurs because
-gtk_widget_set_hexpand() sets the hexpand-set property (see
-gtk_widget_set_hexpand_set()) which causes the widget’s hexpand
+[method@Gtk.Widget.set_hexpand] sets the hexpand-set property (see
+[method@Gtk.Widget.set_hexpand_set]) which causes the widget’s hexpand
value to be used, rather than looking at children and widget state.
</description>
@@ -88592,13 +92675,12 @@ value to be used, rather than looking at children and widget state.
<function name="gtk_widget_set_hexpand_set">
<description>
-Sets whether the hexpand flag (see gtk_widget_get_hexpand()) will
-be used.
+Sets whether the hexpand flag will be used.
-The hexpand-set property will be set automatically when you call
-gtk_widget_set_hexpand() to set hexpand, so the most likely
-reason to use this function would be to unset an explicit expand
-flag.
+The [property@Gtk.Widget:hexpand-set] property will be set
+automatically when you call [method@Gtk.Widget.set_hexpand]
+to set hexpand, so the most likely reason to use this function
+would be to unset an explicit expand flag.
If hexpand is set, then it overrides any computed
expand value based on child widgets. If hexpand is not
@@ -88624,17 +92706,18 @@ for completeness and consistency.
<function name="gtk_widget_set_layout_manager">
<description>
-Sets the layout manager delegate instance that provides an implementation
-for measuring and allocating the children of @widget.
+Sets the layout manager delegate instance that
+provides an implementation for measuring and
+allocating the children of @widget.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="layout_manager">
-<parameter_description> a #GtkLayoutManager
+<parameter_description> a `GtkLayoutManager`
</parameter_description>
</parameter>
</parameters>
@@ -88644,12 +92727,11 @@ for measuring and allocating the children of @widget.
<function name="gtk_widget_set_margin_bottom">
<description>
Sets the bottom margin of @widget.
-See the #GtkWidget:margin-bottom property.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="margin">
@@ -88663,12 +92745,11 @@ See the #GtkWidget:margin-bottom property.
<function name="gtk_widget_set_margin_end">
<description>
Sets the end margin of @widget.
-See the #GtkWidget:margin-end property.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="margin">
@@ -88682,12 +92763,11 @@ See the #GtkWidget:margin-end property.
<function name="gtk_widget_set_margin_start">
<description>
Sets the start margin of @widget.
-See the #GtkWidget:margin-start property.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="margin">
@@ -88701,12 +92781,11 @@ See the #GtkWidget:margin-start property.
<function name="gtk_widget_set_margin_top">
<description>
Sets the top margin of @widget.
-See the #GtkWidget:margin-top property.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="margin">
@@ -88719,10 +92798,12 @@ See the #GtkWidget:margin-top property.
<function name="gtk_widget_set_name">
<description>
-Widgets can be named, which allows you to refer to them from a
+Sets a widgets name.
+
+Setting a name allows you to refer to the widget from a
CSS file. You can apply a style to widgets with a particular name
in the CSS file. See the documentation for the CSS syntax (on the
-same page as the docs for #GtkStyleContext).
+same page as the docs for [class@Gtk.StyleContext].
Note that the CSS syntax has certain special characters to delimit
and represent elements in a selector (period, #, >, *...), so using
@@ -88732,7 +92813,7 @@ of alphanumeric symbols, dashes and underscores will suffice.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="name">
@@ -88745,9 +92826,10 @@ of alphanumeric symbols, dashes and underscores will suffice.
<function name="gtk_widget_set_opacity">
<description>
-Request the @widget to be rendered partially transparent, with
-opacity 0 being fully transparent and 1 fully opaque. (Opacity
-values are clamped to the [0,1] range).
+Request the @widget to be rendered partially transparent.
+
+An opacity of 0 is fully transparent and an opacity of 1
+is fully opaque.
Opacity works on both toplevel widgets and child widgets, although
there are some limitations: For toplevel widgets, applying opacity
@@ -88762,15 +92844,15 @@ a toplevel to be partially translucent, all of its content will
appear translucent, since it is ultimatively rendered on that
toplevel. The opacity value itself is not inherited by child
widgets (since that would make widgets deeper in the hierarchy
-progressively more translucent). As a consequence, #GtkPopovers
-and other #GtkNative widgets with their own surface will use their
+progressively more translucent). As a consequence, [class@Gtk.Popover]s
+and other [class@Gtk.Native] widgets with their own surface will use their
own opacity value, and thus by default appear non-translucent,
even if they are attached to a toplevel that is translucent.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="opacity">
@@ -88783,18 +92865,20 @@ even if they are attached to a toplevel that is translucent.
<function name="gtk_widget_set_overflow">
<description>
-Sets how @widget treats content that is drawn outside the widget's content area.
-See the definition of #GtkOverflow for details.
+Sets how @widget treats content that is drawn outside the
+widget's content area.
-This setting is provided for widget implementations and should not be used by
-application code.
+See the definition of [enum@Gtk.Overflow] for details.
+
+This setting is provided for widget implementations and
+should not be used by application code.
The default value is %GTK_OVERFLOW_VISIBLE.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="overflow">
@@ -88807,18 +92891,19 @@ The default value is %GTK_OVERFLOW_VISIBLE.
<function name="gtk_widget_set_parent">
<description>
-This function is useful only when implementing subclasses of
-#GtkWidget.
+Sets @parent as the parent widget of @widget.
+
+This takes care of details such as updating the state and style
+of the child to reflect its new location and resizing the parent.
+The opposite function is [method@Gtk.Widget.unparent].
-Sets @parent as the parent widget of @widget, and takes care of
-some details such as updating the state and style of the child
-to reflect its new location and resizing the parent. The opposite
-function is gtk_widget_unparent().
+This function is useful only when implementing subclasses of
+`GtkWidget`.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="parent">
@@ -88838,7 +92923,7 @@ another widget is the default.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="receives_default">
@@ -88851,15 +92936,17 @@ another widget is the default.
<function name="gtk_widget_set_sensitive">
<description>
-Sets the sensitivity of a widget. A widget is sensitive if the user
-can interact with it. Insensitive widgets are “grayed out” and the
-user can’t interact with them. Insensitive widgets are known as
+Sets the sensitivity of a widget.
+
+A widget is sensitive if the user can interact with it.
+Insensitive widgets are “grayed out” and the user can’t
+interact with them. Insensitive widgets are known as
“inactive”, “disabled”, or “ghosted” in some other toolkits.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="sensitive">
@@ -88872,16 +92959,17 @@ user can’t interact with them. Insensitive widgets are known as
<function name="gtk_widget_set_size_request">
<description>
-Sets the minimum size of a widget; that is, the widget’s size
-request will be at least @width by @height. You can use this
-function to force a widget to be larger than it normally would be.
+Sets the minimum size of a widget.
+
+That is, the widget’s size request will be at least @width
+by @height. You can use this function to force a widget to
+be larger than it normally would be.
-In most cases, gtk_window_set_default_size() is a better choice for
-toplevel windows than this function; setting the default size will
-still allow users to shrink the window. Setting the size request
-will force them to leave the window at least as large as the size
-request. When dealing with window sizes,
-gtk_window_set_geometry_hints() can be a useful function as well.
+In most cases, [method@Gtk.Window.set_default_size] is a better
+choice for toplevel windows than this function; setting the default
+size will still allow users to shrink the window. Setting the size
+request will force them to leave the window at least as large as
+the size request.
Note the inherent danger of setting any fixed size - themes,
translations into other languages, different fonts, and user action
@@ -88899,14 +92987,18 @@ If the size request in a given direction is -1 (unset), then
the “natural” size request of the widget will be used instead.
The size request set here does not include any margin from the
-#GtkWidget properties margin-left, margin-right, margin-top, and
-margin-bottom, but it does include pretty much all other padding
-or border properties set by any subclass of #GtkWidget.
+properties
+[property@Gtk.Widget:margin-start],
+[property@Gtk.Widget:margin-end],
+[property@Gtk.Widget:margin-top], and
+[property@Gtk.Widget:margin-bottom], but it does include pretty
+much all other padding or border properties set by any subclass
+of `GtkWidget`.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="width">
@@ -88923,17 +93015,20 @@ or border properties set by any subclass of #GtkWidget.
<function name="gtk_widget_set_state_flags">
<description>
-This function is for use in widget implementations. Turns on flag
-values in the current widget state (insensitive, prelighted, etc.).
+Turns on flag values in the current widget state.
+
+Typical widget states are insensitive, prelighted, etc.
This function accepts the values %GTK_STATE_FLAG_DIR_LTR and
%GTK_STATE_FLAG_DIR_RTL but ignores them. If you want to set
-the widget's direction, use gtk_widget_set_direction().
+the widget's direction, use [method@Gtk.Widget.set_direction].
+
+This function is for use in widget implementations.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="flags">
@@ -88950,19 +93045,19 @@ the widget's direction, use gtk_widget_set_direction().
<function name="gtk_widget_set_tooltip_markup">
<description>
-Sets @markup as the contents of the tooltip, which is marked up with
-the [Pango text markup language][PangoMarkupFormat].
+Sets @markup as the contents of the tooltip, which is marked
+up with Pango markup.
-This function will take care of setting the #GtkWidget:has-tooltip as
-a side effect, and of the default handler for the #GtkWidget::query-tooltip signal.
+This function will take care of setting the
+[property@Gtk.Widget:has-tooltip] as a side effect, and of the
+default handler for the [signal@Gtk.Widget::query-tooltip] signal.
-See also the #GtkWidget:tooltip-markup property and
-gtk_tooltip_set_markup().
+See also [method@Gtk.Tooltip.set_markup].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="markup">
@@ -88979,17 +93074,17 @@ Sets @text as the contents of the tooltip.
If @text contains any markup, it will be escaped.
-This function will take care of setting #GtkWidget:has-tooltip
-as a side effect, and of the default handler for the
-#GtkWidget::query-tooltip signal.
+This function will take care of setting
+[property@Gtk.Widget:has-tooltip] as a side effect,
+and of the default handler for the
+[signal@Gtk.Widget::query-tooltip] signal.
-See also the #GtkWidget:tooltip-text property and
-gtk_tooltip_set_text().
+See also [method@Gtk.Tooltip.set_text].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="text">
@@ -89003,12 +93098,11 @@ gtk_tooltip_set_text().
<function name="gtk_widget_set_valign">
<description>
Sets the vertical alignment of @widget.
-See the #GtkWidget:valign property.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="align">
@@ -89024,7 +93118,7 @@ See the #GtkWidget:valign property.
Sets whether the widget would like any available extra vertical
space.
-See gtk_widget_set_hexpand() for more detail.
+See [method@Gtk.Widget.set_hexpand] for more detail.
</description>
<parameters>
@@ -89042,10 +93136,9 @@ See gtk_widget_set_hexpand() for more detail.
<function name="gtk_widget_set_vexpand_set">
<description>
-Sets whether the vexpand flag (see gtk_widget_get_vexpand()) will
-be used.
+Sets whether the vexpand flag will be used.
-See gtk_widget_set_hexpand_set() for more detail.
+See [method@Gtk.Widget.set_hexpand_set] for more detail.
</description>
<parameters>
@@ -89063,18 +93156,19 @@ See gtk_widget_set_hexpand_set() for more detail.
<function name="gtk_widget_set_visible">
<description>
-Sets the visibility state of @widget. Note that setting this to
-%TRUE doesn’t mean the widget is actually viewable, see
-gtk_widget_get_visible().
+Sets the visibility state of @widget.
+
+Note that setting this to %TRUE doesn’t mean the widget is
+actually viewable, see [method@Gtk.Widget.get_visible].
-This function simply calls gtk_widget_show() or gtk_widget_hide()
-but is nicer to use when the visibility of the widget depends on
-some condition.
+This function simply calls [method Gtk Widget show] or
+[method Gtk Widget hide] but is nicer to use when the
+visibility of the widget depends on some condition.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="visible">
@@ -89089,6 +93183,7 @@ some condition.
<description>
Returns whether @widget should contribute to
the measuring and allocation of its parent.
+
This is %FALSE for invisible children, but also
for children that have their own surface.
@@ -89107,8 +93202,9 @@ measuring and allocating
<function name="gtk_widget_show">
<description>
-Flags a widget to be displayed. Any widget that isn’t shown will
-not appear on the screen.
+Flags a widget to be displayed.
+
+Any widget that isn’t shown will not appear on the screen.
Remember that you have to show the containers containing a widget,
in addition to the widget itself, before it will appear onscreen.
@@ -89120,7 +93216,7 @@ toplevel container is realized and mapped.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -89129,13 +93225,15 @@ toplevel container is realized and mapped.
<function name="gtk_widget_size_allocate">
<description>
-This is a simple form of gtk_widget_allocate() that takes the new position
-of @widget as part of @allocation.
+Allocates widget with a transformation that translates
+the origin to the position in @allocation.
+
+This is a simple form of [method@Gtk.Widget.allocate].
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="allocation">
@@ -89152,22 +93250,25 @@ of @widget as part of @allocation.
<function name="gtk_widget_snapshot_child">
<description>
-When a widget receives a call to the snapshot function, it must send
-synthetic #GtkWidgetClass.snapshot() calls to all children. This function
-provides a convenient way of doing this. A widget, when it receives
-a call to its #GtkWidgetClass.snapshot() function, calls
+Snapshot the a child of @widget.
+
+When a widget receives a call to the snapshot function,
+it must send synthetic `GtkWidget`Class.snapshot() calls
+to all children. This function provides a convenient way
+of doing this. A widget, when it receives a call to its
+`GtkWidget`Class.snapshot() function, calls
gtk_widget_snapshot_child() once for each child, passing in
the @snapshot the widget received.
gtk_widget_snapshot_child() takes care of translating the origin of
@snapshot, and deciding whether the child needs to be snapshot.
-This function does nothing for children that implement #GtkNative.
+This function does nothing for children that implement `GtkNative`.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="child">
@@ -89186,19 +93287,21 @@ have been made.
<function name="gtk_widget_translate_coordinates">
<description>
-Translate coordinates relative to @src_widget’s allocation to coordinates
-relative to @dest_widget’s allocations. In order to perform this
-operation, both widget must share a common toplevel.
+Translate coordinates relative to @src_widget’s allocation
+to coordinates relative to @dest_widget’s allocations.
+
+In order to perform this operation, both widget must share
+a common ancestor.
</description>
<parameters>
<parameter name="src_widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="dest_widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="src_x">
@@ -89219,8 +93322,8 @@ operation, both widget must share a common toplevel.
</parameter>
</parameters>
<return> %FALSE if @src_widget and @dest_widget have no common
-ancestor. In this case, 0 is stored in
-*@dest_x and *@dest_y. Otherwise %TRUE.
+ancestor. In this case, 0 is stored in *@dest_x and *@dest_y.
+Otherwise %TRUE.
</return>
</function>
@@ -89232,7 +93335,7 @@ of @widget is located.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -89241,13 +93344,14 @@ of @widget is located.
<function name="gtk_widget_unmap">
<description>
-This function is only for use in widget implementations. Causes
-a widget to be unmapped if it’s currently mapped.
+Causes a widget to be unmapped if it’s currently mapped.
+
+This function is only for use in widget implementations.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -89256,14 +93360,15 @@ a widget to be unmapped if it’s currently mapped.
<function name="gtk_widget_unparent">
<description>
-This function is only for use in widget implementations.
-It should be called by parent widgets to dissociate @widget
-from the parent, typically in dispose.
+Dissociate @widget from its parent.
+
+This function is only for use in widget implementations,
+typically in dispose.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -89272,14 +93377,15 @@ from the parent, typically in dispose.
<function name="gtk_widget_unrealize">
<description>
-This function is only useful in widget implementations.
Causes a widget to be unrealized (frees all GDK resources
associated with the widget).
+This function is only useful in widget implementations.
+
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
</parameters>
@@ -89288,14 +93394,16 @@ associated with the widget).
<function name="gtk_widget_unset_state_flags">
<description>
-This function is for use in widget implementations. Turns off flag
-values for the current widget state (insensitive, prelighted, etc.).
-See gtk_widget_set_state_flags().
+Turns off flag values for the current widget state.
+
+See [method@Gtk.Widget.set_state_flags].
+
+This function is for use in widget implementations.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> a `GtkWidget`
</parameter_description>
</parameter>
<parameter name="flags">
@@ -89308,8 +93416,10 @@ See gtk_widget_set_state_flags().
<function name="gtk_window_close">
<description>
-Requests that the window is closed, similar to what happens
-when a window manager close button is clicked.
+Requests that the window is closed.
+
+This is similar to what happens when a window manager
+close button is clicked.
This function can be used with close buttons in custom
titlebars.
@@ -89317,7 +93427,7 @@ titlebars.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89326,14 +93436,13 @@ titlebars.
<function name="gtk_window_controls_get_decoration_layout">
<description>
-Gets the decoration layout set with
-gtk_window_controls_set_decoration_layout().
+Gets the decoration layout of this `GtkWindowControls`.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkWindowControls
+<parameter_description> a `GtkWindowControls`
</parameter_description>
</parameter>
</parameters>
@@ -89349,7 +93458,7 @@ Gets whether the widget has any window buttons.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkWindowControls
+<parameter_description> a `GtkWindowControls`
</parameter_description>
</parameter>
</parameters>
@@ -89359,13 +93468,13 @@ Gets whether the widget has any window buttons.
<function name="gtk_window_controls_get_side">
<description>
-Gets the side set with gtk_window_controls_set_side().
+Gets the side to which this `GtkWindowControls` instance belongs.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkWindowControls
+<parameter_description> a `GtkWindowControls`
</parameter_description>
</parameter>
</parameters>
@@ -89375,7 +93484,7 @@ Gets the side set with gtk_window_controls_set_side().
<function name="gtk_window_controls_new">
<description>
-Creates a new #GtkWindowControls.
+Creates a new `GtkWindowControls`.
</description>
@@ -89385,14 +93494,16 @@ Creates a new #GtkWindowControls.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkWindowControls.
+<return> a new `GtkWindowControls`.
</return>
</function>
<function name="gtk_window_controls_set_decoration_layout">
<description>
-Sets the decoration layout for the title buttons, overriding
-the #GtkSettings:gtk-decoration-layout setting.
+Sets the decoration layout for the title buttons.
+
+This overrides the [property@Gtk.Settings:gtk-decoration-layout]
+setting.
The format of the string is button names, separated by commas.
A colon separates the buttons that should appear on the left
@@ -89402,13 +93513,13 @@ 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 #GtkWindowControls:side value is @GTK_PACK_START, @self will
-display the part before the colon, otherwise after that.
+If [property@Gtk.WindowControls:side] value is @GTK_PACK_START, @self
+will display the part before the colon, otherwise after that.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkWindowControls
+<parameter_description> a `GtkWindowControls`
</parameter_description>
</parameter>
<parameter name="layout">
@@ -89422,14 +93533,14 @@ unset the layout
<function name="gtk_window_controls_set_side">
<description>
-Sets the side for @self, determining which part of decoration layout it uses.
+Determines which part of decoration layout the `GtkWindowControls` uses.
-See gtk_window_controls_set_decoration_layout()
+See [property@Gtk.WindowControls:decoration-layout].
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkWindowControls
+<parameter_description> a `GtkWindowControls`
</parameter_description>
</parameter>
<parameter name="side">
@@ -89458,18 +93569,19 @@ Drop the internal reference GTK holds on toplevel windows.
<description>
Asks to place @window in the fullscreen state.
-Note that you shouldn’t assume the window is definitely full screen afterward,
-because other entities (e.g. the user or [window manager][gtk-X11-arch]) could
-unfullscreen it again, and not all window managers honor requests to fullscreen
-windows.
+Note that you shouldn’t assume the window is definitely fullscreen
+afterward, because other entities (e.g. the user or window manager
+unfullscreen it again, and not all window managers honor requests
+to fullscreen windows.
-You can track the result of this operation via the #GdkToplevel:state property,
-or by listening to notifications of the #GtkWindow:fullscreened property.
+You can track the result of this operation via the
+[property@Gdk.Toplevel:state] property, or by listening to
+notifications of the [property@Gtk.Window:fullscreened] property.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89480,18 +93592,18 @@ or by listening to notifications of the #GtkWindow:fullscreened property.
<description>
Asks to place @window in the fullscreen state on the given @monitor.
-Note that you shouldn't assume the window is definitely full screen
+Note that you shouldn't assume the window is definitely fullscreen
afterward, or that the windowing system allows fullscreen windows on
any given monitor.
-You can track the result of this operation via the #GdkToplevel:state
-property, or by listening to notifications of the #GtkWindow:fullscreened
-property.
+You can track the result of this operation via the
+[property@Gdk.Toplevel:state] property, or by listening to
+notifications of the [property@Gtk.Window:fullscreened] property.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="monitor">
@@ -89504,17 +93616,17 @@ property.
<function name="gtk_window_get_application">
<description>
-Gets the #GtkApplication associated with the window (if any).
+Gets the `GtkApplication` associated with the window.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkApplication, or %NULL
+<return> a `GtkApplication`, or %NULL
</return>
</function>
@@ -89526,7 +93638,7 @@ Gets the child widget of @window.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89536,14 +93648,13 @@ Gets the child widget of @window.
<function name="gtk_window_get_decorated">
<description>
-Returns whether the window has been set to have decorations
-such as a title bar via gtk_window_set_decorated().
+Returns whether the window has been set to have decorations.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89553,12 +93664,11 @@ such as a title bar via gtk_window_set_decorated().
<function name="gtk_window_get_default_icon_name">
<description>
-Returns the fallback icon name for windows that has been set
-with gtk_window_set_default_icon_name(), or %NULL if that function
-has not been called.
+Returns the fallback icon name for windows.
-The returned string is owned by GTK and should not be modified.
-It is only valid until the next call to gtk_window_set_default_icon_name().
+The returned string is owned by GTK and should not
+be modified. It is only valid until the next call to
+[func@Gtk.Window.set_default_icon_name].
</description>
@@ -89570,15 +93680,16 @@ It is only valid until the next call to gtk_window_set_default_icon_name().
<function name="gtk_window_get_default_size">
<description>
-Gets the default size of the window. A value of 0 for the width or
-height indicates that a default size has not been explicitly set
-for that dimension, so the “natural” size of the window will be
-used.
+Gets the default size of the window.
+
+A value of 0 for the width or height indicates that a default
+size has not been explicitly set for that dimension, so the
+“natural” size of the window will be used.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="width">
@@ -89597,13 +93708,11 @@ used.
<description>
Returns the default widget for @window.
-See gtk_window_set_default_widget() for more details.
-
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89614,14 +93723,13 @@ if there is none.
<function name="gtk_window_get_deletable">
<description>
-Returns whether the window has been set to have a close button
-via gtk_window_set_deletable().
+Returns whether the window has been set to have a close button.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89631,14 +93739,13 @@ via gtk_window_set_deletable().
<function name="gtk_window_get_destroy_with_parent">
<description>
-Returns whether the window will be destroyed with its transient parent. See
-gtk_window_set_destroy_with_parent ().
+Returns whether the window will be destroyed with its transient parent.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89649,16 +93756,17 @@ gtk_window_set_destroy_with_parent ().
<function name="gtk_window_get_focus">
<description>
Retrieves the current focused widget within the window.
+
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
+is not focused then `gtk_widget_has_focus (widget)` will
not be %TRUE for the widget.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89669,13 +93777,13 @@ or %NULL if there is none.
<function name="gtk_window_get_focus_visible">
<description>
-Gets the value of the #GtkWindow:focus-visible property.
+Gets whether “focus rectangles” are supposed to be visible.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89686,19 +93794,39 @@ in this window.
<function name="gtk_window_get_group">
<description>
-Returns the group for @window or the default group, if
-@window is %NULL or if @window does not have an explicit
-window group.
+Returns the group for @window.
+
+If the window has no group, then the default group is returned.
+
+
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a `GtkWindow`, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> the `GtkWindowGroup` for a window
+or the default group
+</return>
+</function>
+
+<function name="gtk_window_get_handle_menubar_accel">
+<description>
+Returns whether this window reacts to F10 key presses by
+activating a menubar it contains.
+Since: 4.2
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow, or %NULL
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkWindowGroup for a window or the default group
+<return> %TRUE if the window handles F10
+
</return>
</function>
@@ -89710,7 +93838,7 @@ Returns whether the window will be hidden when the close button is clicked.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89720,14 +93848,13 @@ Returns whether the window will be hidden when the close button is clicked.
<function name="gtk_window_get_icon_name">
<description>
-Returns the name of the themed icon for the window,
-see gtk_window_set_icon_name().
+Returns the name of the themed icon for the window.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89738,13 +93865,13 @@ no themed icon
<function name="gtk_window_get_mnemonics_visible">
<description>
-Gets the value of the #GtkWindow:mnemonics-visible property.
+Gets whether mnemonics are supposed to be visible.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89755,13 +93882,13 @@ in this window.
<function name="gtk_window_get_modal">
<description>
-Returns whether the window is modal. See gtk_window_set_modal().
+Returns whether the window is modal.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89778,7 +93905,7 @@ Gets the value set by gtk_window_set_resizable().
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89788,13 +93915,13 @@ Gets the value set by gtk_window_set_resizable().
<function name="gtk_window_get_title">
<description>
-Retrieves the title of the window. See gtk_window_set_title().
+Retrieves the title of the window.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89813,7 +93940,7 @@ gtk_window_set_titlebar().
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89840,14 +93967,13 @@ of toplevel widgets
<function name="gtk_window_get_transient_for">
<description>
-Fetches the transient parent for this window. See
-gtk_window_set_transient_for().
+Fetches the transient parent for this window.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89858,16 +93984,16 @@ window, or %NULL if no transient parent has been set.
<function name="gtk_window_group_add_window">
<description>
-Adds a window to a #GtkWindowGroup.
+Adds a window to a `GtkWindowGroup`.
</description>
<parameters>
<parameter name="window_group">
-<parameter_description> a #GtkWindowGroup
+<parameter_description> a `GtkWindowGroup`
</parameter_description>
</parameter>
<parameter name="window">
-<parameter_description> the #GtkWindow to add
+<parameter_description> the `GtkWindow` to add
</parameter_description>
</parameter>
</parameters>
@@ -89876,13 +94002,13 @@ Adds a window to a #GtkWindowGroup.
<function name="gtk_window_group_list_windows">
<description>
-Returns a list of the #GtkWindows that belong to @window_group.
+Returns a list of the `GtkWindows` that belong to @window_group.
</description>
<parameters>
<parameter name="window_group">
-<parameter_description> a #GtkWindowGroup
+<parameter_description> a `GtkWindowGroup`
</parameter_description>
</parameter>
</parameters>
@@ -89893,31 +94019,31 @@ newly-allocated list of windows inside the group.
<function name="gtk_window_group_new">
<description>
-Creates a new #GtkWindowGroup object.
+Creates a new `GtkWindowGroup` object.
Modality of windows only affects windows
-within the same #GtkWindowGroup.
+within the same `GtkWindowGroup`.
</description>
<parameters>
</parameters>
-<return> a new #GtkWindowGroup.
+<return> a new `GtkWindowGroup`.
</return>
</function>
<function name="gtk_window_group_remove_window">
<description>
-Removes a window from a #GtkWindowGroup.
+Removes a window from a `GtkWindowGroup`.
</description>
<parameters>
<parameter name="window_group">
-<parameter_description> a #GtkWindowGroup
+<parameter_description> a `GtkWindowGroup`
</parameter_description>
</parameter>
<parameter name="window">
-<parameter_description> the #GtkWindow to remove
+<parameter_description> the `GtkWindow` to remove
</parameter_description>
</parameter>
</parameters>
@@ -89932,7 +94058,7 @@ Gets the child widget of @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkWindowHandle
+<parameter_description> a `GtkWindowHandle`
</parameter_description>
</parameter>
</parameters>
@@ -89942,13 +94068,13 @@ Gets the child widget of @self.
<function name="gtk_window_handle_new">
<description>
-Creates a new #GtkWindowHandle.
+Creates a new `GtkWindowHandle`.
</description>
<parameters>
</parameters>
-<return> a new #GtkWindowHandle.
+<return> a new `GtkWindowHandle`.
</return>
</function>
@@ -89959,7 +94085,7 @@ Sets the child widget of @self.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #GtkWindowHandle
+<parameter_description> a `GtkWindowHandle`
</parameter_description>
</parameter>
<parameter name="child">
@@ -89978,7 +94104,7 @@ Returns whether @window has an explicit window group.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -89989,7 +94115,9 @@ Returns whether @window has an explicit window group.
<function name="gtk_window_is_active">
<description>
Returns whether the window is part of the current active toplevel.
-(That is, the toplevel window receiving keystrokes.)
+
+The active toplevel is the window receiving keystrokes.
+
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.
@@ -89998,7 +94126,7 @@ differently in an active window from a widget in an inactive window.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -90014,7 +94142,7 @@ Note that since fullscreening is ultimately handled by the window
manager and happens asynchronously to an application request, you
shouldn’t assume the return value of this function changing
immediately (or at all), as an effect of calling
-gtk_window_fullscreen() or gtk_window_unfullscreen().
+[method@Gtk.Window.fullscreen] or [method@Gtk.Window.unfullscreen].
If the window isn't yet mapped, the value returned will whether the
initial requested state is fullscreen.
@@ -90023,7 +94151,7 @@ initial requested state is fullscreen.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -90039,7 +94167,7 @@ Note that since maximization is ultimately handled by the window
manager and happens asynchronously to an application request, you
shouldn’t assume the return value of this function changing
immediately (or at all), as an effect of calling
-gtk_window_maximize() or gtk_window_unmaximize().
+[method@Gtk.Window.maximize] or [method@Gtk.Window.unmaximize].
If the window isn't yet mapped, the value returned will whether the
initial requested state is maximized.
@@ -90048,7 +94176,7 @@ initial requested state is maximized.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -90058,18 +94186,20 @@ initial requested state is maximized.
<function name="gtk_window_list_toplevels">
<description>
-Returns a 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 involving
-callbacks that might destroy the widgets, you must call
-`g_list_foreach (result, (GFunc)g_object_ref, NULL)` first, and
-then unref all the widgets afterwards.
+Returns a 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
+involving callbacks that might destroy the widgets, you must
+call `g_list_foreach (result, (GFunc)g_object_ref, NULL)` first,
+and then unref all the widgets afterwards.
</description>
<parameters>
</parameters>
-<return> list of toplevel widgets
+<return> list of
+toplevel widgets
</return>
</function>
@@ -90077,21 +94207,24 @@ then unref all the widgets afterwards.
<description>
Asks to maximize @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][gtk-X11-arch])
-could unmaximize it again, and not all window managers support maximization.
+Note that you shouldn’t assume the window is definitely maximized
+afterward, because other entities (e.g. the user or window manager
+could unmaximize it again, and not all window managers support
+maximization.
-It’s permitted to call this function before showing a window, in which case
-the window will be maximized when it appears onscreen initially.
+It’s permitted to call this function before showing a window,
+in which case the window will be maximized when it appears onscreen
+initially.
-You can track the result of this operation via the #GdkToplevel:state
-property, or by listening to notifications on the #GtkWindow:maximized
+You can track the result of this operation via the
+[property@Gdk.Toplevel:state] property, or by listening to
+notifications on the [property@Gtk.Window:maximized]
property.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -90104,7 +94237,7 @@ Asks to minimize the specified @window.
Note that you shouldn’t assume the window is definitely minimized
afterward, because the windowing system might not support this
-functionality; other entities (e.g. the user or the [window manager][gtk-X11-arch])
+functionality; other entities (e.g. the user or the window manager
could unminimize it again, or there may not be a window manager in
which case minimization isn’t possible, etc.
@@ -90112,13 +94245,13 @@ It’s permitted to call this function before showing a window,
in which case the window will be minimized before it ever appears
onscreen.
-You can track result of this operation via the #GdkToplevel:state
-property.
+You can track result of this operation via the
+[property@Gdk.Toplevel:state] property.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -90127,38 +94260,39 @@ property.
<function name="gtk_window_new">
<description>
-Creates a new #GtkWindow, which is a toplevel window that can
-contain other widgets.
+Creates a new `GtkWindow`.
To get an undecorated window (no window borders), use
-gtk_window_set_decorated().
+[method@Gtk.Window.set_decorated].
-All top-level windows created by gtk_window_new() are stored in
-an internal top-level window list. This list can be obtained from
-gtk_window_list_toplevels(). Due to Gtk+ keeping a reference to
-the window internally, gtk_window_new() does not return a reference
-to the caller.
+All top-level windows created by gtk_window_new() 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
+return a reference to the caller.
-To delete a #GtkWindow, call gtk_window_destroy().
+To delete a `GtkWindow`, call [method@Gtk.Window.destroy].
</description>
<parameters>
</parameters>
-<return> a new #GtkWindow.
+<return> a new `GtkWindow`.
</return>
</function>
<function name="gtk_window_present">
<description>
-Presents a window to the user. This function should not be used
-as when it is called, it is too late to gather a valid timestamp
-to allow focus stealing prevention to work correctly.
+Presents a window to the user.
+
+This function should not be used as when it is called,
+it is too late to gather a valid timestamp to allow focus
+stealing prevention to work correctly.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -90167,33 +94301,35 @@ to allow focus stealing prevention to work correctly.
<function name="gtk_window_present_with_time">
<description>
-Presents a window to the user. This may mean raising the window
-in the stacking order, unminimizing it, moving it to the current
-desktop, and/or giving it the keyboard focus, possibly dependent
-on the user’s platform, window manager, and preferences.
+Presents a window to the user.
+
+This may mean raising the window in the stacking order,
+unminimizing it, moving it to the current desktop, and/or
+giving it the keyboard focus, possibly dependent on the user’s
+platform, window manager, and preferences.
-If @window is hidden, this function calls gtk_widget_show()
+If @window is hidden, this function calls [method Gtk Widget show]
as well.
This function should be used when the user tries to open a window
that’s already open. Say for example the preferences dialog is
currently open, and the user chooses Preferences from the menu
-a second time; use gtk_window_present() to move the already-open dialog
-where the user can see it.
+a second time; use [method@Gtk.Window.present] to move the
+already-open dialog where the user can see it.
-Presents a window to the user in response to a user interaction. 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.
+Presents a window to the user in response to a user interaction.
+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.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="timestamp">
-<parameter_description> the timestamp of the user interaction (typically a
+<parameter_description> the timestamp of the user interaction (typically a
button or key press event) which triggered this call
</parameter_description>
</parameter>
@@ -90203,27 +94339,28 @@ button or key press event) which triggered this call
<function name="gtk_window_set_application">
<description>
-Sets or unsets the #GtkApplication associated with the window.
+Sets or unsets the `GtkApplication` 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).
+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).
-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 to %NULL.
+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 to %NULL.
-This is equivalent to calling gtk_application_remove_window() and/or
-gtk_application_add_window() on the old/new applications as relevant.
+This is equivalent to calling [method@Gtk.Application.remove_window]
+and/or [method@Gtk.Application.add_window] on the old/new applications
+as relevant.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="application">
-<parameter_description> a #GtkApplication, or %NULL to unset
+<parameter_description> a `GtkApplication`, or %NULL to unset
</parameter_description>
</parameter>
</parameters>
@@ -90232,9 +94369,11 @@ gtk_application_add_window() on the old/new applications as relevant.
<function name="gtk_window_set_auto_startup_notification">
<description>
-By default, after showing the first #GtkWindow, GTK calls
-gdk_display_notify_startup_complete(). Call this function to
-disable the automatic startup notification. You might do this
+Sets whether the window should request startup notification.
+
+By default, after showing the first `GtkWindow`, GTK calls
+[method@Gdk.Display.notify_startup_complete]. 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
notification until after your real main window has been shown,
for example.
@@ -90260,7 +94399,7 @@ Sets the child widget of @window.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="child">
@@ -90273,23 +94412,24 @@ Sets the child widget of @window.
<function name="gtk_window_set_decorated">
<description>
+Sets whether the window should be decorated.
+
By default, windows are decorated with a title bar, resize
-controls, etc. Some [window managers][gtk-X11-arch]
-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 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 gtk_widget_show().
+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
+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
+[method Gtk Widget show].
On Windows, this function always works, since there’s no window manager
policy involved.
-
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -90302,8 +94442,11 @@ policy involved.
<function name="gtk_window_set_default_icon_name">
<description>
-Sets an icon to be used as fallback for windows that
-haven't had gtk_window_set_icon_name() called on them.
+Sets an icon to be used as fallback.
+
+The fallback icon is used for windows that
+haven't had [method@Gtk.Window.set_icon_name]
+called on them.
</description>
<parameters>
@@ -90317,16 +94460,18 @@ haven't had gtk_window_set_icon_name() called on them.
<function name="gtk_window_set_default_size">
<description>
-Sets the default size of a window. If the window’s “natural” size
-(its size request) is larger than the default, the default will be
-ignored.
+Sets the default size of a window.
-Unlike gtk_widget_set_size_request(), which sets a size request for
-a widget and thus would keep users from shrinking the window, this
-function only sets the initial size, just as if the user had
-resized the window themselves. Users can still shrink the window
-again as they normally would. Setting a default size of -1 means to
-use the “natural” default size (the size request of the window).
+If the window’s “natural” size (its size request) is larger than
+the default, the default will be ignored.
+
+Unlike [method@Gtk.Widget.set_size_request], which sets a size
+request for a widget and thus would keep users from shrinking
+the window, this function only sets the initial size, just as
+if the user had resized the window themselves. Users can still
+shrink the window again as they normally would. Setting a default
+size of -1 means to use the “natural” default size (the size request
+of the window).
The default size of a window only affects the first time a window is
shown; if a window is hidden and re-shown, it will remember the size
@@ -90337,13 +94482,14 @@ passing 0 for @width and @height is OK, resulting in a 1x1 default size.
If you use this function to reestablish a previously saved window size,
note that the appropriate size to save is the one returned by
-gtk_window_get_default_size(). Using the window allocation directly will not
-work in all circumstances and can lead to growing or shrinking windows.
+[method@Gtk.Window.get_default_size]. Using the window allocation
+directly will not work in all circumstances and can lead to growing
+or shrinking windows.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="width">
@@ -90360,14 +94506,15 @@ work in all circumstances and can lead to growing or shrinking windows.
<function name="gtk_window_set_default_widget">
<description>
-The default widget is the widget that’s activated when the user
-presses Enter in a dialog (for example). This function sets or
-unsets the default widget for a #GtkWindow.
+Sets the default widget.
+
+The default widget is the widget that is activated when the user
+presses Enter in a dialog (for example).
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="default_widget">
@@ -90381,21 +94528,23 @@ to unset the default widget for the toplevel
<function name="gtk_window_set_deletable">
<description>
-By default, windows have a close button in the window frame. Some
-[window managers][gtk-X11-arch] allow GTK to
-disable this button. If you 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, so you should call it before calling gtk_widget_show().
+Sets whether the window should be deletable.
-On Windows, this function always works, since there’s no window manager
-policy involved.
+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
+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,
+so you should call it before calling [method Gtk Widget show].
+
+On Windows, this function always works, since there’s no window
+manager policy involved.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -90409,14 +94558,15 @@ policy involved.
<function name="gtk_window_set_destroy_with_parent">
<description>
If @setting is %TRUE, then destroying the transient parent of @window
-will also destroy @window itself. This is useful for dialogs that
-shouldn’t persist beyond the lifetime of the main window they're
-associated with, for example.
+will also destroy @window itself.
+
+This is useful for dialogs that shouldn’t persist beyond the lifetime
+of the main window they are associated with, for example.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -90429,18 +94579,19 @@ associated with, for example.
<function name="gtk_window_set_display">
<description>
-Sets the #GdkDisplay where the @window is displayed; if
-the window is already mapped, it will be unmapped, and
-then remapped on the new display.
+Sets the `GdkDisplay` where the @window is displayed.
+
+If the window is already mapped, it will be unmapped,
+and then remapped on the new display.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow.
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="display">
-<parameter_description> a #GdkDisplay.
+<parameter_description> a `GdkDisplay`
</parameter_description>
</parameter>
</parameters>
@@ -90449,16 +94600,18 @@ then remapped on the new display.
<function name="gtk_window_set_focus">
<description>
-If @focus is not the current focus widget, and is focusable, sets
-it as the focus widget for the window. If @focus is %NULL, unsets
-the focus widget for this window. To set the focus to a particular
-widget in the toplevel, it is usually more convenient to use
-gtk_widget_grab_focus() instead of this function.
+Sets the focus widget.
+
+If @focus is not the current focus widget, and is focusable,
+sets it as the focus widget for the window. If @focus is %NULL,
+unsets the focus widget for this window. To set the focus to a
+particular widget in the toplevel, it is usually more convenient
+to use [method@Gtk.Widget.grab_focus] instead of this function.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="focus">
@@ -90472,12 +94625,12 @@ any focus widget for the toplevel window.
<function name="gtk_window_set_focus_visible">
<description>
-Sets the #GtkWindow:focus-visible property.
+Sets whether “focus rectangles” are supposed to be visible.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -90488,6 +94641,27 @@ Sets the #GtkWindow:focus-visible property.
<return></return>
</function>
+<function name="gtk_window_set_handle_menubar_accel">
+<description>
+Sets whether this window should react to F10 key presses
+by activating a menubar it contains.
+
+Since: 4.2
+
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="handle_menubar_accel">
+<parameter_description> %TRUE to make @window handle F10
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gtk_window_set_hide_on_close">
<description>
If @setting is %TRUE, then clicking the close button on the window
@@ -90496,7 +94670,7 @@ will not destroy it, but only hide it.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -90510,16 +94684,17 @@ will not destroy it, but only hide it.
<function name="gtk_window_set_icon_name">
<description>
Sets the icon for the window from a named themed icon.
-See the docs for #GtkIconTheme for more details.
+
+See the docs for [class@Gtk.IconTheme] for more details.
On some platforms, the window icon is not used at all.
-Note that this has nothing to do with the WM_ICON_NAME
+Note that this has nothing to do with the WM_ICON_NAME
property which is mentioned in the ICCCM.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="name">
@@ -90532,8 +94707,9 @@ property which is mentioned in the ICCCM.
<function name="gtk_window_set_interactive_debugging">
<description>
-Opens or closes the [interactive debugger][interactive-debugging],
-which offers access to the widget hierarchy of the application
+Opens or closes the [interactive debugger](#interactive-debugging).
+
+The debugger offers access to the widget hierarchy of the application
and to useful debugging tools.
</description>
@@ -90548,12 +94724,12 @@ and to useful debugging tools.
<function name="gtk_window_set_mnemonics_visible">
<description>
-Sets the #GtkWindow:mnemonics-visible property.
+Sets whether mnemonics are supposed to be visible.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="setting">
@@ -90566,17 +94742,18 @@ Sets the #GtkWindow:mnemonics-visible property.
<function name="gtk_window_set_modal">
<description>
-Sets a window modal or non-modal. Modal windows prevent interaction
-with other windows in the same application. To keep modal dialogs
-on top of main application windows, use
-gtk_window_set_transient_for() to make the dialog transient for the
-parent; most [window managers][gtk-X11-arch]
-will then disallow lowering the dialog below the parent.
+Sets a window modal or non-modal.
+
+Modal windows prevent interaction with other windows in the same
+application. To keep modal dialogs on top of main application windows,
+use [method@Gtk.Window.set_transient_for] to make the dialog transient
+for the parent; most window managers will then disallow lowering the
+dialog below the parent.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="modal">
@@ -90596,7 +94773,7 @@ Windows are user resizable by default.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="resizable">
@@ -90609,21 +94786,25 @@ Windows are user resizable by default.
<function name="gtk_window_set_startup_id">
<description>
-Startup notification identifiers are used by desktop environment to
-track application startup, to provide user feedback and other
+Sets the startup notification ID.
+
+Startup notification identifiers are used by desktop environment
+to track application startup, to provide user feedback and other
features. This function changes the corresponding property on the
-underlying GdkSurface. Normally, startup identifier is managed
-automatically and you should only use this function in special cases
-like transferring focus from other processes. You should use this
-function before calling gtk_window_present() or any equivalent
-function generating a window map event.
+underlying `GdkSurface`.
+
+Normally, startup identifier is managed automatically and you should
+only use this function in special cases like transferring focus from
+other processes. You should use this function before calling
+[method@Gtk.Window.present] or any equivalent function generating
+a window map event.
This function is only useful on X11, not with other GTK targets.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="startup_id">
@@ -90636,22 +94817,21 @@ This function is only useful on X11, not with other GTK targets.
<function name="gtk_window_set_title">
<description>
-Sets the title of the #GtkWindow. 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][gtk-X11-arch],
-so exactly how the title appears to users may vary
-according to a 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.
-document filename, for example.
+Sets the title of the `GtkWindow`.
+
+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
+so exactly how the title appears to users may vary according to a
+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.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="title">
@@ -90666,19 +94846,20 @@ Passing %NULL does the same as setting the title to an empty string.
<description>
Sets a custom titlebar for @window.
-A typical widget used here is #GtkHeaderBar, as it provides various features
-expected of a titlebar while allowing the addition of child widgets to it.
+A typical widget used here is [class@Gtk.HeaderBar], as it
+provides various features expected of a titlebar while allowing
+the addition of child widgets to it.
If you set a custom titlebar, GTK will do its best to convince
the window manager not to put its own titlebar on the window.
Depending on the system, this function may not work for a window
that is already visible, so you set the titlebar before calling
-gtk_widget_show().
+[method Gtk Widget show].
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="titlebar">
@@ -90692,11 +94873,10 @@ gtk_widget_show().
<function name="gtk_window_set_transient_for">
<description>
Dialog windows should be set transient for the main application
-window they were spawned from. This allows
-[window managers][gtk-X11-arch] to e.g. keep the
-dialog on top of the main window, or center the dialog over the
-main window. gtk_dialog_new_with_buttons() and other convenience
-functions in GTK will sometimes call
+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.
Passing %NULL for @parent unsets the current transient window.
@@ -90707,7 +94887,7 @@ much as the window manager would have done on X.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
<parameter name="parent">
@@ -90720,22 +94900,24 @@ much as the window manager would have done on X.
<function name="gtk_window_unfullscreen">
<description>
-Asks to remove the fullscreen state for @window, and return to its previous
-state.
+Asks to remove the fullscreen state for @window, and return to
+its previous state.
-Note that you shouldn’t assume the window is definitely not full screen afterward,
-because other entities (e.g. the user or [window manager][gtk-X11-arch]) could
-fullscreen it again, and not all window managers honor requests to unfullscreen
-windows; normally the window will end up restored to its normal state. Just don’t
+Note that you shouldn’t assume the window is definitely not
+fullscreen afterward, because other entities (e.g. the user or
+window manager could fullscreen it again, and not all window
+managers honor requests to unfullscreen windows; normally the
+window will end up restored to its normal state. Just don’t
write code that crashes if not.
-You can track the result of this operation via the #GdkToplevel:state property,
-or by listening to notifications of the #GtkWindow:fullscreened property.
+You can track the result of this operation via the
+[property@Gdk.Toplevel:state] property, or by listening to
+notifications of the [property@Gtk.Window:fullscreened] property.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -90746,18 +94928,19 @@ or by listening to notifications of the #GtkWindow:fullscreened property.
<description>
Asks to unmaximize @window.
-Note that you shouldn’t assume the window is definitely unmaximized afterward,
-because other entities (e.g. the user or [window manager][gtk-X11-arch]) could
-maximize it again, and not all window managers honor requests to unmaximize.
+Note that you shouldn’t assume the window is definitely unmaximized
+afterward, because other entities (e.g. the user or window manager
+maximize it again, and not all window managers honor requests to
+unmaximize.
-You can track the result of this operation via the #GdkToplevel:state
-property, or by listening to notifications on the #GtkWindow:maximized
-property.
+You can track the result of this operation via the
+[property@Gdk.Toplevel:state] property, or by listening to
+notifications on the [property@Gtk.Window:maximized] property.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
@@ -90770,17 +94953,17 @@ Asks to unminimize the specified @window.
Note that you shouldn’t assume the window is definitely unminimized
afterward, because the windowing system might not support this
-functionality; other entities (e.g. the user or the [window manager][gtk-X11-arch])
+functionality; other entities (e.g. the user or the window manager
could minimize it again, or there may not be a window manager in
which case minimization isn’t possible, etc.
-You can track result of this operation via the #GdkToplevel:state
-property.
+You can track result of this operation via the
+[property@Gdk.Toplevel:state] property.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a `GtkWindow`
</parameter_description>
</parameter>
</parameters>
diff --git a/gtk/src/gtk_docs_override.xml b/gtk/src/gtk_docs_override.xml
index 37198636..ed741c0c 100644
--- a/gtk/src/gtk_docs_override.xml
+++ b/gtk/src/gtk_docs_override.xml
@@ -200,8 +200,9 @@
<substitute_enumerator_name from_prefix="GTK_STYLE_CLASS_" to_prefix="GTK_STYLE_CLASS_" />
<substitute_enumerator_name from="G_PRIORITY_DEFAULT" to="Glib::PRIORITY_DEFAULT" />
<substitute_enumerator_name from="G_PRIORITY_DEFAULT_IDLE" to="Glib::PRIORITY_DEFAULT_IDLE" />
-<!-- This is the default substitution. Included here to avoid warnings from DocsParser.pm. -->
+<!-- These are the default substitutions. Included here to avoid warnings from DocsParser.pm. -->
<substitute_enumerator_name from="PANGO_SCALE" to="Pango::SCALE" />
+<substitute_enumerator_name from="PANGO_SCALE_X_LARGE" to="Pango::SCALE_X_LARGE" />
<function name="gtk_label_get_label">
<return> the text of the label widget.
diff --git a/gtk/src/gtk_enums.defs b/gtk/src/gtk_enums.defs
index c093b623..d34f85e1 100644
--- a/gtk/src/gtk_enums.defs
+++ b/gtk/src/gtk_enums.defs
@@ -248,6 +248,7 @@
;; GTK_DEBUG_CONSTRAINTS = 1 << 15,
;; GTK_DEBUG_BUILDER_OBJECTS = 1 << 16,
;; GTK_DEBUG_A11Y = 1 << 17,
+;; GTK_DEBUG_ICONFALLBACK = 1 << 18,
;; } GtkDebugFlags;
(define-flags-extended DebugFlags
@@ -272,6 +273,7 @@
'("constraints" "GTK_DEBUG_CONSTRAINTS" "1 << 15")
'("builder-objects" "GTK_DEBUG_BUILDER_OBJECTS" "1 << 16")
'("a11y" "GTK_DEBUG_A11Y" "1 << 17")
+ '("iconfallback" "GTK_DEBUG_ICONFALLBACK" "1 << 18")
)
)
diff --git a/gtk/src/gtk_methods.defs b/gtk/src/gtk_methods.defs
index a1388fa1..3463bc19 100644
--- a/gtk/src/gtk_methods.defs
+++ b/gtk/src/gtk_methods.defs
@@ -576,6 +576,7 @@
'("constraints" "GTK_DEBUG_CONSTRAINTS")
'("builder-objects" "GTK_DEBUG_BUILDER_OBJECTS")
'("a11y" "GTK_DEBUG_A11Y")
+ '("iconfallback" "GTK_DEBUG_ICONFALLBACK")
)
)
@@ -7250,6 +7251,42 @@
)
)
+(define-method check
+ (of-object "GtkComposeTable")
+ (c-name "gtk_compose_table_check")
+ (return-type "gboolean")
+ (parameters
+ '("const-guint16*" "compose_buffer")
+ '("int" "n_compose")
+ '("gboolean*" "compose_finish")
+ '("gboolean*" "compose_match")
+ '("GString*" "output")
+ )
+)
+
+(define-method check
+ (of-object "GtkComposeTableCompact")
+ (c-name "gtk_compose_table_compact_check")
+ (return-type "gboolean")
+ (parameters
+ '("const-guint16*" "compose_buffer")
+ '("int" "n_compose")
+ '("gboolean*" "compose_finish")
+ '("gboolean*" "compose_match")
+ '("gunichar*" "output_char")
+ )
+)
+
+(define-function gtk_check_algorithmically
+ (c-name "gtk_check_algorithmically")
+ (return-type "gboolean")
+ (parameters
+ '("const-guint16*" "compose_buffer")
+ '("int" "n_compose")
+ '("gunichar*" "output")
+ )
+)
+
;; From gtkconstraintguide.h
@@ -9910,6 +9947,11 @@
)
)
+(define-function gtk_expression_watch_get_type
+ (c-name "gtk_expression_watch_get_type")
+ (return-type "GType")
+)
+
(define-method ref
(of-object "GtkExpressionWatch")
(c-name "gtk_expression_watch_ref")
@@ -12658,6 +12700,15 @@
)
)
+(define-method has_gicon
+ (of-object "GtkIconTheme")
+ (c-name "gtk_icon_theme_has_gicon")
+ (return-type "gboolean")
+ (parameters
+ '("GIcon*" "gicon")
+ )
+)
+
(define-method get_icon_sizes
(of-object "GtkIconTheme")
(c-name "gtk_icon_theme_get_icon_sizes")
@@ -13567,6 +13618,29 @@
)
)
+(define-method set_surrounding_with_selection
+ (of-object "GtkIMContext")
+ (c-name "gtk_im_context_set_surrounding_with_selection")
+ (return-type "none")
+ (parameters
+ '("const-char*" "text")
+ '("int" "len")
+ '("int" "cursor_index")
+ '("int" "anchor_index")
+ )
+)
+
+(define-method get_surrounding_with_selection
+ (of-object "GtkIMContext")
+ (c-name "gtk_im_context_get_surrounding_with_selection")
+ (return-type "gboolean")
+ (parameters
+ '("char**" "text")
+ '("int*" "cursor_index")
+ '("int*" "anchor_index")
+ )
+)
+
(define-method delete_surrounding
(of-object "GtkIMContext")
(c-name "gtk_im_context_delete_surrounding")
@@ -13661,11 +13735,6 @@
;; From gtkimmodule.h
-(define-function gtk_im_modules_init
- (c-name "gtk_im_modules_init")
- (return-type "none")
-)
-
;; From gtkimmulticontext.h
@@ -31808,6 +31877,21 @@
)
)
+(define-method set_handle_menubar_accel
+ (of-object "GtkWindow")
+ (c-name "gtk_window_set_handle_menubar_accel")
+ (return-type "none")
+ (parameters
+ '("gboolean" "handle_menubar_accel")
+ )
+)
+
+(define-method get_handle_menubar_accel
+ (of-object "GtkWindow")
+ (c-name "gtk_window_get_handle_menubar_accel")
+ (return-type "gboolean")
+)
+
;; From gtkwindowhandle.h
diff --git a/gtk/src/gtk_signals.defs b/gtk/src/gtk_signals.defs
index b484d6f8..f6596149 100644
--- a/gtk/src/gtk_signals.defs
+++ b/gtk/src/gtk_signals.defs
@@ -969,6 +969,12 @@
;; From GtkCheckButton
+(define-signal activate
+ (of-object "GtkCheckButton")
+ (return-type "void")
+ (flags "Run First, Action")
+)
+
(define-signal toggled
(of-object "GtkCheckButton")
(return-type "void")
@@ -4939,7 +4945,7 @@
;; From GtkGesture
-(define-signal update
+(define-signal cancel
(of-object "GtkGesture")
(return-type "void")
(flags "Run Last")
@@ -4948,7 +4954,7 @@
)
)
-(define-signal cancel
+(define-signal begin
(of-object "GtkGesture")
(return-type "void")
(flags "Run Last")
@@ -4957,7 +4963,7 @@
)
)
-(define-signal begin
+(define-signal end
(of-object "GtkGesture")
(return-type "void")
(flags "Run Last")
@@ -4966,7 +4972,7 @@
)
)
-(define-signal end
+(define-signal update
(of-object "GtkGesture")
(return-type "void")
(flags "Run Last")
@@ -5230,22 +5236,22 @@
;; From GtkGLArea
-(define-signal render
+(define-signal resize
(of-object "GtkGLArea")
- (return-type "gboolean")
+ (return-type "void")
(flags "Run Last")
(parameters
- '("GdkGLContext*" "p0")
+ '("gint" "p0")
+ '("gint" "p1")
)
)
-(define-signal resize
+(define-signal render
(of-object "GtkGLArea")
- (return-type "void")
+ (return-type "gboolean")
(flags "Run Last")
(parameters
- '("gint" "p0")
- '("gint" "p1")
+ '("GdkGLContext*" "p0")
)
)
@@ -9286,7 +9292,7 @@
(readable #t)
(writable #t)
(construct-only #f)
- (default-value "")
+ (default-value "cups,file")
)
(define-property gtk-print-preview-command
@@ -10678,7 +10684,7 @@
(define-property scroll-offset
(of-object "GtkText")
(prop-type "GParamInt")
- (docs "Number of pixels of the self scrolled off the screen to the left")
+ (docs "Number of pixels of the text scrolled off the screen to the left")
(readable #t)
(writable #f)
(construct-only #f)
@@ -10718,7 +10724,7 @@
(define-property placeholder-text
(of-object "GtkText")
(prop-type "GParamString")
- (docs "Show text in the self when it’s empty and unfocused")
+ (docs "Show text in the GtkText when it’s empty and unfocused")
(readable #t)
(writable #t)
(construct-only #f)
@@ -10748,7 +10754,7 @@
(define-property attributes
(of-object "GtkText")
(prop-type "GParamBoxed")
- (docs "A list of style attributes to apply to the text of the self")
+ (docs "A list of style attributes to apply to the text of the GtkText")
(readable #t)
(writable #t)
(construct-only #f)
@@ -10757,7 +10763,7 @@
(define-property tabs
(of-object "GtkText")
(prop-type "GParamBoxed")
- (docs "A list of tabstop locations to apply to the text of the self")
+ (docs "A list of tabstop locations to apply to the text of the GtkText")
(readable #t)
(writable #t)
(construct-only #f)
@@ -12988,6 +12994,15 @@
;; From GtkWidget
+(define-signal direction-changed
+ (of-object "GtkWidget")
+ (return-type "void")
+ (flags "Run First")
+ (parameters
+ '("GtkTextDirection" "p0")
+ )
+)
+
(define-signal destroy
(of-object "GtkWidget")
(return-type "void")
@@ -13039,15 +13054,6 @@
)
)
-(define-signal direction-changed
- (of-object "GtkWidget")
- (return-type "void")
- (flags "Run First")
- (parameters
- '("GtkTextDirection" "p0")
- )
-)
-
(define-signal mnemonic-activate
(of-object "GtkWidget")
(return-type "gboolean")
@@ -13435,22 +13441,22 @@
;; From GtkWindow
-(define-signal activate-focus
+(define-signal keys-changed
(of-object "GtkWindow")
(return-type "void")
- (flags "Run Last, Action")
+ (flags "Run First")
)
-(define-signal activate-default
+(define-signal activate-focus
(of-object "GtkWindow")
(return-type "void")
(flags "Run Last, Action")
)
-(define-signal keys-changed
+(define-signal activate-default
(of-object "GtkWindow")
(return-type "void")
- (flags "Run First")
+ (flags "Run Last, Action")
)
(define-signal enable-debugging
@@ -13622,6 +13628,16 @@
(construct-only #f)
)
+(define-property handle-menubar-accel
+ (of-object "GtkWindow")
+ (prop-type "GParamBoolean")
+ (docs "Whether the window should handle F10")
+ (readable #t)
+ (writable #t)
+ (construct-only #f)
+ (default-value "TRUE")
+)
+
(define-property is-active
(of-object "GtkWindow")
(prop-type "GParamBoolean")
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
