@gtkx/ffi 0.1.45 → 0.1.46

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

@@ -2,27 +2,179 @@ import * as GLib from "../glib/index.js";
 import * as GObject from "../gobject/index.js";
 import { Widget } from "./widget.js";
 export declare class Button extends Widget {
+    /**
+     * Creates a new `GtkButton` widget.
+     *
+     * To add a child widget to the button, use [method@Gtk.Button.set_child].
+     */
     constructor(...args: unknown[]);
+    /**
+     * Creates a new button containing an icon from the current icon theme.
+     *
+     * If the icon name isn’t known, a “broken image” icon will be
+     * displayed instead. If the current icon theme is changed, the icon
+     * will be updated appropriately.
+     * @param iconName - an icon name
+     */
     static newFromIconName(iconName: string): Button;
+    /**
+     * Creates a `GtkButton` widget with a `GtkLabel` child.
+     * @param label - The text you want the `GtkLabel` to hold
+     */
     static newWithLabel(label: string): Button;
+    /**
+     * Creates a new `GtkButton` containing a label.
+     *
+     * If characters in `label` are preceded by an underscore, they are underlined.
+     * If you need a literal underscore character in a label, use “__” (two
+     * underscores). The first underlined character represents a keyboard
+     * accelerator called a mnemonic. Pressing `Alt` and that key
+     * activates the button.
+     * @param label - The text of the button, with an underscore in front of the
+     */
     static newWithMnemonic(label: string): Button;
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Retrieves whether the button can be smaller than the natural
+     * size of its contents.
+     */
     getCanShrink(): boolean;
+    /**
+     * Gets the child widget of @button.
+     */
     getChild(): Widget | null;
+    /**
+     * Returns whether the button has a frame.
+     */
     getHasFrame(): boolean;
+    /**
+     * Returns the icon name of the button.
+     *
+     * If the icon name has not been set with [method@Gtk.Button.set_icon_name]
+     * the return value will be %NULL. This will be the case if you create
+     * an empty button with [ctor@Gtk.Button.new] to use as a container.
+     */
     getIconName(): string | null;
+    /**
+     * Fetches the text from the label of the button.
+     *
+     * If the label text has not been set with [method@Gtk.Button.set_label]
+     * the return value will be %NULL. This will be the case if you create
+     * an empty button with [ctor@Gtk.Button.new] to use as a container.
+     */
     getLabel(): string | null;
+    /**
+     * gets whether underlines are interpreted as mnemonics.
+     *
+     * See [method@Gtk.Button.set_use_underline].
+     */
     getUseUnderline(): boolean;
+    /**
+     * Sets whether the button size can be smaller than the natural size of
+     * its contents.
+     *
+     * For text buttons, setting `can_shrink` to true will ellipsize the label.
+     *
+     * For icons and custom children, this function has no effect.
+     * @param canShrink - whether the button can shrink
+     */
     setCanShrink(canShrink: boolean): void;
+    /**
+     * Sets the child widget of @button.
+     *
+     * Note that by using this API, you take full responsibility for setting
+     * up the proper accessibility label and description information for @button.
+     * Most likely, you'll either set the accessibility label or description
+     * for `button` explicitly, or you'll set a labelled-by or described-by
+     * relations from `child` to @button.
+     * @param child - the child widget
+     */
     setChild(child?: Widget | null): void;
+    /**
+     * Sets the style of the button.
+     *
+     * Buttons can have a flat appearance or have a frame drawn around them.
+     * @param hasFrame - whether the button should have a visible frame
+     */
     setHasFrame(hasFrame: boolean): void;
+    /**
+     * Adds a `GtkImage` with the given icon name as a child.
+     *
+     * If `button` already contains a child widget, that child widget will
+     * be removed and replaced with the image.
+     * @param iconName - An icon name
+     */
     setIconName(iconName: string): void;
+    /**
+     * Sets the text of the label of the button to @label.
+     *
+     * This will also clear any previously set labels.
+     * @param label - a string
+     */
     setLabel(label: string): void;
+    /**
+     * Sets whether to use underlines as mnemonics.
+     *
+     * If true, an underline in the text of the button label indicates
+     * the next character should be used for the mnemonic accelerator key.
+     * @param useUnderline - %TRUE if underlines in the text indicate mnemonics
+     */
     setUseUnderline(useUnderline: boolean): void;
+    /**
+     * Gets the action name for @actionable.
+     */
     getActionName(): string | null;
+    /**
+     * Gets the current target value of @actionable.
+     */
     getActionTargetValue(): GLib.Variant | null;
+    /**
+     * Specifies the name of the action with which this widget should be
+     * associated.
+     *
+     * If `action_name` is %NULL then the widget will be unassociated from
+     * any previous action.
+     *
+     * Usually this function is used when the widget is located (or will be
+     * located) within the hierarchy of a `GtkApplicationWindow`.
+     *
+     * Names are of the form “win.save” or “app.quit” for actions on the
+     * containing [class@ApplicationWindow] or its associated [class@Application],
+     * respectively. This is the same form used for actions in the [class@Gio.Menu]
+     * associated with the window.
+     * @param actionName - an action name
+     */
     setActionName(actionName?: string | null): void;
+    /**
+     * Sets the target value of an actionable widget.
+     *
+     * If `target_value` is %NULL then the target value is unset.
+     *
+     * The target value has two purposes. First, it is used as the parameter
+     * to activation of the action associated with the `GtkActionable` widget.
+     * Second, it is used to determine if the widget should be rendered as
+     * “active” — the widget is active if the state is equal to the given target.
+     *
+     * Consider the example of associating a set of buttons with a [iface@Gio.Action]
+     * with string state in a typical “radio button” situation. Each button
+     * will be associated with the same action, but with a different target
+     * value for that action. Clicking on a particular button will activate
+     * the action with the target of that button, which will typically cause
+     * the action’s state to change to that value. Since the action’s state
+     * is now equal to the target value of the button, the button will now
+     * be rendered as active (and the other buttons, with different targets,
+     * rendered inactive).
+     * @param targetValue - a [struct@GLib.Variant] to set as the target value
+     */
     setActionTargetValue(targetValue?: GLib.Variant | null): void;
+    /**
+     * Sets the action-name and associated string target value of an
+     * actionable widget.
+     *
+     * `detailed_action_name` is a string in the format accepted by
+     * [func@Gio.Action.parse_detailed_name].
+     * @param detailedActionName - the detailed action name
+     */
     setDetailedActionName(detailedActionName: string): void;
     connect(signal: "activate", handler: (self: Button) => void, after?: boolean): number;
     connect(signal: "clicked", handler: (self: Button) => void, after?: boolean): number;

package/dist/generated/gtk/button.js

@@ -2,14 +2,64 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import * as GLib from "../glib/index.js";
 import { Widget } from "./widget.js";
+/**
+ * Calls a callback function when the button is clicked.
+ *
+ *
+ *
+ * The `GtkButton` widget can hold any valid child widget. That is, it can hold
+ * almost any other standard `GtkWidget`. The most commonly used child is the
+ * `GtkLabel`.
+ *
+ * # Shortcuts and Gestures
+ *
+ * The following signals have default keybindings:
+ *
+ * - [signal@Gtk.Button::activate]
+ *
+ * # CSS nodes
+ *
+ * `GtkButton` has a single CSS node with name button. The node will get the
+ * style classes .image-button or .text-button, if the content is just an
+ * image or label, respectively. It may also receive the .flat style class.
+ * When activating a button via the keyboard, the button will temporarily
+ * gain the .keyboard-activating style class.
+ *
+ * Other style classes that are commonly used with `GtkButton` include
+ * .suggested-action and .destructive-action. In special cases, buttons
+ * can be made round by adding the .circular style class.
+ *
+ * Button-like widgets like [class@Gtk.ToggleButton], [class@Gtk.MenuButton],
+ * [class@Gtk.VolumeButton], [class@Gtk.LockButton], [class@Gtk.ColorButton]
+ * or [class@Gtk.FontButton] use style classes such as .toggle, .popup, .scale,
+ * .lock, .color on the button node to differentiate themselves from a plain
+ * `GtkButton`.
+ *
+ * # Accessibility
+ *
+ * `GtkButton` uses the [enum@Gtk.AccessibleRole.button] role.
+ */
 const SIGNAL_META = {
     activate: { params: [], returnType: { type: "undefined" } },
     clicked: { params: [], returnType: { type: "undefined" } },
 };
 export class Button extends Widget {
+    /**
+     * Creates a new `GtkButton` widget.
+     *
+     * To add a child widget to the button, use [method@Gtk.Button.set_child].
+     */
     constructor(...args) {
         super(...args);
     }
+    /**
+     * Creates a new button containing an icon from the current icon theme.
+     *
+     * If the icon name isn’t known, a “broken image” icon will be
+     * displayed instead. If the current icon theme is changed, the icon
+     * will be updated appropriately.
+     * @param iconName - an icon name
+     */
     static newFromIconName(iconName) {
         const ptr = call("libgtk-4.so.1", "gtk_button_new_from_icon_name", [
             {
@@ -19,6 +69,10 @@ export class Button extends Widget {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Button);
     }
+    /**
+     * Creates a `GtkButton` widget with a `GtkLabel` child.
+     * @param label - The text you want the `GtkLabel` to hold
+     */
     static newWithLabel(label) {
         const ptr = call("libgtk-4.so.1", "gtk_button_new_with_label", [
             {
@@ -28,6 +82,16 @@ export class Button extends Widget {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Button);
     }
+    /**
+     * Creates a new `GtkButton` containing a label.
+     *
+     * If characters in `label` are preceded by an underscore, they are underlined.
+     * If you need a literal underscore character in a label, use “__” (two
+     * underscores). The first underlined character represents a keyboard
+     * accelerator called a mnemonic. Pressing `Alt` and that key
+     * activates the button.
+     * @param label - The text of the button, with an underscore in front of the
+     */
     static newWithMnemonic(label) {
         const ptr = call("libgtk-4.so.1", "gtk_button_new_with_mnemonic", [
             {
@@ -43,6 +107,10 @@ export class Button extends Widget {
             borrowed: true,
         });
     }
+    /**
+     * Retrieves whether the button can be smaller than the natural
+     * size of its contents.
+     */
     getCanShrink() {
         return call("libgtk-4.so.1", "gtk_button_get_can_shrink", [
             {
@@ -51,6 +119,9 @@ export class Button extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the child widget of @button.
+     */
     getChild() {
         const ptr = call("libgtk-4.so.1", "gtk_button_get_child", [
             {
@@ -62,6 +133,9 @@ export class Button extends Widget {
             return null;
         return getObject(ptr, Widget);
     }
+    /**
+     * Returns whether the button has a frame.
+     */
     getHasFrame() {
         return call("libgtk-4.so.1", "gtk_button_get_has_frame", [
             {
@@ -70,6 +144,13 @@ export class Button extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns the icon name of the button.
+     *
+     * If the icon name has not been set with [method@Gtk.Button.set_icon_name]
+     * the return value will be %NULL. This will be the case if you create
+     * an empty button with [ctor@Gtk.Button.new] to use as a container.
+     */
     getIconName() {
         return call("libgtk-4.so.1", "gtk_button_get_icon_name", [
             {
@@ -78,6 +159,13 @@ export class Button extends Widget {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Fetches the text from the label of the button.
+     *
+     * If the label text has not been set with [method@Gtk.Button.set_label]
+     * the return value will be %NULL. This will be the case if you create
+     * an empty button with [ctor@Gtk.Button.new] to use as a container.
+     */
     getLabel() {
         return call("libgtk-4.so.1", "gtk_button_get_label", [
             {
@@ -86,6 +174,11 @@ export class Button extends Widget {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * gets whether underlines are interpreted as mnemonics.
+     *
+     * See [method@Gtk.Button.set_use_underline].
+     */
     getUseUnderline() {
         return call("libgtk-4.so.1", "gtk_button_get_use_underline", [
             {
@@ -94,6 +187,15 @@ export class Button extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets whether the button size can be smaller than the natural size of
+     * its contents.
+     *
+     * For text buttons, setting `can_shrink` to true will ellipsize the label.
+     *
+     * For icons and custom children, this function has no effect.
+     * @param canShrink - whether the button can shrink
+     */
     setCanShrink(canShrink) {
         call("libgtk-4.so.1", "gtk_button_set_can_shrink", [
             {
@@ -106,6 +208,16 @@ export class Button extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the child widget of @button.
+     *
+     * Note that by using this API, you take full responsibility for setting
+     * up the proper accessibility label and description information for @button.
+     * Most likely, you'll either set the accessibility label or description
+     * for `button` explicitly, or you'll set a labelled-by or described-by
+     * relations from `child` to @button.
+     * @param child - the child widget
+     */
     setChild(child) {
         call("libgtk-4.so.1", "gtk_button_set_child", [
             {
@@ -119,6 +231,12 @@ export class Button extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the style of the button.
+     *
+     * Buttons can have a flat appearance or have a frame drawn around them.
+     * @param hasFrame - whether the button should have a visible frame
+     */
     setHasFrame(hasFrame) {
         call("libgtk-4.so.1", "gtk_button_set_has_frame", [
             {
@@ -131,6 +249,13 @@ export class Button extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Adds a `GtkImage` with the given icon name as a child.
+     *
+     * If `button` already contains a child widget, that child widget will
+     * be removed and replaced with the image.
+     * @param iconName - An icon name
+     */
     setIconName(iconName) {
         call("libgtk-4.so.1", "gtk_button_set_icon_name", [
             {
@@ -143,6 +268,12 @@ export class Button extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the text of the label of the button to @label.
+     *
+     * This will also clear any previously set labels.
+     * @param label - a string
+     */
     setLabel(label) {
         call("libgtk-4.so.1", "gtk_button_set_label", [
             {
@@ -155,6 +286,13 @@ export class Button extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether to use underlines as mnemonics.
+     *
+     * If true, an underline in the text of the button label indicates
+     * the next character should be used for the mnemonic accelerator key.
+     * @param useUnderline - %TRUE if underlines in the text indicate mnemonics
+     */
     setUseUnderline(useUnderline) {
         call("libgtk-4.so.1", "gtk_button_set_use_underline", [
             {
@@ -167,6 +305,9 @@ export class Button extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the action name for @actionable.
+     */
     getActionName() {
         return call("libgtk-4.so.1", "gtk_actionable_get_action_name", [
             {
@@ -175,6 +316,9 @@ export class Button extends Widget {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Gets the current target value of @actionable.
+     */
     getActionTargetValue() {
         const ptr = call("libgtk-4.so.1", "gtk_actionable_get_action_target_value", [
             {
@@ -191,6 +335,22 @@ export class Button extends Widget {
             return null;
         return getObject(ptr, GLib.Variant);
     }
+    /**
+     * Specifies the name of the action with which this widget should be
+     * associated.
+     *
+     * If `action_name` is %NULL then the widget will be unassociated from
+     * any previous action.
+     *
+     * Usually this function is used when the widget is located (or will be
+     * located) within the hierarchy of a `GtkApplicationWindow`.
+     *
+     * Names are of the form “win.save” or “app.quit” for actions on the
+     * containing [class@ApplicationWindow] or its associated [class@Application],
+     * respectively. This is the same form used for actions in the [class@Gio.Menu]
+     * associated with the window.
+     * @param actionName - an action name
+     */
     setActionName(actionName) {
         call("libgtk-4.so.1", "gtk_actionable_set_action_name", [
             {
@@ -204,6 +364,27 @@ export class Button extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the target value of an actionable widget.
+     *
+     * If `target_value` is %NULL then the target value is unset.
+     *
+     * The target value has two purposes. First, it is used as the parameter
+     * to activation of the action associated with the `GtkActionable` widget.
+     * Second, it is used to determine if the widget should be rendered as
+     * “active” — the widget is active if the state is equal to the given target.
+     *
+     * Consider the example of associating a set of buttons with a [iface@Gio.Action]
+     * with string state in a typical “radio button” situation. Each button
+     * will be associated with the same action, but with a different target
+     * value for that action. Clicking on a particular button will activate
+     * the action with the target of that button, which will typically cause
+     * the action’s state to change to that value. Since the action’s state
+     * is now equal to the target value of the button, the button will now
+     * be rendered as active (and the other buttons, with different targets,
+     * rendered inactive).
+     * @param targetValue - a [struct@GLib.Variant] to set as the target value
+     */
     setActionTargetValue(targetValue) {
         call("libgtk-4.so.1", "gtk_actionable_set_action_target_value", [
             {
@@ -222,6 +403,14 @@ export class Button extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the action-name and associated string target value of an
+     * actionable widget.
+     *
+     * `detailed_action_name` is a string in the format accepted by
+     * [func@Gio.Action.parse_detailed_name].
+     * @param detailedActionName - the detailed action name
+     */
     setDetailedActionName(detailedActionName) {
         call("libgtk-4.so.1", "gtk_actionable_set_detailed_action_name", [
             {

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

@@ -2,26 +2,123 @@ import * as GLib from "../glib/index.js";
 import * as GObject from "../gobject/index.js";
 import { Widget } from "./widget.js";
 export declare class Calendar extends Widget {
+    /**
+     * Creates a new calendar, with the current date being selected.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Remove all visual markers.
+     */
     clearMarks(): void;
+    /**
+     * Returns a `GDateTime` representing the shown
+     * year, month and the selected day.
+     *
+     * The returned date is in the local time zone.
+     */
     getDate(): GLib.DateTime;
+    /**
+     * Gets the day of the selected date.
+     */
     getDay(): number;
+    /**
+     * Returns if the `day` of the `calendar` is already marked.
+     * @param day - the day number between 1 and 31.
+     */
     getDayIsMarked(day: number): boolean;
+    /**
+     * Gets the month of the selected date.
+     */
     getMonth(): number;
+    /**
+     * Returns whether `self` is currently showing the names
+     * of the week days.
+     *
+     * This is the value of the [property@Gtk.Calendar:show-day-names]
+     * property.
+     */
     getShowDayNames(): boolean;
+    /**
+     * Returns whether `self` is currently showing the heading.
+     *
+     * This is the value of the [property@Gtk.Calendar:show-heading]
+     * property.
+     */
     getShowHeading(): boolean;
+    /**
+     * Returns whether `self` is showing week numbers right
+     * now.
+     *
+     * This is the value of the [property@Gtk.Calendar:show-week-numbers]
+     * property.
+     */
     getShowWeekNumbers(): boolean;
+    /**
+     * Gets the year of the selected date.
+     */
     getYear(): number;
+    /**
+     * Places a visual marker on a particular day of the current month.
+     * @param day - the day number to mark between 1 and 31.
+     */
     markDay(day: number): void;
+    /**
+     * Switches to @date's year and month and select its day.
+     * @param date - a `GDateTime` representing the day to select
+     */
     selectDay(date: GLib.DateTime): void;
+    /**
+     * Switches to @date's year and month and selects its day.
+     * @param date - a `GDateTime` representing the day to select
+     */
     setDate(date: GLib.DateTime): void;
+    /**
+     * Sets the day for the selected date.
+     *
+     * The new date must be valid. For example, setting the day to 31 when the
+     * month is February will fail.
+     * @param day - The desired day for the selected date (as a number between 1 and 31).
+     */
     setDay(day: number): void;
+    /**
+     * Sets the month for the selected date.
+     *
+     * The new date must be valid. For example, setting the month to 1 (February)
+     * when the day is 31 will fail.
+     * @param month - The desired month for the selected date (as a number between 0 and 11).
+     */
     setMonth(month: number): void;
+    /**
+     * Sets whether the calendar shows day names.
+     * @param value - Whether to show day names above the day numbers
+     */
     setShowDayNames(value: boolean): void;
+    /**
+     * Sets whether the calendar should show a heading.
+     *
+     * The heading contains the current year and month as well as
+     * buttons for changing both.
+     * @param value - Whether to show the heading in the calendar
+     */
     setShowHeading(value: boolean): void;
+    /**
+     * Sets whether week numbers are shown in the calendar.
+     * @param value - whether to show week numbers alongside the days
+     */
     setShowWeekNumbers(value: boolean): void;
+    /**
+     * Sets the year for the selected date.
+     *
+     * The new date must be valid. For example, setting the year to 2023 when the
+     * date is February 29 will fail.
+     * @param year - The desired year for the selected date (within [struct@GLib.DateTime]
+     */
     setYear(year: number): void;
+    /**
+     * Removes the visual marker from a particular day.
+     * @param day - the day number to unmark between 1 and 31.
+     */
     unmarkDay(day: number): void;
     connect(signal: "day-selected", handler: (self: Calendar) => void, after?: boolean): number;
     connect(signal: "next-month", handler: (self: Calendar) => void, after?: boolean): number;