@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtk/grid.d.ts

@@ -2,32 +2,273 @@ import { Ref } from "@gtkx/native";
 import { BaselinePosition, Orientation, PositionType } from "./enums.js";
 import * as GObject from "../gobject/index.js";
 import { Widget } from "./widget.js";
+/**
+ * Arranges its child widgets in rows and columns.
+ *
+ *
+ *
+ * It supports arbitrary positions and horizontal/vertical spans.
+ *
+ * Children are added using [method@Gtk.Grid.attach]. They can span multiple
+ * rows or columns. It is also possible to add a child next to an existing
+ * child, using [method@Gtk.Grid.attach_next_to]. To remove a child from the
+ * grid, use [method@Gtk.Grid.remove].
+ *
+ * The behaviour of `GtkGrid` when several children occupy the same grid
+ * cell is undefined.
+ *
+ * # GtkGrid as GtkBuildable
+ *
+ * Every child in a `GtkGrid` has access to a custom [iface@Gtk.Buildable]
+ * element, called `<layout>`. It can by used to specify a position in the
+ * grid and optionally spans. All properties that can be used in the `<layout>`
+ * element are implemented by [class@Gtk.GridLayoutChild].
+ *
+ * It is implemented by `GtkWidget` using [class@Gtk.LayoutManager].
+ *
+ * To showcase it, here is a simple example:
+ *
+ * ```xml
+ * <object class="GtkGrid" id="my_grid">
+ * <child>
+ * <object class="GtkButton" id="button1">
+ * <property name="label">Button 1</property>
+ * <layout>
+ * <property name="column">0</property>
+ * <property name="row">0</property>
+ * </layout>
+ * </object>
+ * </child>
+ * <child>
+ * <object class="GtkButton" id="button2">
+ * <property name="label">Button 2</property>
+ * <layout>
+ * <property name="column">1</property>
+ * <property name="row">0</property>
+ * </layout>
+ * </object>
+ * </child>
+ * <child>
+ * <object class="GtkButton" id="button3">
+ * <property name="label">Button 3</property>
+ * <layout>
+ * <property name="column">2</property>
+ * <property name="row">0</property>
+ * <property name="row-span">2</property>
+ * </layout>
+ * </object>
+ * </child>
+ * <child>
+ * <object class="GtkButton" id="button4">
+ * <property name="label">Button 4</property>
+ * <layout>
+ * <property name="column">0</property>
+ * <property name="row">1</property>
+ * <property name="column-span">2</property>
+ * </layout>
+ * </object>
+ * </child>
+ * </object>
+ * ```
+ *
+ * It organizes the first two buttons side-by-side in one cell each.
+ * The third button is in the last column but spans across two rows.
+ * This is defined by the `row-span` property. The last button is
+ * located in the second row and spans across two columns, which is
+ * defined by the `column-span` property.
+ *
+ * # CSS nodes
+ *
+ * `GtkGrid` uses a single CSS node with name `grid`.
+ *
+ * # Accessibility
+ *
+ * Until GTK 4.10, `GtkGrid` used the [enum@Gtk.AccessibleRole.group] role.
+ *
+ * Starting from GTK 4.12, `GtkGrid` uses the [enum@Gtk.AccessibleRole.generic] role.
+ */
 export declare class Grid extends Widget {
+    /**
+     * Creates a new grid widget.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Adds a widget to the grid.
+     *
+     * The position of `child` is determined by `column` and @row.
+     * The number of “cells” that `child` will occupy is determined
+     * by `width` and @height.
+     * @param child - the widget to add
+     * @param column - the column number to attach the left side of `child` to
+     * @param row - the row number to attach the top side of `child` to
+     * @param width - the number of columns that `child` will span
+     * @param height - the number of rows that `child` will span
+     */
     attach(child: Widget, column: number, row: number, width: number, height: number): void;
+    /**
+     * Adds a widget to the grid.
+     *
+     * The widget is placed next to @sibling, on the side determined by
+     * @side. When `sibling` is %NULL, the widget is placed in row (for
+     * left or right placement) or column 0 (for top or bottom placement),
+     * at the end indicated by @side.
+     *
+     * Attaching widgets labeled `[1]`, `[2]`, `[3]` with ``sibling` == %NULL` and
+     * ``side` == %GTK_POS_LEFT` yields a layout of `[3][2][1]`.
+     * @param child - the widget to add
+     * @param sibling - the child of `grid` that `child` will be placed
+     * @param side - the side of `sibling` that `child` is positioned next to
+     * @param width - the number of columns that `child` will span
+     * @param height - the number of rows that `child` will span
+     */
     attachNextTo(child: Widget, side: PositionType, width: number, height: number, sibling?: Widget | null): void;
+    /**
+     * Returns which row defines the global baseline of @grid.
+     */
     getBaselineRow(): number;
+    /**
+     * Gets the child of `grid` whose area covers the grid
+     * cell at @column, @row.
+     * @param column - the left edge of the cell
+     * @param row - the top edge of the cell
+     */
     getChildAt(column: number, row: number): Widget | null;
+    /**
+     * Returns whether all columns of `grid` have the same width.
+     */
     getColumnHomogeneous(): boolean;
+    /**
+     * Returns the amount of space between the columns of @grid.
+     */
     getColumnSpacing(): number;
+    /**
+     * Returns the baseline position of @row.
+     *
+     * See [method@Gtk.Grid.set_row_baseline_position].
+     * @param row - a row index
+     */
     getRowBaselinePosition(row: number): BaselinePosition;
+    /**
+     * Returns whether all rows of `grid` have the same height.
+     */
     getRowHomogeneous(): boolean;
+    /**
+     * Returns the amount of space between the rows of @grid.
+     */
     getRowSpacing(): number;
+    /**
+     * Inserts a column at the specified position.
+     *
+     * Children which are attached at or to the right of this position
+     * are moved one column to the right. Children which span across this
+     * position are grown to span the new column.
+     * @param position - the position to insert the column at
+     */
     insertColumn(position: number): void;
+    /**
+     * Inserts a row or column at the specified position.
+     *
+     * The new row or column is placed next to @sibling, on the side
+     * determined by @side. If `side` is %GTK_POS_TOP or %GTK_POS_BOTTOM,
+     * a row is inserted. If `side` is %GTK_POS_LEFT of %GTK_POS_RIGHT,
+     * a column is inserted.
+     * @param sibling - the child of `grid` that the new row or column will be
+     * @param side - the side of `sibling` that `child` is positioned next to
+     */
     insertNextTo(sibling: Widget, side: PositionType): void;
+    /**
+     * Inserts a row at the specified position.
+     *
+     * Children which are attached at or below this position
+     * are moved one row down. Children which span across this
+     * position are grown to span the new row.
+     * @param position - the position to insert the row at
+     */
     insertRow(position: number): void;
+    /**
+     * Queries the attach points and spans of `child` inside the given `GtkGrid`.
+     * @param child - a `GtkWidget` child of @grid
+     * @param column - the column used to attach the left side of @child
+     * @param row - the row used to attach the top side of @child
+     * @param width - the number of columns `child` spans
+     * @param height - the number of rows `child` spans
+     */
     queryChild(child: Widget, column?: Ref<number> | null, row?: Ref<number> | null, width?: Ref<number> | null, height?: Ref<number> | null): void;
+    /**
+     * Removes a child from @grid.
+     *
+     * The child must have been added with
+     * [method@Gtk.Grid.attach] or [method@Gtk.Grid.attach_next_to].
+     * @param child - the child widget to remove
+     */
     remove(child: Widget): void;
+    /**
+     * Removes a column from the grid.
+     *
+     * Children that are placed in this column are removed,
+     * spanning children that overlap this column have their
+     * width reduced by one, and children after the column
+     * are moved to the left.
+     * @param position - the position of the column to remove
+     */
     removeColumn(position: number): void;
+    /**
+     * Removes a row from the grid.
+     *
+     * Children that are placed in this row are removed,
+     * spanning children that overlap this row have their
+     * height reduced by one, and children below the row
+     * are moved up.
+     * @param position - the position of the row to remove
+     */
     removeRow(position: number): void;
+    /**
+     * 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.
+     * @param row - the row index
+     */
     setBaselineRow(row: number): void;
+    /**
+     * Sets whether all columns of `grid` will have the same width.
+     * @param homogeneous - %TRUE to make columns homogeneous
+     */
     setColumnHomogeneous(homogeneous: boolean): void;
+    /**
+     * Sets the amount of space between columns of @grid.
+     * @param spacing - the amount of space to insert between columns
+     */
     setColumnSpacing(spacing: number): void;
+    /**
+     * 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.
+     * @param row - a row index
+     * @param pos - a `GtkBaselinePosition`
+     */
     setRowBaselinePosition(row: number, pos: BaselinePosition): void;
+    /**
+     * Sets whether all rows of `grid` will have the same height.
+     * @param homogeneous - %TRUE to make rows homogeneous
+     */
     setRowHomogeneous(homogeneous: boolean): void;
+    /**
+     * Sets the amount of space between rows of @grid.
+     * @param spacing - the amount of space to insert between rows
+     */
     setRowSpacing(spacing: number): void;
+    /**
+     * Retrieves the orientation of the @orientable.
+     */
     getOrientation(): Orientation;
+    /**
+     * Sets the orientation of the @orientable.
+     * @param orientation - the orientable’s new orientation
+     */
     setOrientation(orientation: Orientation): void;
     connect(signal: "notify", handler: (self: Grid, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gtk/grid.js

@@ -1,7 +1,95 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { Widget } from "./widget.js";
+/**
+ * Arranges its child widgets in rows and columns.
+ *
+ *
+ *
+ * It supports arbitrary positions and horizontal/vertical spans.
+ *
+ * Children are added using [method@Gtk.Grid.attach]. They can span multiple
+ * rows or columns. It is also possible to add a child next to an existing
+ * child, using [method@Gtk.Grid.attach_next_to]. To remove a child from the
+ * grid, use [method@Gtk.Grid.remove].
+ *
+ * The behaviour of `GtkGrid` when several children occupy the same grid
+ * cell is undefined.
+ *
+ * # GtkGrid as GtkBuildable
+ *
+ * Every child in a `GtkGrid` has access to a custom [iface@Gtk.Buildable]
+ * element, called `<layout>`. It can by used to specify a position in the
+ * grid and optionally spans. All properties that can be used in the `<layout>`
+ * element are implemented by [class@Gtk.GridLayoutChild].
+ *
+ * It is implemented by `GtkWidget` using [class@Gtk.LayoutManager].
+ *
+ * To showcase it, here is a simple example:
+ *
+ * ```xml
+ * <object class="GtkGrid" id="my_grid">
+ * <child>
+ * <object class="GtkButton" id="button1">
+ * <property name="label">Button 1</property>
+ * <layout>
+ * <property name="column">0</property>
+ * <property name="row">0</property>
+ * </layout>
+ * </object>
+ * </child>
+ * <child>
+ * <object class="GtkButton" id="button2">
+ * <property name="label">Button 2</property>
+ * <layout>
+ * <property name="column">1</property>
+ * <property name="row">0</property>
+ * </layout>
+ * </object>
+ * </child>
+ * <child>
+ * <object class="GtkButton" id="button3">
+ * <property name="label">Button 3</property>
+ * <layout>
+ * <property name="column">2</property>
+ * <property name="row">0</property>
+ * <property name="row-span">2</property>
+ * </layout>
+ * </object>
+ * </child>
+ * <child>
+ * <object class="GtkButton" id="button4">
+ * <property name="label">Button 4</property>
+ * <layout>
+ * <property name="column">0</property>
+ * <property name="row">1</property>
+ * <property name="column-span">2</property>
+ * </layout>
+ * </object>
+ * </child>
+ * </object>
+ * ```
+ *
+ * It organizes the first two buttons side-by-side in one cell each.
+ * The third button is in the last column but spans across two rows.
+ * This is defined by the `row-span` property. The last button is
+ * located in the second row and spans across two columns, which is
+ * defined by the `column-span` property.
+ *
+ * # CSS nodes
+ *
+ * `GtkGrid` uses a single CSS node with name `grid`.
+ *
+ * # Accessibility
+ *
+ * Until GTK 4.10, `GtkGrid` used the [enum@Gtk.AccessibleRole.group] role.
+ *
+ * Starting from GTK 4.12, `GtkGrid` uses the [enum@Gtk.AccessibleRole.generic] role.
+ */
 export class Grid extends Widget {
+    /**
+     * Creates a new grid widget.
+     */
     constructor(...args) {
         super(...args);
     }
@@ -11,6 +99,18 @@ export class Grid extends Widget {
             borrowed: true,
         });
     }
+    /**
+     * Adds a widget to the grid.
+     *
+     * The position of `child` is determined by `column` and @row.
+     * The number of “cells” that `child` will occupy is determined
+     * by `width` and @height.
+     * @param child - the widget to add
+     * @param column - the column number to attach the left side of `child` to
+     * @param row - the row number to attach the top side of `child` to
+     * @param width - the number of columns that `child` will span
+     * @param height - the number of rows that `child` will span
+     */
     attach(child, column, row, width, height) {
         call("libgtk-4.so.1", "gtk_grid_attach", [
             {
@@ -39,6 +139,22 @@ export class Grid extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Adds a widget to the grid.
+     *
+     * The widget is placed next to @sibling, on the side determined by
+     * @side. When `sibling` is %NULL, the widget is placed in row (for
+     * left or right placement) or column 0 (for top or bottom placement),
+     * at the end indicated by @side.
+     *
+     * Attaching widgets labeled `[1]`, `[2]`, `[3]` with ``sibling` == %NULL` and
+     * ``side` == %GTK_POS_LEFT` yields a layout of `[3][2][1]`.
+     * @param child - the widget to add
+     * @param sibling - the child of `grid` that `child` will be placed
+     * @param side - the side of `sibling` that `child` is positioned next to
+     * @param width - the number of columns that `child` will span
+     * @param height - the number of rows that `child` will span
+     */
     attachNextTo(child, side, width, height, sibling) {
         call("libgtk-4.so.1", "gtk_grid_attach_next_to", [
             {
@@ -68,6 +184,9 @@ export class Grid extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Returns which row defines the global baseline of @grid.
+     */
     getBaselineRow() {
         return call("libgtk-4.so.1", "gtk_grid_get_baseline_row", [
             {
@@ -76,6 +195,12 @@ export class Grid extends Widget {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the child of `grid` whose area covers the grid
+     * cell at @column, @row.
+     * @param column - the left edge of the cell
+     * @param row - the top edge of the cell
+     */
     getChildAt(column, row) {
         const ptr = call("libgtk-4.so.1", "gtk_grid_get_child_at", [
             {
@@ -95,6 +220,9 @@ export class Grid extends Widget {
             return null;
         return getObject(ptr, Widget);
     }
+    /**
+     * Returns whether all columns of `grid` have the same width.
+     */
     getColumnHomogeneous() {
         return call("libgtk-4.so.1", "gtk_grid_get_column_homogeneous", [
             {
@@ -103,6 +231,9 @@ export class Grid extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns the amount of space between the columns of @grid.
+     */
     getColumnSpacing() {
         return call("libgtk-4.so.1", "gtk_grid_get_column_spacing", [
             {
@@ -111,6 +242,12 @@ export class Grid extends Widget {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Returns the baseline position of @row.
+     *
+     * See [method@Gtk.Grid.set_row_baseline_position].
+     * @param row - a row index
+     */
     getRowBaselinePosition(row) {
         return call("libgtk-4.so.1", "gtk_grid_get_row_baseline_position", [
             {
@@ -123,6 +260,9 @@ export class Grid extends Widget {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns whether all rows of `grid` have the same height.
+     */
     getRowHomogeneous() {
         return call("libgtk-4.so.1", "gtk_grid_get_row_homogeneous", [
             {
@@ -131,6 +271,9 @@ export class Grid extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns the amount of space between the rows of @grid.
+     */
     getRowSpacing() {
         return call("libgtk-4.so.1", "gtk_grid_get_row_spacing", [
             {
@@ -139,6 +282,14 @@ export class Grid extends Widget {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Inserts a column at the specified position.
+     *
+     * Children which are attached at or to the right of this position
+     * are moved one column to the right. Children which span across this
+     * position are grown to span the new column.
+     * @param position - the position to insert the column at
+     */
     insertColumn(position) {
         call("libgtk-4.so.1", "gtk_grid_insert_column", [
             {
@@ -151,6 +302,16 @@ export class Grid extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Inserts a row or column at the specified position.
+     *
+     * The new row or column is placed next to @sibling, on the side
+     * determined by @side. If `side` is %GTK_POS_TOP or %GTK_POS_BOTTOM,
+     * a row is inserted. If `side` is %GTK_POS_LEFT of %GTK_POS_RIGHT,
+     * a column is inserted.
+     * @param sibling - the child of `grid` that the new row or column will be
+     * @param side - the side of `sibling` that `child` is positioned next to
+     */
     insertNextTo(sibling, side) {
         call("libgtk-4.so.1", "gtk_grid_insert_next_to", [
             {
@@ -167,6 +328,14 @@ export class Grid extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Inserts a row at the specified position.
+     *
+     * Children which are attached at or below this position
+     * are moved one row down. Children which span across this
+     * position are grown to span the new row.
+     * @param position - the position to insert the row at
+     */
     insertRow(position) {
         call("libgtk-4.so.1", "gtk_grid_insert_row", [
             {
@@ -179,6 +348,14 @@ export class Grid extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Queries the attach points and spans of `child` inside the given `GtkGrid`.
+     * @param child - a `GtkWidget` child of @grid
+     * @param column - the column used to attach the left side of @child
+     * @param row - the row used to attach the top side of @child
+     * @param width - the number of columns `child` spans
+     * @param height - the number of rows `child` spans
+     */
     queryChild(child, column, row, width, height) {
         call("libgtk-4.so.1", "gtk_grid_query_child", [
             {
@@ -223,6 +400,13 @@ export class Grid extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Removes a child from @grid.
+     *
+     * The child must have been added with
+     * [method@Gtk.Grid.attach] or [method@Gtk.Grid.attach_next_to].
+     * @param child - the child widget to remove
+     */
     remove(child) {
         call("libgtk-4.so.1", "gtk_grid_remove", [
             {
@@ -235,6 +419,15 @@ export class Grid extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Removes a column from the grid.
+     *
+     * Children that are placed in this column are removed,
+     * spanning children that overlap this column have their
+     * width reduced by one, and children after the column
+     * are moved to the left.
+     * @param position - the position of the column to remove
+     */
     removeColumn(position) {
         call("libgtk-4.so.1", "gtk_grid_remove_column", [
             {
@@ -247,6 +440,15 @@ export class Grid extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Removes a row from the grid.
+     *
+     * Children that are placed in this row are removed,
+     * spanning children that overlap this row have their
+     * height reduced by one, and children below the row
+     * are moved up.
+     * @param position - the position of the row to remove
+     */
     removeRow(position) {
         call("libgtk-4.so.1", "gtk_grid_remove_row", [
             {
@@ -259,6 +461,14 @@ export class Grid extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * 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.
+     * @param row - the row index
+     */
     setBaselineRow(row) {
         call("libgtk-4.so.1", "gtk_grid_set_baseline_row", [
             {
@@ -271,6 +481,10 @@ export class Grid extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether all columns of `grid` will have the same width.
+     * @param homogeneous - %TRUE to make columns homogeneous
+     */
     setColumnHomogeneous(homogeneous) {
         call("libgtk-4.so.1", "gtk_grid_set_column_homogeneous", [
             {
@@ -283,6 +497,10 @@ export class Grid extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the amount of space between columns of @grid.
+     * @param spacing - the amount of space to insert between columns
+     */
     setColumnSpacing(spacing) {
         call("libgtk-4.so.1", "gtk_grid_set_column_spacing", [
             {
@@ -295,6 +513,14 @@ export class Grid extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * 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.
+     * @param row - a row index
+     * @param pos - a `GtkBaselinePosition`
+     */
     setRowBaselinePosition(row, pos) {
         call("libgtk-4.so.1", "gtk_grid_set_row_baseline_position", [
             {
@@ -311,6 +537,10 @@ export class Grid extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether all rows of `grid` will have the same height.
+     * @param homogeneous - %TRUE to make rows homogeneous
+     */
     setRowHomogeneous(homogeneous) {
         call("libgtk-4.so.1", "gtk_grid_set_row_homogeneous", [
             {
@@ -323,6 +553,10 @@ export class Grid extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the amount of space between rows of @grid.
+     * @param spacing - the amount of space to insert between rows
+     */
     setRowSpacing(spacing) {
         call("libgtk-4.so.1", "gtk_grid_set_row_spacing", [
             {
@@ -335,6 +569,9 @@ export class Grid extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Retrieves the orientation of the @orientable.
+     */
     getOrientation() {
         return call("libgtk-4.so.1", "gtk_orientable_get_orientation", [
             {
@@ -343,6 +580,10 @@ export class Grid extends Widget {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Sets the orientation of the @orientable.
+     * @param orientation - the orientable’s new orientation
+     */
     setOrientation(orientation) {
         call("libgtk-4.so.1", "gtk_orientable_set_orientation", [
             {