@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtk/paned.js

@@ -1,6 +1,86 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { Widget } from "./widget.js";
+/**
+ * Arranges its children in two panes, horizontally or vertically.
+ *
+ *
+ *
+ * The division between the two panes is adjustable by the user
+ * by dragging a handle.
+ *
+ * Child widgets are added to the panes of the widget with
+ * [method@Gtk.Paned.set_start_child] and [method@Gtk.Paned.set_end_child].
+ * The division between the two children is set by default from the size
+ * requests of the children, but it can be adjusted by the user.
+ *
+ * A paned widget draws a separator between the two child widgets and a
+ * small handle that the user can drag to adjust the division. It does not
+ * draw any relief around the children or around the separator. (The space
+ * in which the separator is called the gutter.) Often, it is useful to put
+ * each child inside a [class@Gtk.Frame] so that the gutter appears as a
+ * ridge. No separator is drawn if one of the children is missing.
+ *
+ * Each child has two options that can be set, "resize" and "shrink". If
+ * "resize" is true then, when the `GtkPaned` is resized, that child will
+ * expand or shrink along with the paned widget. If "shrink" is true, then
+ * that child can be made smaller than its requisition by the user.
+ * Setting "shrink" to false allows the application to set a minimum size.
+ * If "resize" is false for both children, then this is treated as if
+ * "resize" is true for both children.
+ *
+ * The application can set the position of the slider as if it were set
+ * by the user, by calling [method@Gtk.Paned.set_position].
+ *
+ * # Shortcuts and Gestures
+ *
+ * The following signals have default keybindings:
+ *
+ * - [signal@Gtk.Paned::accept-position]
+ * - [signal@Gtk.Paned::cancel-position]
+ * - [signal@Gtk.Paned::cycle-child-focus]
+ * - [signal@Gtk.Paned::cycle-handle-focus]
+ * - [signal@Gtk.Paned::move-handle]
+ * - [signal@Gtk.Paned::toggle-handle-focus]
+ *
+ * # CSS nodes
+ *
+ * ```
+ * paned
+ * ├── <child>
+ * ├── separator[.wide]
+ * ╰── <child>
+ * ```
+ *
+ * `GtkPaned` has a main CSS node with name paned, and a subnode for
+ * the separator with name separator. The subnode gets a .wide style
+ * class when the paned is supposed to be wide.
+ *
+ * In horizontal orientation, the nodes are arranged based on the text
+ * direction, so in left-to-right mode, :first-child will select the
+ * leftmost child, while it will select the rightmost child in
+ * RTL layouts.
+ *
+ * ## Creating a paned widget with minimum sizes.
+ *
+ * ```c
+ * GtkWidget *hpaned = gtk_paned_new (GTK_ORIENTATION_HORIZONTAL);
+ * GtkWidget *frame1 = gtk_frame_new (NULL);
+ * GtkWidget *frame2 = gtk_frame_new (NULL);
+ *
+ * gtk_widget_set_size_request (hpaned, 200, -1);
+ *
+ * gtk_paned_set_start_child (GTK_PANED (hpaned), frame1);
+ * gtk_paned_set_resize_start_child (GTK_PANED (hpaned), TRUE);
+ * gtk_paned_set_shrink_start_child (GTK_PANED (hpaned), FALSE);
+ * gtk_widget_set_size_request (frame1, 50, -1);
+ *
+ * gtk_paned_set_end_child (GTK_PANED (hpaned), frame2);
+ * gtk_paned_set_resize_end_child (GTK_PANED (hpaned), FALSE);
+ * gtk_paned_set_shrink_end_child (GTK_PANED (hpaned), FALSE);
+ * gtk_widget_set_size_request (frame2, 50, -1);
+ * ```
+ */
 const SIGNAL_META = {
     "accept-position": { params: [], returnType: { type: "boolean" } },
     "cancel-position": { params: [], returnType: { type: "boolean" } },
@@ -31,6 +111,9 @@ export class Paned extends Widget {
             },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Retrieves the end child of the given `GtkPaned`.
+     */
     getEndChild() {
         const ptr = call("libgtk-4.so.1", "gtk_paned_get_end_child", [
             {
@@ -42,6 +125,9 @@ export class Paned extends Widget {
             return null;
         return getObject(ptr, Widget);
     }
+    /**
+     * Obtains the position of the divider between the two panes.
+     */
     getPosition() {
         return call("libgtk-4.so.1", "gtk_paned_get_position", [
             {
@@ -50,6 +136,9 @@ export class Paned extends Widget {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns whether the [property@Gtk.Paned:end-child] can be resized.
+     */
     getResizeEndChild() {
         return call("libgtk-4.so.1", "gtk_paned_get_resize_end_child", [
             {
@@ -58,6 +147,9 @@ export class Paned extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns whether the [property@Gtk.Paned:start-child] can be resized.
+     */
     getResizeStartChild() {
         return call("libgtk-4.so.1", "gtk_paned_get_resize_start_child", [
             {
@@ -66,6 +158,9 @@ export class Paned extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns whether the [property@Gtk.Paned:end-child] can shrink.
+     */
     getShrinkEndChild() {
         return call("libgtk-4.so.1", "gtk_paned_get_shrink_end_child", [
             {
@@ -74,6 +169,9 @@ export class Paned extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns whether the [property@Gtk.Paned:start-child] can shrink.
+     */
     getShrinkStartChild() {
         return call("libgtk-4.so.1", "gtk_paned_get_shrink_start_child", [
             {
@@ -82,6 +180,9 @@ export class Paned extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Retrieves the start child of the given `GtkPaned`.
+     */
     getStartChild() {
         const ptr = call("libgtk-4.so.1", "gtk_paned_get_start_child", [
             {
@@ -93,6 +194,9 @@ export class Paned extends Widget {
             return null;
         return getObject(ptr, Widget);
     }
+    /**
+     * Gets whether the separator should be wide.
+     */
     getWideHandle() {
         return call("libgtk-4.so.1", "gtk_paned_get_wide_handle", [
             {
@@ -101,6 +205,12 @@ export class Paned extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets the end child of `paned` to @child.
+     *
+     * If `child` is `NULL`, the existing child will be removed.
+     * @param child - the widget to add
+     */
     setEndChild(child) {
         call("libgtk-4.so.1", "gtk_paned_set_end_child", [
             {
@@ -114,6 +224,10 @@ export class Paned extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the position of the divider between the two panes.
+     * @param position - pixel position of divider, a negative value means that the position
+     */
     setPosition(position) {
         call("libgtk-4.so.1", "gtk_paned_set_position", [
             {
@@ -126,6 +240,10 @@ export class Paned extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the [property@Gtk.Paned:end-child] can be resized.
+     * @param resize - true to let the end child be resized
+     */
     setResizeEndChild(resize) {
         call("libgtk-4.so.1", "gtk_paned_set_resize_end_child", [
             {
@@ -138,6 +256,10 @@ export class Paned extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the [property@Gtk.Paned:start-child] can be resized.
+     * @param resize - true to let the start child be resized
+     */
     setResizeStartChild(resize) {
         call("libgtk-4.so.1", "gtk_paned_set_resize_start_child", [
             {
@@ -150,6 +272,10 @@ export class Paned extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the [property@Gtk.Paned:end-child] can shrink.
+     * @param resize - true to let the end child be shrunk
+     */
     setShrinkEndChild(resize) {
         call("libgtk-4.so.1", "gtk_paned_set_shrink_end_child", [
             {
@@ -162,6 +288,10 @@ export class Paned extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the [property@Gtk.Paned:start-child] can shrink.
+     * @param resize - true to let the start child be shrunk
+     */
     setShrinkStartChild(resize) {
         call("libgtk-4.so.1", "gtk_paned_set_shrink_start_child", [
             {
@@ -174,6 +304,12 @@ export class Paned extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the start child of `paned` to @child.
+     *
+     * If `child` is `NULL`, the existing child will be removed.
+     * @param child - the widget to add
+     */
     setStartChild(child) {
         call("libgtk-4.so.1", "gtk_paned_set_start_child", [
             {
@@ -187,6 +323,10 @@ export class Paned extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the separator should be wide.
+     * @param wide - the new value for the [property@Gtk.Paned:wide-handle] property
+     */
     setWideHandle(wide) {
         call("libgtk-4.so.1", "gtk_paned_set_wide_handle", [
             {
@@ -199,6 +339,9 @@ export class Paned extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Retrieves the orientation of the @orientable.
+     */
     getOrientation() {
         return call("libgtk-4.so.1", "gtk_orientable_get_orientation", [
             {
@@ -207,6 +350,10 @@ export class Paned 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", [
             {

package/dist/generated/gtk/paper-size.d.ts

@@ -1,32 +1,173 @@
 import { Unit } from "./enums.js";
 import * as GLib from "../glib/index.js";
+/**
+ * `GtkPaperSize` handles paper sizes.
+ *
+ * It uses the standard called
+ * PWG 5101.1-2002 PWG: Standard for Media Standardized Names
+ * to name the paper sizes (and to get the data for the page sizes).
+ * In addition to standard paper sizes, `GtkPaperSize` allows to
+ * construct custom paper sizes with arbitrary dimensions.
+ *
+ * The `GtkPaperSize` object stores not only the dimensions (width
+ * and height) of a paper size and its name, it also provides
+ * default print margins.
+ */
 export declare class PaperSize {
     ptr: unknown;
+    /**
+     * 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 [func@Gtk.PaperSize.get_default].
+     * @param name - a paper size name
+     */
     constructor(name?: string | null);
     constructor(_args: unknown[]);
+    /**
+     * Creates a new `GtkPaperSize` object with the
+     * given parameters.
+     * @param name - the paper name
+     * @param displayName - the human-readable name
+     * @param width - the paper width, in units of @unit
+     * @param height - the paper height, in units of @unit
+     * @param unit - the unit for `width` and @height. not %GTK_UNIT_NONE.
+     */
     static sizeNewCustom(name: string, displayName: string, width: number, height: number, unit: Unit): PaperSize;
+    /**
+     * Deserialize a paper size from a `GVariant`.
+     *
+     * The `GVariant must be in the format produced by
+     * [method@Gtk.PaperSize.to_gvariant].
+     * @param variant - an a{sv} `GVariant`
+     */
     static sizeNewFromGvariant(variant: GLib.Variant): PaperSize;
+    /**
+     * 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.
+     * @param ippName - an IPP paper name
+     * @param width - the paper width, in points
+     * @param height - the paper height in points
+     */
     static sizeNewFromIpp(ippName: string, width: number, height: number): PaperSize;
+    /**
+     * Reads a paper size from the group `group_name` in the key file
+     * @key_file.
+     * @param keyFile - the `GKeyFile` to retrieve the papersize from
+     * @param groupName - the name of the group in the key file to read,
+     */
     static sizeNewFromKeyFile(keyFile: GLib.KeyFile, groupName?: string | null): PaperSize;
+    /**
+     * 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.
+     * @param ppdName - a PPD paper name
+     * @param ppdDisplayName - the corresponding human-readable name
+     * @param width - the paper width, in points
+     * @param height - the paper height in points
+     */
     static sizeNewFromPpd(ppdName: string, ppdDisplayName: string, width: number, height: number): PaperSize;
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Returns the name of the default paper size, which
+     * depends on the current locale.
+     */
     static getDefault(): string;
+    /**
+     * Creates a list of known paper sizes.
+     * @param includeCustom - whether to include custom paper sizes
+     */
     static getPaperSizes(includeCustom: boolean): PaperSize[];
+    /**
+     * Copies an existing `GtkPaperSize`.
+     */
     copy(): PaperSize;
+    /**
+     * Free the given `GtkPaperSize` object.
+     */
     free(): void;
+    /**
+     * Gets the default bottom margin for the `GtkPaperSize`.
+     * @param unit - the unit for the return value, not %GTK_UNIT_NONE
+     */
     getDefaultBottomMargin(unit: Unit): number;
+    /**
+     * Gets the default left margin for the `GtkPaperSize`.
+     * @param unit - the unit for the return value, not %GTK_UNIT_NONE
+     */
     getDefaultLeftMargin(unit: Unit): number;
+    /**
+     * Gets the default right margin for the `GtkPaperSize`.
+     * @param unit - the unit for the return value, not %GTK_UNIT_NONE
+     */
     getDefaultRightMargin(unit: Unit): number;
+    /**
+     * Gets the default top margin for the `GtkPaperSize`.
+     * @param unit - the unit for the return value, not %GTK_UNIT_NONE
+     */
     getDefaultTopMargin(unit: Unit): number;
+    /**
+     * Gets the human-readable name of the `GtkPaperSize`.
+     */
     getDisplayName(): string;
+    /**
+     * Gets the paper height of the `GtkPaperSize`, in
+     * units of @unit.
+     * @param unit - the unit for the return value, not %GTK_UNIT_NONE
+     */
     getHeight(unit: Unit): number;
+    /**
+     * Gets the name of the `GtkPaperSize`.
+     */
     getName(): string;
+    /**
+     * Gets the PPD name of the `GtkPaperSize`, which
+     * may be %NULL.
+     */
     getPpdName(): string;
+    /**
+     * Gets the paper width of the `GtkPaperSize`, in
+     * units of @unit.
+     * @param unit - the unit for the return value, not %GTK_UNIT_NONE
+     */
     getWidth(unit: Unit): number;
+    /**
+     * Returns %TRUE if `size` is not a standard paper size.
+     */
     isCustom(): boolean;
+    /**
+     * Compares two `GtkPaperSize` objects.
+     * @param size2 - another `GtkPaperSize` object
+     */
     isEqual(size2: PaperSize): boolean;
+    /**
+     * Returns %TRUE if `size` is an IPP standard paper size.
+     */
     isIpp(): boolean;
+    /**
+     * Changes the dimensions of a `size` to `width` x @height.
+     * @param width - the new width in units of @unit
+     * @param height - the new height in units of @unit
+     * @param unit - the unit for `width` and @height
+     */
     setSize(width: number, height: number, unit: Unit): void;
+    /**
+     * Serialize a paper size to an `a{sv}` variant.
+     */
     toGvariant(): GLib.Variant;
+    /**
+     * This function adds the paper size from `size` to @key_file.
+     * @param keyFile - the `GKeyFile` to save the paper size to
+     * @param groupName - the group to add the settings to in @key_file
+     */
     toKeyFile(keyFile: GLib.KeyFile, groupName: string): void;
 }