@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtk/color-dialog.js

@@ -2,7 +2,23 @@ import { call } from "@gtkx/native";
 import { NativeError, getObject } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
 import * as Gdk from "../gdk/index.js";
+/**
+ * Asynchronous API to present a color chooser dialog.
+ *
+ * `GtkColorDialog` collects the arguments that are needed to present
+ * the dialog to the user, such as a title for the dialog and whether
+ * it should be modal.
+ *
+ * The dialog is shown with the [method@Gtk.ColorDialog.choose_rgba]
+ * function.
+ *
+ * See [class@Gtk.ColorDialogButton] for a convenient control
+ * that uses `GtkColorDialog` and presents the results.
+ */
 export class ColorDialog extends GObject.GObject {
+    /**
+     * Creates a new `GtkColorDialog` object.
+     */
     constructor(...args) {
         super(...args);
     }
@@ -12,6 +28,10 @@ export class ColorDialog extends GObject.GObject {
             borrowed: false,
         });
     }
+    /**
+     * Promise-based version of chooseRgba.
+     * Presents a color chooser dialog to the user.
+     */
     chooseRgba(parent, initialColor, cancellable) {
         return new Promise((resolve, reject) => {
             const callback = (_source, asyncResult) => {
@@ -77,6 +97,11 @@ export class ColorDialog extends GObject.GObject {
             ], { type: "undefined" });
         });
     }
+    /**
+     * Returns whether the color chooser dialog
+     * blocks interaction with the parent window
+     * while it is presented.
+     */
     getModal() {
         return call("libgtk-4.so.1", "gtk_color_dialog_get_modal", [
             {
@@ -85,6 +110,10 @@ export class ColorDialog extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns the title that will be shown on the
+     * color chooser dialog.
+     */
     getTitle() {
         return call("libgtk-4.so.1", "gtk_color_dialog_get_title", [
             {
@@ -93,6 +122,9 @@ export class ColorDialog extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns whether colors may have alpha.
+     */
     getWithAlpha() {
         return call("libgtk-4.so.1", "gtk_color_dialog_get_with_alpha", [
             {
@@ -101,6 +133,12 @@ export class ColorDialog extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets whether the color chooser dialog
+     * blocks interaction with the parent window
+     * while it is presented.
+     * @param modal - the new value
+     */
     setModal(modal) {
         call("libgtk-4.so.1", "gtk_color_dialog_set_modal", [
             {
@@ -113,6 +151,11 @@ export class ColorDialog extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the title that will be shown on the
+     * color chooser dialog.
+     * @param title - the new title
+     */
     setTitle(title) {
         call("libgtk-4.so.1", "gtk_color_dialog_set_title", [
             {
@@ -125,6 +168,10 @@ export class ColorDialog extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether colors may have alpha.
+     * @param withAlpha - the new value
+     */
     setWithAlpha(withAlpha) {
         call("libgtk-4.so.1", "gtk_color_dialog_set_with_alpha", [
             {

package/dist/generated/gtk/column-view-cell.d.ts

@@ -1,4 +1,21 @@
 import { ListItem } from "./list-item.js";
+/**
+ * Represents items in a cell in [class@Gtk.ColumnView].
+ *
+ * The `GtkColumnViewCell`s are managed by the [class@Gtk.ColumnView]
+ * widget (with its factory) and cannot be created by applications, but
+ * they need to be populated by application code. This is done by calling
+ * [method@Gtk.ColumnViewCell.set_child].
+ *
+ * `GtkColumnViewCell`s exist in 2 stages:
+ *
+ * 1. The unbound stage where the listitem is not currently connected to
+ * an item in the list. In that case, the [property@Gtk.ColumnViewCell:item]
+ * property is set to %NULL.
+ *
+ * 2. The bound stage where the listitem references an item from the list.
+ * The [property@Gtk.ColumnViewCell:item] property is not %NULL.
+ */
 export declare class ColumnViewCell extends ListItem {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;

package/dist/generated/gtk/column-view-cell.js

@@ -1,5 +1,22 @@
 import { call } from "@gtkx/native";
 import { ListItem } from "./list-item.js";
+/**
+ * Represents items in a cell in [class@Gtk.ColumnView].
+ *
+ * The `GtkColumnViewCell`s are managed by the [class@Gtk.ColumnView]
+ * widget (with its factory) and cannot be created by applications, but
+ * they need to be populated by application code. This is done by calling
+ * [method@Gtk.ColumnViewCell.set_child].
+ *
+ * `GtkColumnViewCell`s exist in 2 stages:
+ *
+ * 1. The unbound stage where the listitem is not currently connected to
+ * an item in the list. In that case, the [property@Gtk.ColumnViewCell:item]
+ * property is set to %NULL.
+ *
+ * 2. The bound stage where the listitem references an item from the list.
+ * The [property@Gtk.ColumnViewCell:item] property is not %NULL.
+ */
 export class ColumnViewCell extends ListItem {
     constructor(...args) {
         super(...args);

package/dist/generated/gtk/column-view-column.d.ts

@@ -3,28 +3,155 @@ import { ListItemFactory } from "./list-item-factory.js";
 import { Sorter } from "./sorter.js";
 import * as GObject from "../gobject/index.js";
 import * as Gio from "../gio/index.js";
+/**
+ * Represents the columns in a `GtkColumnView`.
+ *
+ * The main ingredient for a `GtkColumnViewColumn` is the `GtkListItemFactory`
+ * that tells the columnview how to create cells for this column from items in
+ * the model.
+ *
+ * Columns have a title, and can optionally have a header menu set
+ * with [method@Gtk.ColumnViewColumn.set_header_menu].
+ *
+ * A sorter can be associated with a column using
+ * [method@Gtk.ColumnViewColumn.set_sorter], to let users influence sorting
+ * by clicking on the column header.
+ */
 export declare class ColumnViewColumn extends GObject.GObject {
+    /**
+     * Creates a new `GtkColumnViewColumn` that uses the given `factory` for
+     * mapping items to widgets.
+     *
+     * 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:
+     *
+     * ```c
+     * column = gtk_column_view_column_new (_("Name"),
+     * gtk_builder_list_item_factory_new_from_resource ("/name.ui"));
+     * ```
+     * @param title - Title to use for this column
+     * @param factory - The factory to populate items with
+     */
     constructor(title?: string | null, factory?: ListItemFactory | null);
     constructor(...args: unknown[]);
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Gets the column view that's currently displaying this column.
+     *
+     * If `self` has not been added to a column view yet, `NULL` is returned.
+     */
     getColumnView(): ColumnView | null;
+    /**
+     * Returns whether this column should expand.
+     */
     getExpand(): boolean;
+    /**
+     * Gets the factory that's currently used to populate list items
+     * for this column.
+     */
     getFactory(): ListItemFactory | null;
+    /**
+     * Gets the fixed width of the column.
+     */
     getFixedWidth(): number;
+    /**
+     * Gets the menu model that is used to create the context menu
+     * for the column header.
+     */
     getHeaderMenu(): Gio.MenuModel | null;
+    /**
+     * Returns the ID set with [method@Gtk.ColumnViewColumn.set_id].
+     */
     getId(): string | null;
+    /**
+     * Returns whether this column is resizable.
+     */
     getResizable(): boolean;
+    /**
+     * Returns the sorter that is associated with the column.
+     */
     getSorter(): Sorter | null;
+    /**
+     * Returns the title set with [method@Gtk.ColumnViewColumn.set_title].
+     */
     getTitle(): string | null;
+    /**
+     * Returns whether this column is visible.
+     */
     getVisible(): boolean;
+    /**
+     * Sets the column to take available extra space.
+     *
+     * The extra space is shared equally amongst all columns that
+     * have are set to expand.
+     * @param expand - whether this column should expand to fill available space
+     */
     setExpand(expand: boolean): void;
+    /**
+     * Sets the `GtkListItemFactory` to use for populating list items
+     * for this column.
+     * @param factory - the factory to use
+     */
     setFactory(factory?: ListItemFactory | null): void;
+    /**
+     * Sets the fixed width of the column.
+     *
+     * If `fixed_width` is -1, the fixed width of the column is unset.
+     *
+     * Setting a fixed width overrides the automatically calculated
+     * width. Interactive resizing also sets the “fixed-width” property.
+     * @param fixedWidth - the new fixed width, or -1
+     */
     setFixedWidth(fixedWidth: number): void;
+    /**
+     * Sets the menu model that is used to create the context menu
+     * for the column header.
+     * @param menu - a `GMenuModel`
+     */
     setHeaderMenu(menu?: Gio.MenuModel | null): void;
+    /**
+     * Sets the id of this column.
+     *
+     * GTK makes no use of this, but applications can use it when
+     * storing column view configuration.
+     *
+     * It is up to callers to ensure uniqueness of IDs.
+     * @param id - ID to use for this column
+     */
     setId(id?: string | null): void;
+    /**
+     * Sets whether this column should be resizable by dragging.
+     * @param resizable - whether this column should be resizable
+     */
     setResizable(resizable: boolean): void;
+    /**
+     * Associates a sorter with the column.
+     *
+     * If `sorter` is unset, 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 [method@Gtk.ColumnView.sort_by_column].
+     *
+     * See [method@Gtk.ColumnView.get_sorter] for the necessary steps
+     * for setting up customizable sorting for [class@Gtk.ColumnView].
+     * @param sorter - the `GtkSorter` to associate with @column
+     */
     setSorter(sorter?: Sorter | null): void;
+    /**
+     * 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.
+     * @param title - Title to use for this column
+     */
     setTitle(title?: string | null): void;
+    /**
+     * Sets whether this column should be visible in views.
+     * @param visible - whether this column should be visible
+     */
     setVisible(visible: boolean): void;
     connect(signal: "notify", handler: (self: ColumnViewColumn, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gtk/column-view-column.js

@@ -5,6 +5,20 @@ import { ListItemFactory } from "./list-item-factory.js";
 import { Sorter } from "./sorter.js";
 import * as GObject from "../gobject/index.js";
 import * as Gio from "../gio/index.js";
+/**
+ * Represents the columns in a `GtkColumnView`.
+ *
+ * The main ingredient for a `GtkColumnViewColumn` is the `GtkListItemFactory`
+ * that tells the columnview how to create cells for this column from items in
+ * the model.
+ *
+ * Columns have a title, and can optionally have a header menu set
+ * with [method@Gtk.ColumnViewColumn.set_header_menu].
+ *
+ * A sorter can be associated with a column using
+ * [method@Gtk.ColumnViewColumn.set_sorter], to let users influence sorting
+ * by clicking on the column header.
+ */
 export class ColumnViewColumn extends GObject.GObject {
     constructor(...args) {
         super(...args);
@@ -24,6 +38,11 @@ export class ColumnViewColumn extends GObject.GObject {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Gets the column view that's currently displaying this column.
+     *
+     * If `self` has not been added to a column view yet, `NULL` is returned.
+     */
     getColumnView() {
         const ptr = call("libgtk-4.so.1", "gtk_column_view_column_get_column_view", [
             {
@@ -35,6 +54,9 @@ export class ColumnViewColumn extends GObject.GObject {
             return null;
         return getObject(ptr, ColumnView);
     }
+    /**
+     * Returns whether this column should expand.
+     */
     getExpand() {
         return call("libgtk-4.so.1", "gtk_column_view_column_get_expand", [
             {
@@ -43,6 +65,10 @@ export class ColumnViewColumn extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the factory that's currently used to populate list items
+     * for this column.
+     */
     getFactory() {
         const ptr = call("libgtk-4.so.1", "gtk_column_view_column_get_factory", [
             {
@@ -54,6 +80,9 @@ export class ColumnViewColumn extends GObject.GObject {
             return null;
         return getObject(ptr, ListItemFactory);
     }
+    /**
+     * Gets the fixed width of the column.
+     */
     getFixedWidth() {
         return call("libgtk-4.so.1", "gtk_column_view_column_get_fixed_width", [
             {
@@ -62,6 +91,10 @@ export class ColumnViewColumn extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the menu model that is used to create the context menu
+     * for the column header.
+     */
     getHeaderMenu() {
         const ptr = call("libgtk-4.so.1", "gtk_column_view_column_get_header_menu", [
             {
@@ -73,6 +106,9 @@ export class ColumnViewColumn extends GObject.GObject {
             return null;
         return getObject(ptr, Gio.MenuModel);
     }
+    /**
+     * Returns the ID set with [method@Gtk.ColumnViewColumn.set_id].
+     */
     getId() {
         return call("libgtk-4.so.1", "gtk_column_view_column_get_id", [
             {
@@ -81,6 +117,9 @@ export class ColumnViewColumn extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns whether this column is resizable.
+     */
     getResizable() {
         return call("libgtk-4.so.1", "gtk_column_view_column_get_resizable", [
             {
@@ -89,6 +128,9 @@ export class ColumnViewColumn extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns the sorter that is associated with the column.
+     */
     getSorter() {
         const ptr = call("libgtk-4.so.1", "gtk_column_view_column_get_sorter", [
             {
@@ -100,6 +142,9 @@ export class ColumnViewColumn extends GObject.GObject {
             return null;
         return getObject(ptr, Sorter);
     }
+    /**
+     * Returns the title set with [method@Gtk.ColumnViewColumn.set_title].
+     */
     getTitle() {
         return call("libgtk-4.so.1", "gtk_column_view_column_get_title", [
             {
@@ -108,6 +153,9 @@ export class ColumnViewColumn extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns whether this column is visible.
+     */
     getVisible() {
         return call("libgtk-4.so.1", "gtk_column_view_column_get_visible", [
             {
@@ -116,6 +164,13 @@ export class ColumnViewColumn extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets the column to take available extra space.
+     *
+     * The extra space is shared equally amongst all columns that
+     * have are set to expand.
+     * @param expand - whether this column should expand to fill available space
+     */
     setExpand(expand) {
         call("libgtk-4.so.1", "gtk_column_view_column_set_expand", [
             {
@@ -128,6 +183,11 @@ export class ColumnViewColumn extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the `GtkListItemFactory` to use for populating list items
+     * for this column.
+     * @param factory - the factory to use
+     */
     setFactory(factory) {
         call("libgtk-4.so.1", "gtk_column_view_column_set_factory", [
             {
@@ -141,6 +201,15 @@ export class ColumnViewColumn extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the fixed width of the column.
+     *
+     * If `fixed_width` is -1, the fixed width of the column is unset.
+     *
+     * Setting a fixed width overrides the automatically calculated
+     * width. Interactive resizing also sets the “fixed-width” property.
+     * @param fixedWidth - the new fixed width, or -1
+     */
     setFixedWidth(fixedWidth) {
         call("libgtk-4.so.1", "gtk_column_view_column_set_fixed_width", [
             {
@@ -153,6 +222,11 @@ export class ColumnViewColumn extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the menu model that is used to create the context menu
+     * for the column header.
+     * @param menu - a `GMenuModel`
+     */
     setHeaderMenu(menu) {
         call("libgtk-4.so.1", "gtk_column_view_column_set_header_menu", [
             {
@@ -166,6 +240,15 @@ export class ColumnViewColumn extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the id of this column.
+     *
+     * GTK makes no use of this, but applications can use it when
+     * storing column view configuration.
+     *
+     * It is up to callers to ensure uniqueness of IDs.
+     * @param id - ID to use for this column
+     */
     setId(id) {
         call("libgtk-4.so.1", "gtk_column_view_column_set_id", [
             {
@@ -179,6 +262,10 @@ export class ColumnViewColumn extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether this column should be resizable by dragging.
+     * @param resizable - whether this column should be resizable
+     */
     setResizable(resizable) {
         call("libgtk-4.so.1", "gtk_column_view_column_set_resizable", [
             {
@@ -191,6 +278,19 @@ export class ColumnViewColumn extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Associates a sorter with the column.
+     *
+     * If `sorter` is unset, 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 [method@Gtk.ColumnView.sort_by_column].
+     *
+     * See [method@Gtk.ColumnView.get_sorter] for the necessary steps
+     * for setting up customizable sorting for [class@Gtk.ColumnView].
+     * @param sorter - the `GtkSorter` to associate with @column
+     */
     setSorter(sorter) {
         call("libgtk-4.so.1", "gtk_column_view_column_set_sorter", [
             {
@@ -204,6 +304,14 @@ export class ColumnViewColumn extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * 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.
+     * @param title - Title to use for this column
+     */
     setTitle(title) {
         call("libgtk-4.so.1", "gtk_column_view_column_set_title", [
             {
@@ -217,6 +325,10 @@ export class ColumnViewColumn extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether this column should be visible in views.
+     * @param visible - whether this column should be visible
+     */
     setVisible(visible) {
         call("libgtk-4.so.1", "gtk_column_view_column_set_visible", [
             {

package/dist/generated/gtk/column-view-row.d.ts

@@ -1,19 +1,108 @@
 import * as GObject from "../gobject/index.js";
+/**
+ * Configures how rows are displayed in a [class@Gtk.ColumnView].
+ *
+ * It is not used to set the widgets displayed in the individual cells. For that
+ * see [method@GtkColumnViewColumn.set_factory] and [class@GtkColumnViewCell].
+ */
 export declare class ColumnViewRow extends GObject.GObject {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Gets the accessible description of @self.
+     */
     getAccessibleDescription(): string;
+    /**
+     * Gets the accessible label of @self.
+     */
     getAccessibleLabel(): string;
+    /**
+     * Checks if the row has been set to be activatable via
+     * gtk_column_view_row_set_activatable().
+     */
     getActivatable(): boolean;
+    /**
+     * Checks if a row item has been set to be focusable via
+     * gtk_column_view_row_set_focusable().
+     */
     getFocusable(): boolean;
+    /**
+     * Gets the model item that associated with @self.
+     *
+     * If `self` is unbound, this function returns %NULL.
+     */
     getItem(): GObject.GObject | null;
+    /**
+     * Gets the position in the model that `self` currently displays.
+     *
+     * If `self` is unbound, %GTK_INVALID_LIST_POSITION is returned.
+     */
     getPosition(): number;
+    /**
+     * Checks if the row has been set to be selectable via
+     * gtk_column_view_row_set_selectable().
+     *
+     * Do not confuse this function with [method@Gtk.ColumnViewRow.get_selected].
+     */
     getSelectable(): boolean;
+    /**
+     * Checks if the item is selected that this row corresponds to.
+     *
+     * The selected state is maintained by the list widget and its model
+     * and cannot be set otherwise.
+     */
     getSelected(): boolean;
+    /**
+     * Sets the accessible description for the row,
+     * which may be used by e.g. screen readers.
+     * @param description - the description
+     */
     setAccessibleDescription(description: string): void;
+    /**
+     * Sets the accessible label for the row,
+     * which may be used by e.g. screen readers.
+     * @param label - the label
+     */
     setAccessibleLabel(label: string): void;
+    /**
+     * Sets `self` to be activatable.
+     *
+     * If a row is activatable, double-clicking on the row, using
+     * the Return key or calling gtk_widget_activate() will activate
+     * the row. Activating instructs the containing columnview to
+     * emit the [signal@Gtk.ColumnView::activate] signal.
+     *
+     * By default, row are activatable.
+     * @param activatable - if the row should be activatable
+     */
     setActivatable(activatable: boolean): void;
+    /**
+     * Sets `self` to be focusable.
+     *
+     * If a row is focusable, it can be focused using the keyboard.
+     * This works similar to [method@Gtk.Widget.set_focusable].
+     *
+     * Note that if row are not focusable, the contents of cells can still be focused if
+     * they are focusable.
+     *
+     * By default, rows are focusable.
+     * @param focusable - if the row should be focusable
+     */
     setFocusable(focusable: boolean): void;
+    /**
+     * Sets `self` to be selectable.
+     *
+     * If a row is selectable, clicking on the row or using the keyboard
+     * will try to select or unselect the row. Whether this succeeds is up to
+     * the model to determine, as it is managing the selected state.
+     *
+     * Note that this means that making a row non-selectable has no
+     * influence on the selected state at all. A non-selectable row
+     * may still be selected.
+     *
+     * By default, rows are selectable.
+     * @param selectable - if the row should be selectable
+     */
     setSelectable(selectable: boolean): void;
     connect(signal: "notify", handler: (self: ColumnViewRow, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;