@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtk/page-setup.js

@@ -3,10 +3,65 @@ import { NativeError, getObject } from "@gtkx/ffi";
 import { PaperSize } from "./paper-size.js";
 import * as GLib from "../glib/index.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * Stores page size, orientation and margins for printing.
+ *
+ * The idea is that you can get one of these from the page setup dialog
+ * and then pass it to the `GtkPrintOperation` when printing.
+ * The benefit of splitting this out of the `GtkPrintSettings` is that
+ * these affect the actual layout of the page, and thus need to be set
+ * long before user prints.
+ *
+ * ## Margins
+ *
+ * The margins specified in this object are the “print margins”, i.e. the
+ * parts of the page that the printer cannot print on. These are different
+ * from the layout margins that a word processor uses; they are typically
+ * used to determine the minimal size for the layout margins.
+ *
+ * To obtain a `GtkPageSetup` use [ctor@Gtk.PageSetup.new] to get the defaults,
+ * or use [func@Gtk.print_run_page_setup_dialog] to show the page setup dialog
+ * and receive the resulting page setup.
+ *
+ * ## A page setup dialog
+ *
+ * ```c
+ * static GtkPrintSettings *settings = NULL;
+ * static GtkPageSetup *page_setup = NULL;
+ *
+ * static void
+ * do_page_setup (void)
+ * {
+ * GtkPageSetup *new_page_setup;
+ *
+ * if (settings == NULL)
+ * settings = gtk_print_settings_new ();
+ *
+ * new_page_setup = gtk_print_run_page_setup_dialog (GTK_WINDOW (main_window),
+ * page_setup, settings);
+ *
+ * if (page_setup)
+ * g_object_unref (page_setup);
+ *
+ * page_setup = new_page_setup;
+ * }
+ * ```
+ */
 export class PageSetup extends GObject.GObject {
+    /**
+     * Creates a new `GtkPageSetup`.
+     */
     constructor(...args) {
         super(...args);
     }
+    /**
+     * 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 [method@Gtk.PageSetup.to_file].
+     * @param fileName - the filename to read the page setup from
+     */
     static setupNewFromFile(fileName) {
         const ptr = call("libgtk-4.so.1", "gtk_page_setup_new_from_file", [
             {
@@ -16,6 +71,13 @@ export class PageSetup extends GObject.GObject {
         ], { type: "gobject", borrowed: false });
         return getObject(ptr, PageSetup);
     }
+    /**
+     * Desrialize a page setup from an a{sv} variant.
+     *
+     * The variant must be in the format produced by
+     * [method@Gtk.PageSetup.to_gvariant].
+     * @param variant - an a{sv} `GVariant`
+     */
     static setupNewFromGvariant(variant) {
         const ptr = call("libgtk-4.so.1", "gtk_page_setup_new_from_gvariant", [
             {
@@ -30,6 +92,15 @@ export class PageSetup extends GObject.GObject {
         ], { type: "gobject", borrowed: false });
         return getObject(ptr, PageSetup);
     }
+    /**
+     * 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.
+     * @param keyFile - the `GKeyFile` to retrieve the page_setup from
+     * @param groupName - the name of the group in the key_file to read
+     */
     static setupNewFromKeyFile(keyFile, groupName) {
         const ptr = call("libgtk-4.so.1", "gtk_page_setup_new_from_key_file", [
             {
@@ -55,6 +126,9 @@ export class PageSetup extends GObject.GObject {
             borrowed: false,
         });
     }
+    /**
+     * Copies a `GtkPageSetup`.
+     */
     copy() {
         const ptr = call("libgtk-4.so.1", "gtk_page_setup_copy", [
             {
@@ -64,6 +138,10 @@ export class PageSetup extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, PageSetup);
     }
+    /**
+     * Gets the bottom margin in units of @unit.
+     * @param unit - the unit for the return value
+     */
     getBottomMargin(unit) {
         return call("libgtk-4.so.1", "gtk_page_setup_get_bottom_margin", [
             {
@@ -76,6 +154,10 @@ export class PageSetup extends GObject.GObject {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Gets the left margin in units of @unit.
+     * @param unit - the unit for the return value
+     */
     getLeftMargin(unit) {
         return call("libgtk-4.so.1", "gtk_page_setup_get_left_margin", [
             {
@@ -88,6 +170,9 @@ export class PageSetup extends GObject.GObject {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Gets the page orientation of the `GtkPageSetup`.
+     */
     getOrientation() {
         return call("libgtk-4.so.1", "gtk_page_setup_get_orientation", [
             {
@@ -96,6 +181,14 @@ export class PageSetup extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the page height in units of @unit.
+     *
+     * Note that this function takes orientation
+     * and margins into consideration.
+     * See [method@Gtk.PageSetup.get_paper_height].
+     * @param unit - the unit for the return value
+     */
     getPageHeight(unit) {
         return call("libgtk-4.so.1", "gtk_page_setup_get_page_height", [
             {
@@ -108,6 +201,14 @@ export class PageSetup extends GObject.GObject {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Returns the page width in units of @unit.
+     *
+     * Note that this function takes orientation
+     * and margins into consideration.
+     * See [method@Gtk.PageSetup.get_paper_width].
+     * @param unit - the unit for the return value
+     */
     getPageWidth(unit) {
         return call("libgtk-4.so.1", "gtk_page_setup_get_page_width", [
             {
@@ -120,6 +221,14 @@ export class PageSetup extends GObject.GObject {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Returns the paper height in units of @unit.
+     *
+     * Note that this function takes orientation,
+     * but not margins into consideration.
+     * See [method@Gtk.PageSetup.get_page_height].
+     * @param unit - the unit for the return value
+     */
     getPaperHeight(unit) {
         return call("libgtk-4.so.1", "gtk_page_setup_get_paper_height", [
             {
@@ -132,6 +241,9 @@ export class PageSetup extends GObject.GObject {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Gets the paper size of the `GtkPageSetup`.
+     */
     getPaperSize() {
         const ptr = call("libgtk-4.so.1", "gtk_page_setup_get_paper_size", [
             {
@@ -146,6 +258,14 @@ export class PageSetup extends GObject.GObject {
         });
         return getObject(ptr, PaperSize);
     }
+    /**
+     * Returns the paper width in units of @unit.
+     *
+     * Note that this function takes orientation,
+     * but not margins into consideration.
+     * See [method@Gtk.PageSetup.get_page_width].
+     * @param unit - the unit for the return value
+     */
     getPaperWidth(unit) {
         return call("libgtk-4.so.1", "gtk_page_setup_get_paper_width", [
             {
@@ -158,6 +278,10 @@ export class PageSetup extends GObject.GObject {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Gets the right margin in units of @unit.
+     * @param unit - the unit for the return value
+     */
     getRightMargin(unit) {
         return call("libgtk-4.so.1", "gtk_page_setup_get_right_margin", [
             {
@@ -170,6 +294,10 @@ export class PageSetup extends GObject.GObject {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Gets the top margin in units of @unit.
+     * @param unit - the unit for the return value
+     */
     getTopMargin(unit) {
         return call("libgtk-4.so.1", "gtk_page_setup_get_top_margin", [
             {
@@ -182,6 +310,12 @@ export class PageSetup extends GObject.GObject {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Reads the page setup from the file @file_name.
+     *
+     * See [method@Gtk.PageSetup.to_file].
+     * @param fileName - the filename to read the page setup from
+     */
     loadFile(fileName) {
         const error = { value: null };
         const result = call("libgtk-4.so.1", "gtk_page_setup_load_file", [
@@ -210,6 +344,12 @@ export class PageSetup extends GObject.GObject {
         }
         return result;
     }
+    /**
+     * Reads the page setup from the group `group_name` in the key file
+     * @key_file.
+     * @param keyFile - the `GKeyFile` to retrieve the page_setup from
+     * @param groupName - the name of the group in the key_file to read
+     */
     loadKeyFile(keyFile, groupName) {
         const error = { value: null };
         const result = call("libgtk-4.so.1", "gtk_page_setup_load_key_file", [
@@ -248,6 +388,11 @@ export class PageSetup extends GObject.GObject {
         }
         return result;
     }
+    /**
+     * Sets the bottom margin of the `GtkPageSetup`.
+     * @param margin - the new bottom margin in units of @unit
+     * @param unit - the units for @margin
+     */
     setBottomMargin(margin, unit) {
         call("libgtk-4.so.1", "gtk_page_setup_set_bottom_margin", [
             {
@@ -264,6 +409,11 @@ export class PageSetup extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the left margin of the `GtkPageSetup`.
+     * @param margin - the new left margin in units of @unit
+     * @param unit - the units for @margin
+     */
     setLeftMargin(margin, unit) {
         call("libgtk-4.so.1", "gtk_page_setup_set_left_margin", [
             {
@@ -280,6 +430,10 @@ export class PageSetup extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the page orientation of the `GtkPageSetup`.
+     * @param orientation - a `GtkPageOrientation` value
+     */
     setOrientation(orientation) {
         call("libgtk-4.so.1", "gtk_page_setup_set_orientation", [
             {
@@ -292,6 +446,13 @@ export class PageSetup extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the paper size of the `GtkPageSetup` without
+     * changing the margins.
+     *
+     * See [method@Gtk.PageSetup.set_paper_size_and_default_margins].
+     * @param size - a `GtkPaperSize`
+     */
     setPaperSize(size) {
         call("libgtk-4.so.1", "gtk_page_setup_set_paper_size", [
             {
@@ -309,6 +470,11 @@ export class PageSetup extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the paper size of the `GtkPageSetup` and modifies
+     * the margins according to the new paper size.
+     * @param size - a `GtkPaperSize`
+     */
     setPaperSizeAndDefaultMargins(size) {
         call("libgtk-4.so.1", "gtk_page_setup_set_paper_size_and_default_margins", [
             {
@@ -326,6 +492,11 @@ export class PageSetup extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the right margin of the `GtkPageSetup`.
+     * @param margin - the new right margin in units of @unit
+     * @param unit - the units for @margin
+     */
     setRightMargin(margin, unit) {
         call("libgtk-4.so.1", "gtk_page_setup_set_right_margin", [
             {
@@ -342,6 +513,11 @@ export class PageSetup extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the top margin of the `GtkPageSetup`.
+     * @param margin - the new top margin in units of @unit
+     * @param unit - the units for @margin
+     */
     setTopMargin(margin, unit) {
         call("libgtk-4.so.1", "gtk_page_setup_set_top_margin", [
             {
@@ -358,6 +534,10 @@ export class PageSetup extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * This function saves the information from `setup` to @file_name.
+     * @param fileName - the file to save to
+     */
     toFile(fileName) {
         const error = { value: null };
         const result = call("libgtk-4.so.1", "gtk_page_setup_to_file", [
@@ -386,6 +566,9 @@ export class PageSetup extends GObject.GObject {
         }
         return result;
     }
+    /**
+     * Serialize page setup to an a{sv} variant.
+     */
     toGvariant() {
         const ptr = call("libgtk-4.so.1", "gtk_page_setup_to_gvariant", [
             {
@@ -400,6 +583,11 @@ export class PageSetup extends GObject.GObject {
         });
         return getObject(ptr, GLib.Variant);
     }
+    /**
+     * This function adds the page setup from `setup` to @key_file.
+     * @param keyFile - the `GKeyFile` to save the page setup to
+     * @param groupName - the group to add the settings to in @key_file,
+     */
     toKeyFile(keyFile, groupName) {
         call("libgtk-4.so.1", "gtk_page_setup_to_key_file", [
             {

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

@@ -2,26 +2,97 @@ import { Orientation, ScrollType } from "./enums.js";
 import * as GObject from "../gobject/index.js";
 import { Widget } from "./widget.js";
 export declare class Paned extends Widget {
+    /**
+     * Creates a new `GtkPaned` widget.
+     * @param orientation - the paned’s orientation.
+     */
     constructor(orientation: Orientation);
     constructor(...args: unknown[]);
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Retrieves the end child of the given `GtkPaned`.
+     */
     getEndChild(): Widget | null;
+    /**
+     * Obtains the position of the divider between the two panes.
+     */
     getPosition(): number;
+    /**
+     * Returns whether the [property@Gtk.Paned:end-child] can be resized.
+     */
     getResizeEndChild(): boolean;
+    /**
+     * Returns whether the [property@Gtk.Paned:start-child] can be resized.
+     */
     getResizeStartChild(): boolean;
+    /**
+     * Returns whether the [property@Gtk.Paned:end-child] can shrink.
+     */
     getShrinkEndChild(): boolean;
+    /**
+     * Returns whether the [property@Gtk.Paned:start-child] can shrink.
+     */
     getShrinkStartChild(): boolean;
+    /**
+     * Retrieves the start child of the given `GtkPaned`.
+     */
     getStartChild(): Widget | null;
+    /**
+     * Gets whether the separator should be wide.
+     */
     getWideHandle(): 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?: Widget | null): void;
+    /**
+     * 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: number): void;
+    /**
+     * Sets whether the [property@Gtk.Paned:end-child] can be resized.
+     * @param resize - true to let the end child be resized
+     */
     setResizeEndChild(resize: boolean): void;
+    /**
+     * Sets whether the [property@Gtk.Paned:start-child] can be resized.
+     * @param resize - true to let the start child be resized
+     */
     setResizeStartChild(resize: boolean): void;
+    /**
+     * Sets whether the [property@Gtk.Paned:end-child] can shrink.
+     * @param resize - true to let the end child be shrunk
+     */
     setShrinkEndChild(resize: boolean): void;
+    /**
+     * Sets whether the [property@Gtk.Paned:start-child] can shrink.
+     * @param resize - true to let the start child be shrunk
+     */
     setShrinkStartChild(resize: boolean): void;
+    /**
+     * 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?: Widget | null): void;
+    /**
+     * Sets whether the separator should be wide.
+     * @param wide - the new value for the [property@Gtk.Paned:wide-handle] property
+     */
     setWideHandle(wide: boolean): 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: "accept-position", handler: (self: Paned) => boolean, after?: boolean): number;
     connect(signal: "cancel-position", handler: (self: Paned) => boolean, after?: boolean): number;