@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtk/print-setup.d.ts

@@ -1,11 +1,43 @@
 import { PageSetup } from "./page-setup.js";
 import { PrintSettings } from "./print-settings.js";
+/**
+ * An auxiliary object for printing that allows decoupling the setup from the printing.
+ *
+ * A print setup is obtained by calling [method@Gtk.PrintDialog.setup],
+ * and can later be passed to print functions such as [method@Gtk.PrintDialog.print].
+ *
+ * Print setups can be reused for multiple print calls.
+ *
+ * Applications may wish to store the page_setup and print_settings from the print setup
+ * and copy them to the PrintDialog if they want to keep using them.
+ */
 export declare class PrintSetup {
     ptr: unknown;
     constructor();
     protected createPtr(_init: Record<string, unknown>): unknown;
+    /**
+     * Returns the page setup of @setup.
+     *
+     * It may be different from the `GtkPrintDialog`'s page setup
+     * if the user changed it during the setup process.
+     */
     getPageSetup(): PageSetup;
+    /**
+     * Returns the print settings of @setup.
+     *
+     * They may be different from the `GtkPrintDialog`'s settings
+     * if the user changed them during the setup process.
+     */
     getPrintSettings(): PrintSettings;
+    /**
+     * Increase the reference count of @setup.
+     */
     ref(): PrintSetup;
+    /**
+     * Decrease the reference count of @setup.
+     *
+     * If the reference count reaches zero,
+     * the object is freed.
+     */
     unref(): void;
 }

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

@@ -2,6 +2,17 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { PageSetup } from "./page-setup.js";
 import { PrintSettings } from "./print-settings.js";
+/**
+ * An auxiliary object for printing that allows decoupling the setup from the printing.
+ *
+ * A print setup is obtained by calling [method@Gtk.PrintDialog.setup],
+ * and can later be passed to print functions such as [method@Gtk.PrintDialog.print].
+ *
+ * Print setups can be reused for multiple print calls.
+ *
+ * Applications may wish to store the page_setup and print_settings from the print setup
+ * and copy them to the PrintDialog if they want to keep using them.
+ */
 export class PrintSetup {
     ptr;
     constructor() {
@@ -10,6 +21,12 @@ export class PrintSetup {
     createPtr(_init) {
         return null;
     }
+    /**
+     * Returns the page setup of @setup.
+     *
+     * It may be different from the `GtkPrintDialog`'s page setup
+     * if the user changed it during the setup process.
+     */
     getPageSetup() {
         const ptr = call("libgtk-4.so.1", "gtk_print_setup_get_page_setup", [
             {
@@ -19,6 +36,12 @@ export class PrintSetup {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, PageSetup);
     }
+    /**
+     * Returns the print settings of @setup.
+     *
+     * They may be different from the `GtkPrintDialog`'s settings
+     * if the user changed them during the setup process.
+     */
     getPrintSettings() {
         const ptr = call("libgtk-4.so.1", "gtk_print_setup_get_print_settings", [
             {
@@ -28,6 +51,9 @@ export class PrintSetup {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, PrintSettings);
     }
+    /**
+     * Increase the reference count of @setup.
+     */
     ref() {
         const ptr = call("libgtk-4.so.1", "gtk_print_setup_ref", [
             {
@@ -42,6 +68,12 @@ export class PrintSetup {
         });
         return getObject(ptr, PrintSetup);
     }
+    /**
+     * Decrease the reference count of @setup.
+     *
+     * If the reference count reaches zero,
+     * the object is freed.
+     */
     unref() {
         call("libgtk-4.so.1", "gtk_print_setup_unref", [
             {

package/dist/generated/gtk/print-unix-dialog.d.ts

@@ -7,24 +7,99 @@ import { Window } from "./window.js";
 import * as GObject from "../gobject/index.js";
 import { Dialog } from "./dialog.js";
 export declare class PrintUnixDialog extends Dialog {
+    /**
+     * Creates a new `GtkPrintUnixDialog`.
+     * @param title - Title of the dialog
+     * @param parent - Transient parent of the dialog
+     */
     constructor(title?: string | null, parent?: Window | null);
     constructor(...args: unknown[]);
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Adds a custom tab to the print dialog.
+     * @param child - the widget to put in the custom tab
+     * @param tabLabel - the widget to use as tab label
+     */
     addCustomTab(child: Widget, tabLabel: Widget): void;
+    /**
+     * Gets the current page of the `GtkPrintUnixDialog`.
+     */
     getCurrentPage(): number;
+    /**
+     * Gets whether to embed the page setup.
+     */
     getEmbedPageSetup(): boolean;
+    /**
+     * Gets whether there is a selection.
+     */
     getHasSelection(): boolean;
+    /**
+     * Gets the capabilities that have been set on this `GtkPrintUnixDialog`.
+     */
     getManualCapabilities(): PrintCapabilities;
+    /**
+     * Gets the page setup that is used by the `GtkPrintUnixDialog`.
+     */
     getPageSetup(): PageSetup;
+    /**
+     * Gets whether a page setup was set by the user.
+     */
     getPageSetupSet(): boolean;
+    /**
+     * Gets the currently selected printer.
+     */
     getSelectedPrinter(): Printer | null;
+    /**
+     * Gets whether the print dialog allows user to print a selection.
+     */
     getSupportSelection(): boolean;
+    /**
+     * Sets the current page number.
+     *
+     * If `current_page` is not -1, this enables the current page choice
+     * for the range of pages to print.
+     * @param currentPage - the current page number.
+     */
     setCurrentPage(currentPage: number): void;
+    /**
+     * Embed page size combo box and orientation combo box into page setup page.
+     * @param embed - embed page setup selection
+     */
     setEmbedPageSetup(embed: boolean): void;
+    /**
+     * Sets whether a selection exists.
+     * @param hasSelection - %TRUE indicates that a selection exists
+     */
     setHasSelection(hasSelection: boolean): void;
+    /**
+     * 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.
+     * @param capabilities - the printing capabilities of your application
+     */
     setManualCapabilities(capabilities: PrintCapabilities): void;
+    /**
+     * Sets the page setup of the `GtkPrintUnixDialog`.
+     * @param pageSetup - a `GtkPageSetup`
+     */
     setPageSetup(pageSetup: PageSetup): void;
+    /**
+     * 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.
+     * @param settings - a `GtkPrintSettings`
+     */
     setSettings(settings?: PrintSettings | null): void;
+    /**
+     * Sets whether the print dialog allows user to print a selection.
+     * @param supportSelection - %TRUE to allow print selection
+     */
     setSupportSelection(supportSelection: boolean): void;
     connect(signal: "close", handler: (self: PrintUnixDialog) => void, after?: boolean): number;
     connect(signal: "response", handler: (self: PrintUnixDialog, responseId: number) => void, after?: boolean): number;

package/dist/generated/gtk/print-unix-dialog.js

@@ -3,6 +3,64 @@ import { getObject } from "@gtkx/ffi";
 import { PageSetup } from "./page-setup.js";
 import { Printer } from "./printer.js";
 import { Dialog } from "./dialog.js";
+/**
+ * A print dialog for platforms which don’t provide a native
+ * print dialog, like Unix.
+ *
+ *
+ *
+ * It can be used very much like any other GTK dialog, at the cost of
+ * the portability offered by the high-level printing API with
+ * [class@Gtk.PrintOperation].
+ *
+ * In order to print something with `GtkPrintUnixDialog`, you need to
+ * use [method@Gtk.PrintUnixDialog.get_selected_printer] to obtain a
+ * [class@Gtk.Printer] object and use it to construct a [class@Gtk.PrintJob]
+ * using [ctor@Gtk.PrintJob.new].
+ *
+ * `GtkPrintUnixDialog` uses the following response values:
+ *
+ * - %GTK_RESPONSE_OK: for the “Print” button
+ * - %GTK_RESPONSE_APPLY: for the “Preview” button
+ * - %GTK_RESPONSE_CANCEL: for the “Cancel” button
+ *
+ * # GtkPrintUnixDialog as GtkBuildable
+ *
+ * The `GtkPrintUnixDialog` implementation of the `GtkBuildable` interface
+ * exposes its `notebook` internal children with the name “notebook”.
+ *
+ * An example of a `GtkPrintUnixDialog` UI definition fragment:
+ *
+ * ```xml
+ * <object class="GtkPrintUnixDialog" id="dialog1">
+ * <child internal-child="notebook">
+ * <object class="GtkNotebook" id="notebook">
+ * <child>
+ * <object type="GtkNotebookPage">
+ * <property name="tab_expand">False</property>
+ * <property name="tab_fill">False</property>
+ * <property name="tab">
+ * <object class="GtkLabel" id="tablabel">
+ * <property name="label">Tab label</property>
+ * </object>
+ * </property>
+ * <property name="child">
+ * <object class="GtkLabel" id="tabcontent">
+ * <property name="label">Content on notebook tab</property>
+ * </object>
+ * </property>
+ * </object>
+ * </child>
+ * </object>
+ * </child>
+ * </object>
+ * ```
+ *
+ * # CSS nodes
+ *
+ * `GtkPrintUnixDialog` has a single CSS node with name window. The style classes
+ * dialog and print are added.
+ */
 const SIGNAL_META = {
     close: { params: [], returnType: { type: "undefined" } },
     response: {
@@ -37,6 +95,11 @@ export class PrintUnixDialog extends Dialog {
             },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Adds a custom tab to the print dialog.
+     * @param child - the widget to put in the custom tab
+     * @param tabLabel - the widget to use as tab label
+     */
     addCustomTab(child, tabLabel) {
         call("libgtk-4.so.1", "gtk_print_unix_dialog_add_custom_tab", [
             {
@@ -53,6 +116,9 @@ export class PrintUnixDialog extends Dialog {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the current page of the `GtkPrintUnixDialog`.
+     */
     getCurrentPage() {
         return call("libgtk-4.so.1", "gtk_print_unix_dialog_get_current_page", [
             {
@@ -61,6 +127,9 @@ export class PrintUnixDialog extends Dialog {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets whether to embed the page setup.
+     */
     getEmbedPageSetup() {
         return call("libgtk-4.so.1", "gtk_print_unix_dialog_get_embed_page_setup", [
             {
@@ -69,6 +138,9 @@ export class PrintUnixDialog extends Dialog {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets whether there is a selection.
+     */
     getHasSelection() {
         return call("libgtk-4.so.1", "gtk_print_unix_dialog_get_has_selection", [
             {
@@ -77,6 +149,9 @@ export class PrintUnixDialog extends Dialog {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the capabilities that have been set on this `GtkPrintUnixDialog`.
+     */
     getManualCapabilities() {
         return call("libgtk-4.so.1", "gtk_print_unix_dialog_get_manual_capabilities", [
             {
@@ -85,6 +160,9 @@ export class PrintUnixDialog extends Dialog {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the page setup that is used by the `GtkPrintUnixDialog`.
+     */
     getPageSetup() {
         const ptr = call("libgtk-4.so.1", "gtk_print_unix_dialog_get_page_setup", [
             {
@@ -94,6 +172,9 @@ export class PrintUnixDialog extends Dialog {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, PageSetup);
     }
+    /**
+     * Gets whether a page setup was set by the user.
+     */
     getPageSetupSet() {
         return call("libgtk-4.so.1", "gtk_print_unix_dialog_get_page_setup_set", [
             {
@@ -102,6 +183,9 @@ export class PrintUnixDialog extends Dialog {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the currently selected printer.
+     */
     getSelectedPrinter() {
         const ptr = call("libgtk-4.so.1", "gtk_print_unix_dialog_get_selected_printer", [
             {
@@ -113,6 +197,9 @@ export class PrintUnixDialog extends Dialog {
             return null;
         return getObject(ptr, Printer);
     }
+    /**
+     * Gets whether the print dialog allows user to print a selection.
+     */
     getSupportSelection() {
         return call("libgtk-4.so.1", "gtk_print_unix_dialog_get_support_selection", [
             {
@@ -121,6 +208,13 @@ export class PrintUnixDialog extends Dialog {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets the current page number.
+     *
+     * If `current_page` is not -1, this enables the current page choice
+     * for the range of pages to print.
+     * @param currentPage - the current page number.
+     */
     setCurrentPage(currentPage) {
         call("libgtk-4.so.1", "gtk_print_unix_dialog_set_current_page", [
             {
@@ -133,6 +227,10 @@ export class PrintUnixDialog extends Dialog {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Embed page size combo box and orientation combo box into page setup page.
+     * @param embed - embed page setup selection
+     */
     setEmbedPageSetup(embed) {
         call("libgtk-4.so.1", "gtk_print_unix_dialog_set_embed_page_setup", [
             {
@@ -145,6 +243,10 @@ export class PrintUnixDialog extends Dialog {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether a selection exists.
+     * @param hasSelection - %TRUE indicates that a selection exists
+     */
     setHasSelection(hasSelection) {
         call("libgtk-4.so.1", "gtk_print_unix_dialog_set_has_selection", [
             {
@@ -157,6 +259,16 @@ export class PrintUnixDialog extends Dialog {
             },
         ], { type: "undefined" });
     }
+    /**
+     * 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.
+     * @param capabilities - the printing capabilities of your application
+     */
     setManualCapabilities(capabilities) {
         call("libgtk-4.so.1", "gtk_print_unix_dialog_set_manual_capabilities", [
             {
@@ -169,6 +281,10 @@ export class PrintUnixDialog extends Dialog {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the page setup of the `GtkPrintUnixDialog`.
+     * @param pageSetup - a `GtkPageSetup`
+     */
     setPageSetup(pageSetup) {
         call("libgtk-4.so.1", "gtk_print_unix_dialog_set_page_setup", [
             {
@@ -181,6 +297,14 @@ export class PrintUnixDialog extends Dialog {
             },
         ], { type: "undefined" });
     }
+    /**
+     * 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.
+     * @param settings - a `GtkPrintSettings`
+     */
     setSettings(settings) {
         call("libgtk-4.so.1", "gtk_print_unix_dialog_set_settings", [
             {
@@ -194,6 +318,10 @@ export class PrintUnixDialog extends Dialog {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the print dialog allows user to print a selection.
+     * @param supportSelection - %TRUE to allow print selection
+     */
     setSupportSelection(supportSelection) {
         call("libgtk-4.so.1", "gtk_print_unix_dialog_set_support_selection", [
             {

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

@@ -4,30 +4,151 @@ import { PaperSize } from "./paper-size.js";
 import { PageSetup } from "./page-setup.js";
 import * as GObject from "../gobject/index.js";
 export declare class Printer extends GObject.GObject {
+    /**
+     * Creates a new `GtkPrinter`.
+     * @param name - the name of the printer
+     * @param backend - a `GtkPrintBackend`
+     * @param virtual_ - whether the printer is virtual
+     */
     constructor(name: string, backend: number, virtual_: boolean);
     constructor(...args: unknown[]);
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Returns whether the printer accepts input in
+     * PDF format.
+     */
     acceptsPdf(): boolean;
+    /**
+     * Returns whether the printer accepts input in
+     * PostScript format.
+     */
     acceptsPs(): boolean;
+    /**
+     * Compares two printers.
+     * @param b - another `GtkPrinter`
+     */
     compare(b: Printer): number;
+    /**
+     * Returns the backend of the printer.
+     */
     getBackend(): number;
+    /**
+     * 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 will return 0 unless the printer’s details are
+     * available, see [method@Gtk.Printer.has_details] and
+     * [method@Gtk.Printer.request_details].
+     */
     getCapabilities(): PrintCapabilities;
+    /**
+     * Returns default page size of @printer.
+     */
     getDefaultPageSize(): PageSetup;
+    /**
+     * Gets the description of the printer.
+     */
     getDescription(): string;
+    /**
+     * 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 [method@Gtk.Printer.has_details] and
+     * [method@Gtk.Printer.request_details].
+     * @param top - a location to store the top margin in
+     * @param bottom - a location to store the bottom margin in
+     * @param left - a location to store the left margin in
+     * @param right - a location to store the right margin in
+     */
     getHardMargins(top: Ref<number>, bottom: Ref<number>, left: Ref<number>, right: Ref<number>): boolean;
+    /**
+     * 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 [method@Gtk.Printer.has_details] and
+     * [method@Gtk.Printer.request_details].
+     * @param paperSize - a `GtkPaperSize`
+     * @param top - a location to store the top margin in
+     * @param bottom - a location to store the bottom margin in
+     * @param left - a location to store the left margin in
+     * @param right - a location to store the right margin in
+     */
     getHardMarginsForPaperSize(paperSize: PaperSize, top: Ref<number>, bottom: Ref<number>, left: Ref<number>, right: Ref<number>): boolean;
+    /**
+     * Gets the name of the icon to use for the printer.
+     */
     getIconName(): string;
+    /**
+     * Gets the number of jobs currently queued on the printer.
+     */
     getJobCount(): number;
+    /**
+     * Returns a description of the location of the printer.
+     */
     getLocation(): string;
+    /**
+     * Returns the name of the printer.
+     */
     getName(): string;
+    /**
+     * Returns the state message describing the current state
+     * of the printer.
+     */
     getStateMessage(): string;
+    /**
+     * Returns whether the printer details are available.
+     */
     hasDetails(): boolean;
+    /**
+     * Returns whether the printer is accepting jobs
+     */
     isAcceptingJobs(): boolean;
+    /**
+     * Returns whether the printer is currently active (i.e.
+     * accepts new jobs).
+     */
     isActive(): boolean;
+    /**
+     * Returns whether the printer is the default printer.
+     */
     isDefault(): boolean;
+    /**
+     * Returns whether the printer is currently paused.
+     *
+     * A paused printer still accepts jobs, but it is not
+     * printing them.
+     */
     isPaused(): boolean;
+    /**
+     * Returns whether the printer is virtual (i.e. does not
+     * represent actual printer hardware, but something like
+     * a CUPS class).
+     */
     isVirtual(): boolean;
+    /**
+     * Lists all the paper sizes `printer` supports.
+     *
+     * 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].
+     */
     listPapers(): PageSetup[];
+    /**
+     * Requests the printer details.
+     *
+     * When the details are available, the
+     * [signal@Gtk.Printer::details-acquired] signal
+     * will be emitted on @printer.
+     */
     requestDetails(): void;
     connect(signal: "details-acquired", handler: (self: Printer, success: boolean) => void, after?: boolean): number;
     connect(signal: "notify", handler: (self: Printer, pspec: GObject.ParamSpec) => void, after?: boolean): number;