@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtk/printer.js

@@ -2,6 +2,17 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { PageSetup } from "./page-setup.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * Represents a printer.
+ *
+ * You only need to deal directly with printers if you use the
+ * non-portable [class@Gtk.PrintUnixDialog] API.
+ *
+ * A `GtkPrinter` allows to get status information about the printer,
+ * such as its description, its location, the number of queued jobs,
+ * etc. Most importantly, a `GtkPrinter` object can be used to create
+ * a [class@Gtk.PrintJob] object, which lets you print to the printer.
+ */
 const SIGNAL_META = {
     "details-acquired": {
         params: [{ type: { type: "boolean" } }],
@@ -29,6 +40,10 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Returns whether the printer accepts input in
+     * PDF format.
+     */
     acceptsPdf() {
         return call("libgtk-4.so.1", "gtk_printer_accepts_pdf", [
             {
@@ -37,6 +52,10 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns whether the printer accepts input in
+     * PostScript format.
+     */
     acceptsPs() {
         return call("libgtk-4.so.1", "gtk_printer_accepts_ps", [
             {
@@ -45,6 +64,10 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Compares two printers.
+     * @param b - another `GtkPrinter`
+     */
     compare(b) {
         return call("libgtk-4.so.1", "gtk_printer_compare", [
             {
@@ -57,6 +80,9 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the backend of the printer.
+     */
     getBackend() {
         return call("libgtk-4.so.1", "gtk_printer_get_backend", [
             {
@@ -65,6 +91,17 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "int", size: 64, unsigned: true });
     }
+    /**
+     * 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() {
         return call("libgtk-4.so.1", "gtk_printer_get_capabilities", [
             {
@@ -73,6 +110,9 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns default page size of @printer.
+     */
     getDefaultPageSize() {
         const ptr = call("libgtk-4.so.1", "gtk_printer_get_default_page_size", [
             {
@@ -82,6 +122,9 @@ export class Printer extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, PageSetup);
     }
+    /**
+     * Gets the description of the printer.
+     */
     getDescription() {
         return call("libgtk-4.so.1", "gtk_printer_get_description", [
             {
@@ -90,6 +133,20 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * 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, bottom, left, right) {
         return call("libgtk-4.so.1", "gtk_printer_get_hard_margins", [
             {
@@ -114,6 +171,21 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "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, top, bottom, left, right) {
         return call("libgtk-4.so.1", "gtk_printer_get_hard_margins_for_paper_size", [
             {
@@ -147,6 +219,9 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the name of the icon to use for the printer.
+     */
     getIconName() {
         return call("libgtk-4.so.1", "gtk_printer_get_icon_name", [
             {
@@ -155,6 +230,9 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Gets the number of jobs currently queued on the printer.
+     */
     getJobCount() {
         return call("libgtk-4.so.1", "gtk_printer_get_job_count", [
             {
@@ -163,6 +241,9 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns a description of the location of the printer.
+     */
     getLocation() {
         return call("libgtk-4.so.1", "gtk_printer_get_location", [
             {
@@ -171,6 +252,9 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns the name of the printer.
+     */
     getName() {
         return call("libgtk-4.so.1", "gtk_printer_get_name", [
             {
@@ -179,6 +263,10 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns the state message describing the current state
+     * of the printer.
+     */
     getStateMessage() {
         return call("libgtk-4.so.1", "gtk_printer_get_state_message", [
             {
@@ -187,6 +275,9 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns whether the printer details are available.
+     */
     hasDetails() {
         return call("libgtk-4.so.1", "gtk_printer_has_details", [
             {
@@ -195,6 +286,9 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns whether the printer is accepting jobs
+     */
     isAcceptingJobs() {
         return call("libgtk-4.so.1", "gtk_printer_is_accepting_jobs", [
             {
@@ -203,6 +297,10 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns whether the printer is currently active (i.e.
+     * accepts new jobs).
+     */
     isActive() {
         return call("libgtk-4.so.1", "gtk_printer_is_active", [
             {
@@ -211,6 +309,9 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns whether the printer is the default printer.
+     */
     isDefault() {
         return call("libgtk-4.so.1", "gtk_printer_is_default", [
             {
@@ -219,6 +320,12 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns whether the printer is currently paused.
+     *
+     * A paused printer still accepts jobs, but it is not
+     * printing them.
+     */
     isPaused() {
         return call("libgtk-4.so.1", "gtk_printer_is_paused", [
             {
@@ -227,6 +334,11 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns whether the printer is virtual (i.e. does not
+     * represent actual printer hardware, but something like
+     * a CUPS class).
+     */
     isVirtual() {
         return call("libgtk-4.so.1", "gtk_printer_is_virtual", [
             {
@@ -235,6 +347,13 @@ export class Printer extends GObject.GObject {
             },
         ], { type: "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() {
         const ptrs = call("libgtk-4.so.1", "gtk_printer_list_papers", [
             {
@@ -249,6 +368,13 @@ export class Printer extends GObject.GObject {
         });
         return ptrs.map((ptr) => getObject(ptr, PageSetup));
     }
+    /**
+     * Requests the printer details.
+     *
+     * When the details are available, the
+     * [signal@Gtk.Printer::details-acquired] signal
+     * will be emitted on @printer.
+     */
     requestDetails() {
         call("libgtk-4.so.1", "gtk_printer_request_details", [
             {

package/dist/generated/gtk/progress-bar.d.ts

@@ -2,23 +2,172 @@ import { Orientation } from "./enums.js";
 import * as GObject from "../gobject/index.js";
 import * as Pango from "../pango/index.js";
 import { Widget } from "./widget.js";
+/**
+ * Displays the progress of a long-running operation.
+ *
+ * `GtkProgressBar` provides a visual clue that processing is underway.
+ * It can be used in two different modes: percentage mode and activity mode.
+ *
+ *
+ *
+ * When an application can determine how much work needs to take place
+ * (e.g. read a fixed number of bytes from a file) and can monitor its
+ * progress, it can use the `GtkProgressBar` in percentage mode and the
+ * user sees a growing bar indicating the percentage of the work that
+ * has been completed. In this mode, the application is required to call
+ * [method@Gtk.ProgressBar.set_fraction] periodically to update the progress bar.
+ *
+ * When an application has no accurate way of knowing the amount of work
+ * to do, it can use the `GtkProgressBar` in activity mode, which shows
+ * activity by a block moving back and forth within the progress area. In
+ * this mode, the application is required to call [method@Gtk.ProgressBar.pulse]
+ * periodically to update the progress bar.
+ *
+ * There is quite a bit of flexibility provided to control the appearance
+ * of the `GtkProgressBar`. Functions are provided to control the orientation
+ * of the bar, optional text can be displayed along with the bar, and the
+ * step size used in activity mode can be set.
+ *
+ * # CSS nodes
+ *
+ * ```
+ * progressbar[.osd]
+ * ├── [text]
+ * ╰── trough[.empty][.full]
+ * ╰── progress[.pulse]
+ * ```
+ *
+ * `GtkProgressBar` has a main CSS node with name progressbar and subnodes with
+ * names text and trough, of which the latter has a subnode named progress. The
+ * text subnode is only present if text is shown. The progress subnode has the
+ * style class .pulse when in activity mode. It gets the style classes .left,
+ * .right, .top or .bottom added when the progress 'touches' the corresponding
+ * end of the GtkProgressBar. The .osd class on the progressbar node is for use
+ * in overlays like the one Epiphany has for page loading progress.
+ *
+ * # Accessibility
+ *
+ * `GtkProgressBar` uses the [enum@Gtk.AccessibleRole.progress_bar] role
+ * and sets the [enum@Gtk.AccessibleProperty.value_min], [enum@Gtk.AccessibleProperty.value_max] and [enum@Gtk.AccessibleProperty.value_now] properties to reflect
+ * the progress.
+ */
 export declare class ProgressBar extends Widget {
+    /**
+     * Creates a new `GtkProgressBar`.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Returns the ellipsizing position of the progress bar.
+     *
+     * See [method@Gtk.ProgressBar.set_ellipsize].
+     */
     getEllipsize(): Pango.EllipsizeMode;
+    /**
+     * Returns the current fraction of the task that’s been completed.
+     */
     getFraction(): number;
+    /**
+     * Returns whether the progress bar is inverted.
+     */
     getInverted(): boolean;
+    /**
+     * Retrieves the pulse step.
+     *
+     * See [method@Gtk.ProgressBar.set_pulse_step].
+     */
     getPulseStep(): number;
+    /**
+     * Returns whether the `GtkProgressBar` shows text.
+     *
+     * See [method@Gtk.ProgressBar.set_show_text].
+     */
     getShowText(): boolean;
+    /**
+     * Retrieves the text that is displayed with the progress bar.
+     *
+     * The return value is a reference to the text, not a copy of it,
+     * so will become invalid if you change the text in the progress bar.
+     */
     getText(): string | null;
+    /**
+     * Indicates that some progress has been made, but you don’t know how much.
+     *
+     * Causes the progress bar to enter “activity mode,” where a block
+     * bounces back and forth. Each call to [method@Gtk.ProgressBar.pulse]
+     * causes the block to move by a little bit (the amount of movement
+     * per pulse is determined by [method@Gtk.ProgressBar.set_pulse_step]).
+     */
     pulse(): void;
+    /**
+     * Sets the mode used to ellipsize the text.
+     *
+     * The text is ellipsized if there is not enough space
+     * to render the entire string.
+     * @param mode - a `PangoEllipsizeMode`
+     */
     setEllipsize(mode: Pango.EllipsizeMode): void;
+    /**
+     * Causes the progress bar to “fill in” the given fraction
+     * of the bar.
+     *
+     * The fraction should be between 0.0 and 1.0, inclusive.
+     * @param fraction - fraction of the task that’s been completed
+     */
     setFraction(fraction: number): void;
+    /**
+     * Sets whether the progress bar is inverted.
+     *
+     * Progress bars normally grow from top to bottom or left to right.
+     * Inverted progress bars grow in the opposite direction.
+     * @param inverted - %TRUE to invert the progress bar
+     */
     setInverted(inverted: boolean): void;
+    /**
+     * Sets the fraction of total progress bar length to move the
+     * bouncing block.
+     *
+     * The bouncing block is moved when [method@Gtk.ProgressBar.pulse]
+     * is called.
+     * @param fraction - fraction between 0.0 and 1.0
+     */
     setPulseStep(fraction: number): void;
+    /**
+     * Sets whether the progress bar will show text next to the bar.
+     *
+     * The shown text is either the value of the [property@Gtk.ProgressBar:text]
+     * property or, if that is %NULL, the [property@Gtk.ProgressBar:fraction] value,
+     * as a percentage.
+     *
+     * To make a progress bar that is styled and sized suitably for containing
+     * text (even if the actual text is blank), set [property@Gtk.ProgressBar:show-text]
+     * to %TRUE and [property@Gtk.ProgressBar:text] to the empty string (not %NULL).
+     * @param showText - whether to show text
+     */
     setShowText(showText: boolean): void;
+    /**
+     * Causes the given `text` to appear next to the progress bar.
+     *
+     * If `text` is %NULL and [property@Gtk.ProgressBar:show-text] is %TRUE,
+     * the current value of [property@Gtk.ProgressBar:fraction] will be displayed
+     * as a percentage.
+     *
+     * If `text` is non-%NULL and [property@Gtk.ProgressBar:show-text] is %TRUE,
+     * the text will be displayed. In this case, it will not display the progress
+     * percentage. If `text` is the empty string, the progress bar will still
+     * be styled and sized suitably for containing text, as long as
+     * [property@Gtk.ProgressBar:show-text] is %TRUE.
+     * @param text - a UTF-8 string
+     */
     setText(text?: string | null): 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: ProgressBar, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gtk/progress-bar.js

@@ -1,7 +1,59 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { Widget } from "./widget.js";
+/**
+ * Displays the progress of a long-running operation.
+ *
+ * `GtkProgressBar` provides a visual clue that processing is underway.
+ * It can be used in two different modes: percentage mode and activity mode.
+ *
+ *
+ *
+ * When an application can determine how much work needs to take place
+ * (e.g. read a fixed number of bytes from a file) and can monitor its
+ * progress, it can use the `GtkProgressBar` in percentage mode and the
+ * user sees a growing bar indicating the percentage of the work that
+ * has been completed. In this mode, the application is required to call
+ * [method@Gtk.ProgressBar.set_fraction] periodically to update the progress bar.
+ *
+ * When an application has no accurate way of knowing the amount of work
+ * to do, it can use the `GtkProgressBar` in activity mode, which shows
+ * activity by a block moving back and forth within the progress area. In
+ * this mode, the application is required to call [method@Gtk.ProgressBar.pulse]
+ * periodically to update the progress bar.
+ *
+ * There is quite a bit of flexibility provided to control the appearance
+ * of the `GtkProgressBar`. Functions are provided to control the orientation
+ * of the bar, optional text can be displayed along with the bar, and the
+ * step size used in activity mode can be set.
+ *
+ * # CSS nodes
+ *
+ * ```
+ * progressbar[.osd]
+ * ├── [text]
+ * ╰── trough[.empty][.full]
+ * ╰── progress[.pulse]
+ * ```
+ *
+ * `GtkProgressBar` has a main CSS node with name progressbar and subnodes with
+ * names text and trough, of which the latter has a subnode named progress. The
+ * text subnode is only present if text is shown. The progress subnode has the
+ * style class .pulse when in activity mode. It gets the style classes .left,
+ * .right, .top or .bottom added when the progress 'touches' the corresponding
+ * end of the GtkProgressBar. The .osd class on the progressbar node is for use
+ * in overlays like the one Epiphany has for page loading progress.
+ *
+ * # Accessibility
+ *
+ * `GtkProgressBar` uses the [enum@Gtk.AccessibleRole.progress_bar] role
+ * and sets the [enum@Gtk.AccessibleProperty.value_min], [enum@Gtk.AccessibleProperty.value_max] and [enum@Gtk.AccessibleProperty.value_now] properties to reflect
+ * the progress.
+ */
 export class ProgressBar extends Widget {
+    /**
+     * Creates a new `GtkProgressBar`.
+     */
     constructor(...args) {
         super(...args);
     }
@@ -11,6 +63,11 @@ export class ProgressBar extends Widget {
             borrowed: true,
         });
     }
+    /**
+     * Returns the ellipsizing position of the progress bar.
+     *
+     * See [method@Gtk.ProgressBar.set_ellipsize].
+     */
     getEllipsize() {
         return call("libgtk-4.so.1", "gtk_progress_bar_get_ellipsize", [
             {
@@ -19,6 +76,9 @@ export class ProgressBar extends Widget {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the current fraction of the task that’s been completed.
+     */
     getFraction() {
         return call("libgtk-4.so.1", "gtk_progress_bar_get_fraction", [
             {
@@ -27,6 +87,9 @@ export class ProgressBar extends Widget {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Returns whether the progress bar is inverted.
+     */
     getInverted() {
         return call("libgtk-4.so.1", "gtk_progress_bar_get_inverted", [
             {
@@ -35,6 +98,11 @@ export class ProgressBar extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Retrieves the pulse step.
+     *
+     * See [method@Gtk.ProgressBar.set_pulse_step].
+     */
     getPulseStep() {
         return call("libgtk-4.so.1", "gtk_progress_bar_get_pulse_step", [
             {
@@ -43,6 +111,11 @@ export class ProgressBar extends Widget {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Returns whether the `GtkProgressBar` shows text.
+     *
+     * See [method@Gtk.ProgressBar.set_show_text].
+     */
     getShowText() {
         return call("libgtk-4.so.1", "gtk_progress_bar_get_show_text", [
             {
@@ -51,6 +124,12 @@ export class ProgressBar extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Retrieves the text that is displayed with the progress bar.
+     *
+     * The return value is a reference to the text, not a copy of it,
+     * so will become invalid if you change the text in the progress bar.
+     */
     getText() {
         return call("libgtk-4.so.1", "gtk_progress_bar_get_text", [
             {
@@ -59,6 +138,14 @@ export class ProgressBar extends Widget {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Indicates that some progress has been made, but you don’t know how much.
+     *
+     * Causes the progress bar to enter “activity mode,” where a block
+     * bounces back and forth. Each call to [method@Gtk.ProgressBar.pulse]
+     * causes the block to move by a little bit (the amount of movement
+     * per pulse is determined by [method@Gtk.ProgressBar.set_pulse_step]).
+     */
     pulse() {
         call("libgtk-4.so.1", "gtk_progress_bar_pulse", [
             {
@@ -67,6 +154,13 @@ export class ProgressBar extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the mode used to ellipsize the text.
+     *
+     * The text is ellipsized if there is not enough space
+     * to render the entire string.
+     * @param mode - a `PangoEllipsizeMode`
+     */
     setEllipsize(mode) {
         call("libgtk-4.so.1", "gtk_progress_bar_set_ellipsize", [
             {
@@ -79,6 +173,13 @@ export class ProgressBar extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Causes the progress bar to “fill in” the given fraction
+     * of the bar.
+     *
+     * The fraction should be between 0.0 and 1.0, inclusive.
+     * @param fraction - fraction of the task that’s been completed
+     */
     setFraction(fraction) {
         call("libgtk-4.so.1", "gtk_progress_bar_set_fraction", [
             {
@@ -91,6 +192,13 @@ export class ProgressBar extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the progress bar is inverted.
+     *
+     * Progress bars normally grow from top to bottom or left to right.
+     * Inverted progress bars grow in the opposite direction.
+     * @param inverted - %TRUE to invert the progress bar
+     */
     setInverted(inverted) {
         call("libgtk-4.so.1", "gtk_progress_bar_set_inverted", [
             {
@@ -103,6 +211,14 @@ export class ProgressBar extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the fraction of total progress bar length to move the
+     * bouncing block.
+     *
+     * The bouncing block is moved when [method@Gtk.ProgressBar.pulse]
+     * is called.
+     * @param fraction - fraction between 0.0 and 1.0
+     */
     setPulseStep(fraction) {
         call("libgtk-4.so.1", "gtk_progress_bar_set_pulse_step", [
             {
@@ -115,6 +231,18 @@ export class ProgressBar extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the progress bar will show text next to the bar.
+     *
+     * The shown text is either the value of the [property@Gtk.ProgressBar:text]
+     * property or, if that is %NULL, the [property@Gtk.ProgressBar:fraction] value,
+     * as a percentage.
+     *
+     * To make a progress bar that is styled and sized suitably for containing
+     * text (even if the actual text is blank), set [property@Gtk.ProgressBar:show-text]
+     * to %TRUE and [property@Gtk.ProgressBar:text] to the empty string (not %NULL).
+     * @param showText - whether to show text
+     */
     setShowText(showText) {
         call("libgtk-4.so.1", "gtk_progress_bar_set_show_text", [
             {
@@ -127,6 +255,20 @@ export class ProgressBar extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Causes the given `text` to appear next to the progress bar.
+     *
+     * If `text` is %NULL and [property@Gtk.ProgressBar:show-text] is %TRUE,
+     * the current value of [property@Gtk.ProgressBar:fraction] will be displayed
+     * as a percentage.
+     *
+     * If `text` is non-%NULL and [property@Gtk.ProgressBar:show-text] is %TRUE,
+     * the text will be displayed. In this case, it will not display the progress
+     * percentage. If `text` is the empty string, the progress bar will still
+     * be styled and sized suitably for containing text, as long as
+     * [property@Gtk.ProgressBar:show-text] is %TRUE.
+     * @param text - a UTF-8 string
+     */
     setText(text) {
         call("libgtk-4.so.1", "gtk_progress_bar_set_text", [
             {
@@ -140,6 +282,9 @@ export class ProgressBar extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Retrieves the orientation of the @orientable.
+     */
     getOrientation() {
         return call("libgtk-4.so.1", "gtk_orientable_get_orientation", [
             {
@@ -148,6 +293,10 @@ export class ProgressBar 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", [
             {