@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtk/property-expression.d.ts

@@ -1,10 +1,46 @@
 import * as GObject from "../gobject/index.js";
 import { Expression } from "./expression.js";
+/** A `GObject` property value in a `GtkExpression`. */
 export declare class PropertyExpression extends Expression {
+    /**
+     * Creates an expression that looks up a property.
+     *
+     * The object to use is found by evaluating the `expression`,
+     * or using the `this` argument when `expression` is `NULL`.
+     *
+     * If the resulting object conforms to `this_type`, its property named
+     * `property_name` will be queried. Otherwise, this expression's
+     * evaluation will fail.
+     *
+     * The given `this_type` must have a property with `property_name`.
+     * @param thisType - The type to expect for the this type
+     * @param expression - Expression to
+     * @param propertyName - name of the property
+     */
     constructor(thisType: number, propertyName: string, expression?: Expression | null);
     constructor(...args: unknown[]);
+    /**
+     * Creates an expression that looks up a property.
+     *
+     * The object to use is found by evaluating the `expression`,
+     * or using the `this` argument when `expression` is `NULL`.
+     *
+     * If the resulting object conforms to `this_type`, its
+     * property specified by `pspec` will be queried.
+     * Otherwise, this expression's evaluation will fail.
+     * @param expression - Expression to
+     * @param pspec - the `GParamSpec` for the property to query
+     */
     static expressionNewForPspec(pspec: GObject.ParamSpec, expression?: Expression | null): PropertyExpression;
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Gets the expression specifying the object of
+     * a property expression.
+     */
     getExpression(): Expression | null;
+    /**
+     * Gets the `GParamSpec` specifying the property of
+     * a property expression.
+     */
     getPspec(): GObject.ParamSpec;
 }

package/dist/generated/gtk/property-expression.js

@@ -2,10 +2,23 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
 import { Expression } from "./expression.js";
+/** A `GObject` property value in a `GtkExpression`. */
 export class PropertyExpression extends Expression {
     constructor(...args) {
         super(...args);
     }
+    /**
+     * Creates an expression that looks up a property.
+     *
+     * The object to use is found by evaluating the `expression`,
+     * or using the `this` argument when `expression` is `NULL`.
+     *
+     * If the resulting object conforms to `this_type`, its
+     * property specified by `pspec` will be queried.
+     * Otherwise, this expression's evaluation will fail.
+     * @param expression - Expression to
+     * @param pspec - the `GParamSpec` for the property to query
+     */
     static expressionNewForPspec(pspec, expression) {
         const ptr = call("libgtk-4.so.1", "gtk_property_expression_new_for_pspec", [
             {
@@ -38,6 +51,10 @@ export class PropertyExpression extends Expression {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Gets the expression specifying the object of
+     * a property expression.
+     */
     getExpression() {
         const ptr = call("libgtk-4.so.1", "gtk_property_expression_get_expression", [
             {
@@ -49,6 +66,10 @@ export class PropertyExpression extends Expression {
             return null;
         return getObject(ptr, Expression);
     }
+    /**
+     * Gets the `GParamSpec` specifying the property of
+     * a property expression.
+     */
     getPspec() {
         const ptr = call("libgtk-4.so.1", "gtk_property_expression_get_pspec", [
             {

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

@@ -7,29 +7,191 @@ import { Widget } from "./widget.js";
 export declare class Range extends Widget {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Get the adjustment which is the “model” object for `GtkRange`.
+     */
     getAdjustment(): Adjustment;
+    /**
+     * Gets the current position of the fill level indicator.
+     */
     getFillLevel(): number;
+    /**
+     * Gets whether the `GtkRange` respects text direction.
+     *
+     * See [method@Gtk.Range.set_flippable].
+     */
     getFlippable(): boolean;
+    /**
+     * Gets whether the range is inverted.
+     *
+     * See [method@Gtk.Range.set_inverted].
+     */
     getInverted(): boolean;
+    /**
+     * This function returns the area that contains the range’s trough,
+     * in coordinates relative to @range's origin.
+     *
+     * This function is useful mainly for `GtkRange` subclasses.
+     * @param rangeRect - return location for the range rectangle
+     */
     getRangeRect(rangeRect: Ref<Gdk.Rectangle>): void;
+    /**
+     * Gets whether the range is restricted to the fill level.
+     */
     getRestrictToFillLevel(): boolean;
+    /**
+     * Gets the number of digits to round the value to when
+     * it changes.
+     *
+     * See [signal@Gtk.Range::change-value].
+     */
     getRoundDigits(): number;
+    /**
+     * Gets whether the range displays the fill level graphically.
+     */
     getShowFillLevel(): boolean;
+    /**
+     * This function returns sliders range along the long dimension,
+     * in widget->window coordinates.
+     *
+     * This function is useful mainly for `GtkRange` subclasses.
+     * @param sliderStart - return location for the slider's start
+     * @param sliderEnd - return location for the slider's end
+     */
     getSliderRange(sliderStart?: Ref<number> | null, sliderEnd?: Ref<number> | null): void;
+    /**
+     * This function is useful mainly for `GtkRange` subclasses.
+     *
+     * See [method@Gtk.Range.set_slider_size_fixed].
+     */
     getSliderSizeFixed(): boolean;
+    /**
+     * Gets the current value of the range.
+     */
     getValue(): number;
+    /**
+     * Sets the adjustment to be used as the “model” object for the `GtkRange`
+     *
+     * The adjustment indicates the current range value, the minimum and
+     * maximum range values, the step/page increments used for keybindings
+     * and scrolling, and the page size.
+     *
+     * The page size is normally 0 for `GtkScale` and nonzero for `GtkScrollbar`,
+     * and indicates the size of the visible area of the widget being scrolled.
+     * The page size affects the size of the scrollbar slider.
+     * @param adjustment - a `GtkAdjustment`
+     */
     setAdjustment(adjustment: Adjustment): void;
+    /**
+     * Set the new position of the fill level indicator.
+     *
+     * The “fill level” is probably best described by its most prominent
+     * use case, which is an indicator for the amount of pre-buffering in
+     * a streaming media player. In that use case, the value of the range
+     * would indicate the current play position, and the fill level would
+     * be the position up to which the file/stream has been downloaded.
+     *
+     * This amount of prebuffering can be displayed on the range’s trough
+     * and is themeable separately from the trough. To enable fill level
+     * display, use [method@Gtk.Range.set_show_fill_level]. The range defaults
+     * to not showing the fill level.
+     *
+     * Additionally, it’s possible to restrict the range’s slider position
+     * to values which are smaller than the fill level. This is controlled
+     * by [method@Gtk.Range.set_restrict_to_fill_level] and is by default
+     * enabled.
+     * @param fillLevel - the new position of the fill level indicator
+     */
     setFillLevel(fillLevel: number): void;
+    /**
+     * Sets whether the `GtkRange` respects text direction.
+     *
+     * If a range is flippable, it will switch its direction
+     * if it is horizontal and its direction is %GTK_TEXT_DIR_RTL.
+     *
+     * See [method@Gtk.Widget.get_direction].
+     * @param flippable - %TRUE to make the range flippable
+     */
     setFlippable(flippable: boolean): void;
+    /**
+     * Sets the step and page sizes for the range.
+     *
+     * The step size is used when the user clicks the `GtkScrollbar`
+     * arrows or moves a `GtkScale` via arrow keys. The page size
+     * is used for example when moving via Page Up or Page Down keys.
+     * @param step - step size
+     * @param page - page size
+     */
     setIncrements(step: number, page: number): void;
+    /**
+     * Sets whether to invert the range.
+     *
+     * Ranges normally move from lower to higher values as the
+     * slider moves from top to bottom or left to right. Inverted
+     * ranges have higher values at the top or on the right rather
+     * than on the bottom or left.
+     * @param setting - %TRUE to invert the range
+     */
     setInverted(setting: boolean): void;
+    /**
+     * Sets the allowable values in the `GtkRange`.
+     *
+     * The range value is clamped to be between `min` and @max.
+     * (If the range has a non-zero page size, it is clamped
+     * between `min` and `max` - page-size.)
+     * @param min - minimum range value
+     * @param max - maximum range value
+     */
     setRange(min: number, max: number): void;
+    /**
+     * Sets whether the slider is restricted to the fill level.
+     *
+     * See [method@Gtk.Range.set_fill_level] for a general description
+     * of the fill level concept.
+     * @param restrictToFillLevel - Whether the fill level restricts slider movement.
+     */
     setRestrictToFillLevel(restrictToFillLevel: boolean): void;
+    /**
+     * Sets the number of digits to round the value to when
+     * it changes.
+     *
+     * See [signal@Gtk.Range::change-value].
+     * @param roundDigits - the precision in digits, or -1
+     */
     setRoundDigits(roundDigits: number): void;
+    /**
+     * Sets whether a graphical fill level is show on the trough.
+     *
+     * See [method@Gtk.Range.set_fill_level] for a general description
+     * of the fill level concept.
+     * @param showFillLevel - Whether a fill level indicator graphics is shown.
+     */
     setShowFillLevel(showFillLevel: boolean): void;
+    /**
+     * Sets whether the range’s slider has a fixed size, or a size that
+     * depends on its adjustment’s page size.
+     *
+     * This function is useful mainly for `GtkRange` subclasses.
+     * @param sizeFixed - %TRUE to make the slider size constant
+     */
     setSliderSizeFixed(sizeFixed: boolean): void;
+    /**
+     * Sets the current value of the range.
+     *
+     * If the value is outside the minimum or maximum range values,
+     * it will be clamped to fit inside them. The range emits the
+     * [signal@Gtk.Range::value-changed] signal if the value changes.
+     * @param value - new value of the range
+     */
     setValue(value: number): 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: "adjust-bounds", handler: (self: Range, value: number) => void, after?: boolean): number;
     connect(signal: "change-value", handler: (self: Range, scroll: ScrollType, value: number) => boolean, after?: boolean): number;

package/dist/generated/gtk/range.js

@@ -2,6 +2,22 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { Adjustment } from "./adjustment.js";
 import { Widget } from "./widget.js";
+/**
+ * Base class for widgets which visualize an adjustment.
+ *
+ * Widgets that are derived from `GtkRange` include
+ * [class@Gtk.Scale] and [class@Gtk.Scrollbar].
+ *
+ * Apart from signals for monitoring the parameters of the adjustment,
+ * `GtkRange` provides properties and methods for setting a
+ * “fill level” on range widgets. See [method@Gtk.Range.set_fill_level].
+ *
+ * # Shortcuts and Gestures
+ *
+ * The `GtkRange` slider is draggable. Holding the `Shift` key while
+ * dragging, or initiating the drag with a long-press will enable the
+ * fine-tuning mode.
+ */
 const SIGNAL_META = {
     "adjust-bounds": {
         params: [{ type: { type: "float", size: 64 } }],
@@ -35,6 +51,9 @@ export class Range extends Widget {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Get the adjustment which is the “model” object for `GtkRange`.
+     */
     getAdjustment() {
         const ptr = call("libgtk-4.so.1", "gtk_range_get_adjustment", [
             {
@@ -44,6 +63,9 @@ export class Range extends Widget {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Adjustment);
     }
+    /**
+     * Gets the current position of the fill level indicator.
+     */
     getFillLevel() {
         return call("libgtk-4.so.1", "gtk_range_get_fill_level", [
             {
@@ -52,6 +74,11 @@ export class Range extends Widget {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Gets whether the `GtkRange` respects text direction.
+     *
+     * See [method@Gtk.Range.set_flippable].
+     */
     getFlippable() {
         return call("libgtk-4.so.1", "gtk_range_get_flippable", [
             {
@@ -60,6 +87,11 @@ export class Range extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets whether the range is inverted.
+     *
+     * See [method@Gtk.Range.set_inverted].
+     */
     getInverted() {
         return call("libgtk-4.so.1", "gtk_range_get_inverted", [
             {
@@ -68,6 +100,13 @@ export class Range extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * This function returns the area that contains the range’s trough,
+     * in coordinates relative to @range's origin.
+     *
+     * This function is useful mainly for `GtkRange` subclasses.
+     * @param rangeRect - return location for the range rectangle
+     */
     getRangeRect(rangeRect) {
         call("libgtk-4.so.1", "gtk_range_get_range_rect", [
             {
@@ -87,6 +126,9 @@ export class Range extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets whether the range is restricted to the fill level.
+     */
     getRestrictToFillLevel() {
         return call("libgtk-4.so.1", "gtk_range_get_restrict_to_fill_level", [
             {
@@ -95,6 +137,12 @@ export class Range extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the number of digits to round the value to when
+     * it changes.
+     *
+     * See [signal@Gtk.Range::change-value].
+     */
     getRoundDigits() {
         return call("libgtk-4.so.1", "gtk_range_get_round_digits", [
             {
@@ -103,6 +151,9 @@ export class Range extends Widget {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets whether the range displays the fill level graphically.
+     */
     getShowFillLevel() {
         return call("libgtk-4.so.1", "gtk_range_get_show_fill_level", [
             {
@@ -111,6 +162,14 @@ export class Range extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * This function returns sliders range along the long dimension,
+     * in widget->window coordinates.
+     *
+     * This function is useful mainly for `GtkRange` subclasses.
+     * @param sliderStart - return location for the slider's start
+     * @param sliderEnd - return location for the slider's end
+     */
     getSliderRange(sliderStart, sliderEnd) {
         call("libgtk-4.so.1", "gtk_range_get_slider_range", [
             {
@@ -135,6 +194,11 @@ export class Range extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * This function is useful mainly for `GtkRange` subclasses.
+     *
+     * See [method@Gtk.Range.set_slider_size_fixed].
+     */
     getSliderSizeFixed() {
         return call("libgtk-4.so.1", "gtk_range_get_slider_size_fixed", [
             {
@@ -143,6 +207,9 @@ export class Range extends Widget {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the current value of the range.
+     */
     getValue() {
         return call("libgtk-4.so.1", "gtk_range_get_value", [
             {
@@ -151,6 +218,18 @@ export class Range extends Widget {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Sets the adjustment to be used as the “model” object for the `GtkRange`
+     *
+     * The adjustment indicates the current range value, the minimum and
+     * maximum range values, the step/page increments used for keybindings
+     * and scrolling, and the page size.
+     *
+     * The page size is normally 0 for `GtkScale` and nonzero for `GtkScrollbar`,
+     * and indicates the size of the visible area of the widget being scrolled.
+     * The page size affects the size of the scrollbar slider.
+     * @param adjustment - a `GtkAdjustment`
+     */
     setAdjustment(adjustment) {
         call("libgtk-4.so.1", "gtk_range_set_adjustment", [
             {
@@ -163,6 +242,26 @@ export class Range extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Set the new position of the fill level indicator.
+     *
+     * The “fill level” is probably best described by its most prominent
+     * use case, which is an indicator for the amount of pre-buffering in
+     * a streaming media player. In that use case, the value of the range
+     * would indicate the current play position, and the fill level would
+     * be the position up to which the file/stream has been downloaded.
+     *
+     * This amount of prebuffering can be displayed on the range’s trough
+     * and is themeable separately from the trough. To enable fill level
+     * display, use [method@Gtk.Range.set_show_fill_level]. The range defaults
+     * to not showing the fill level.
+     *
+     * Additionally, it’s possible to restrict the range’s slider position
+     * to values which are smaller than the fill level. This is controlled
+     * by [method@Gtk.Range.set_restrict_to_fill_level] and is by default
+     * enabled.
+     * @param fillLevel - the new position of the fill level indicator
+     */
     setFillLevel(fillLevel) {
         call("libgtk-4.so.1", "gtk_range_set_fill_level", [
             {
@@ -175,6 +274,15 @@ export class Range extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the `GtkRange` respects text direction.
+     *
+     * If a range is flippable, it will switch its direction
+     * if it is horizontal and its direction is %GTK_TEXT_DIR_RTL.
+     *
+     * See [method@Gtk.Widget.get_direction].
+     * @param flippable - %TRUE to make the range flippable
+     */
     setFlippable(flippable) {
         call("libgtk-4.so.1", "gtk_range_set_flippable", [
             {
@@ -187,6 +295,15 @@ export class Range extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the step and page sizes for the range.
+     *
+     * The step size is used when the user clicks the `GtkScrollbar`
+     * arrows or moves a `GtkScale` via arrow keys. The page size
+     * is used for example when moving via Page Up or Page Down keys.
+     * @param step - step size
+     * @param page - page size
+     */
     setIncrements(step, page) {
         call("libgtk-4.so.1", "gtk_range_set_increments", [
             {
@@ -203,6 +320,15 @@ export class Range extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether to invert the range.
+     *
+     * Ranges normally move from lower to higher values as the
+     * slider moves from top to bottom or left to right. Inverted
+     * ranges have higher values at the top or on the right rather
+     * than on the bottom or left.
+     * @param setting - %TRUE to invert the range
+     */
     setInverted(setting) {
         call("libgtk-4.so.1", "gtk_range_set_inverted", [
             {
@@ -215,6 +341,15 @@ export class Range extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the allowable values in the `GtkRange`.
+     *
+     * The range value is clamped to be between `min` and @max.
+     * (If the range has a non-zero page size, it is clamped
+     * between `min` and `max` - page-size.)
+     * @param min - minimum range value
+     * @param max - maximum range value
+     */
     setRange(min, max) {
         call("libgtk-4.so.1", "gtk_range_set_range", [
             {
@@ -231,6 +366,13 @@ export class Range extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the slider is restricted to the fill level.
+     *
+     * See [method@Gtk.Range.set_fill_level] for a general description
+     * of the fill level concept.
+     * @param restrictToFillLevel - Whether the fill level restricts slider movement.
+     */
     setRestrictToFillLevel(restrictToFillLevel) {
         call("libgtk-4.so.1", "gtk_range_set_restrict_to_fill_level", [
             {
@@ -243,6 +385,13 @@ export class Range extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the number of digits to round the value to when
+     * it changes.
+     *
+     * See [signal@Gtk.Range::change-value].
+     * @param roundDigits - the precision in digits, or -1
+     */
     setRoundDigits(roundDigits) {
         call("libgtk-4.so.1", "gtk_range_set_round_digits", [
             {
@@ -255,6 +404,13 @@ export class Range extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether a graphical fill level is show on the trough.
+     *
+     * See [method@Gtk.Range.set_fill_level] for a general description
+     * of the fill level concept.
+     * @param showFillLevel - Whether a fill level indicator graphics is shown.
+     */
     setShowFillLevel(showFillLevel) {
         call("libgtk-4.so.1", "gtk_range_set_show_fill_level", [
             {
@@ -267,6 +423,13 @@ export class Range extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the range’s slider has a fixed size, or a size that
+     * depends on its adjustment’s page size.
+     *
+     * This function is useful mainly for `GtkRange` subclasses.
+     * @param sizeFixed - %TRUE to make the slider size constant
+     */
     setSliderSizeFixed(sizeFixed) {
         call("libgtk-4.so.1", "gtk_range_set_slider_size_fixed", [
             {
@@ -279,6 +442,14 @@ export class Range extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the current value of the range.
+     *
+     * If the value is outside the minimum or maximum range values,
+     * it will be clamped to fit inside them. The range emits the
+     * [signal@Gtk.Range::value-changed] signal if the value changes.
+     * @param value - new value of the range
+     */
     setValue(value) {
         call("libgtk-4.so.1", "gtk_range_set_value", [
             {
@@ -291,6 +462,9 @@ export class Range extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Retrieves the orientation of the @orientable.
+     */
     getOrientation() {
         return call("libgtk-4.so.1", "gtk_orientable_get_orientation", [
             {
@@ -299,6 +473,10 @@ export class Range 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", [
             {