@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtksource/snippet.js

@@ -3,10 +3,29 @@ import { getObject } from "@gtkx/ffi";
 import { SnippetChunk } from "./snippet-chunk.js";
 import { SnippetContext } from "./snippet-context.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * Quick insertion code snippets.
+ *
+ * The `GtkSourceSnippet` represents a series of chunks that can quickly be
+ * inserted into the [class@View].
+ *
+ * Snippets are defined in XML files which are loaded by the
+ * [class@SnippetManager]. Alternatively, applications can create snippets
+ * on demand and insert them into the [class@View] using
+ * [method@View.push_snippet].
+ *
+ * Snippet chunks can reference other snippet chunks as well as post-process
+ * the values from other chunks such as capitalization.
+ */
 export class Snippet extends GObject.GObject {
     constructor(...args) {
         super(...args);
     }
+    /**
+     * Parses the snippet formatted `text` into a series of chunks and adds them
+     * to a new #GtkSourceSnippet.
+     * @param text - the formatted snippet text to parse
+     */
     static snippetNewParsed(text) {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_snippet_new_parsed", [
             {
@@ -31,6 +50,12 @@ export class Snippet extends GObject.GObject {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Appends `chunk` to the @snippet.
+     *
+     * This may only be called before the snippet has been expanded.
+     * @param chunk - a #GtkSourceSnippetChunk
+     */
     addChunk(chunk) {
         call("libgtksourceview-5.so.0", "gtk_source_snippet_add_chunk", [
             {
@@ -43,6 +68,9 @@ export class Snippet extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Does a deep copy of the snippet.
+     */
     copy() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_snippet_copy", [
             {
@@ -52,6 +80,9 @@ export class Snippet extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Snippet);
     }
+    /**
+     * Gets the context used for expanding the snippet.
+     */
     getContext() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_snippet_get_context", [
             {
@@ -63,6 +94,9 @@ export class Snippet extends GObject.GObject {
             return null;
         return getObject(ptr, SnippetContext);
     }
+    /**
+     * Gets the description for the snippet.
+     */
     getDescription() {
         return call("libgtksourceview-5.so.0", "gtk_source_snippet_get_description", [
             {
@@ -71,6 +105,11 @@ export class Snippet extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Gets the current focus for the snippet.
+     *
+     * This is changed as the user tabs through focus locations.
+     */
     getFocusPosition() {
         return call("libgtksourceview-5.so.0", "gtk_source_snippet_get_focus_position", [
             {
@@ -79,6 +118,12 @@ export class Snippet extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the language-id used for the source snippet.
+     *
+     * The language identifier should be one that matches a
+     * source language [property@Language:id] property.
+     */
     getLanguageId() {
         return call("libgtksourceview-5.so.0", "gtk_source_snippet_get_language_id", [
             {
@@ -87,6 +132,11 @@ export class Snippet extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Gets the number of chunks in the snippet.
+     *
+     * Note that not all chunks are editable.
+     */
     getNChunks() {
         return call("libgtksourceview-5.so.0", "gtk_source_snippet_get_n_chunks", [
             {
@@ -95,6 +145,9 @@ export class Snippet extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Gets the name for the snippet.
+     */
     getName() {
         return call("libgtksourceview-5.so.0", "gtk_source_snippet_get_name", [
             {
@@ -103,6 +156,10 @@ export class Snippet extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Gets the chunk at @nth.
+     * @param nth - the nth chunk to get
+     */
     getNthChunk(nth) {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_snippet_get_nth_chunk", [
             {
@@ -116,6 +173,12 @@ export class Snippet extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, SnippetChunk);
     }
+    /**
+     * Gets the trigger for the source snippet.
+     *
+     * A trigger is a word that can be expanded into the full snippet when
+     * the user presses Tab.
+     */
     getTrigger() {
         return call("libgtksourceview-5.so.0", "gtk_source_snippet_get_trigger", [
             {
@@ -124,6 +187,10 @@ export class Snippet extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Sets the description for the snippet.
+     * @param description - the snippet description
+     */
     setDescription(description) {
         call("libgtksourceview-5.so.0", "gtk_source_snippet_set_description", [
             {
@@ -136,6 +203,12 @@ export class Snippet extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the language identifier for the snippet.
+     *
+     * This should match the [property@Language:id] identifier.
+     * @param languageId - the language identifier for the snippet
+     */
     setLanguageId(languageId) {
         call("libgtksourceview-5.so.0", "gtk_source_snippet_set_language_id", [
             {
@@ -148,6 +221,10 @@ export class Snippet extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the name for the snippet.
+     * @param name - the snippet name
+     */
     setName(name) {
         call("libgtksourceview-5.so.0", "gtk_source_snippet_set_name", [
             {
@@ -160,6 +237,10 @@ export class Snippet extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the trigger for the snippet.
+     * @param trigger - the trigger word
+     */
     setTrigger(trigger) {
         call("libgtksourceview-5.so.0", "gtk_source_snippet_set_trigger", [
             {

package/dist/generated/gtksource/space-drawer.d.ts

@@ -2,15 +2,138 @@ import { SpaceLocationFlags, SpaceTypeFlags } from "./enums.js";
 import * as GLib from "../glib/index.js";
 import * as GObject from "../gobject/index.js";
 import * as Gio from "../gio/index.js";
+/**
+ * Represent white space characters with symbols.
+ *
+ * #GtkSourceSpaceDrawer provides a way to visualize white spaces, by drawing
+ * symbols.
+ *
+ * Call [method@View.get_space_drawer] to get the `GtkSourceSpaceDrawer`
+ * instance of a certain [class@View].
+ *
+ * By default, no white spaces are drawn because the
+ * [property@SpaceDrawer:enable-matrix] is %FALSE.
+ *
+ * To draw white spaces, [method@SpaceDrawer.set_types_for_locations] can
+ * be called to set the [property@SpaceDrawer:matrix] property (by default all
+ * space types are enabled at all locations). Then call
+ * [method@SpaceDrawer.set_enable_matrix].
+ *
+ * For a finer-grained method, there is also the [class@Tag]'s
+ * [property@Tag:draw-spaces] property.
+ *
+ * # Example
+ *
+ * To draw non-breaking spaces everywhere and draw all types of trailing spaces
+ * except newlines:
+ * ```c
+ * gtk_source_space_drawer_set_types_for_locations (space_drawer,
+ * GTK_SOURCE_SPACE_LOCATION_ALL,
+ * GTK_SOURCE_SPACE_TYPE_NBSP);
+ *
+ * gtk_source_space_drawer_set_types_for_locations (space_drawer,
+ * GTK_SOURCE_SPACE_LOCATION_TRAILING,
+ * GTK_SOURCE_SPACE_TYPE_ALL &
+ * ~GTK_SOURCE_SPACE_TYPE_NEWLINE);
+ *
+ * gtk_source_space_drawer_set_enable_matrix (space_drawer, TRUE);
+ * ```
+ * ```python
+ * space_drawer.set_types_for_locations(
+ * locations=GtkSource.SpaceLocationFlags.ALL,
+ * types=GtkSource.SpaceTypeFlags.NBSP,
+ * )
+ *
+ * all_types_except_newline = GtkSource.SpaceTypeFlags(
+ * int(GtkSource.SpaceTypeFlags.ALL) & ~int(GtkSource.SpaceTypeFlags.NEWLINE)
+ * )
+ * space_drawer.set_types_for_locations(
+ * locations=GtkSource.SpaceLocationFlags.TRAILING,
+ * types=all_types_except_newline,
+ * )
+ *
+ * space_drawer.set_enable_matrix(True)
+ * ```
+ *
+ * # Use-case: draw unwanted white spaces
+ *
+ * A possible use-case is to draw only unwanted white spaces. Examples:
+ *
+ * - Draw all trailing spaces.
+ * - If the indentation and alignment must be done with spaces, draw tabs.
+ *
+ * And non-breaking spaces can always be drawn, everywhere, to distinguish them
+ * from normal spaces.
+ */
 export declare class SpaceDrawer extends GObject.GObject {
+    /**
+     * Creates a new #GtkSourceSpaceDrawer object.
+     *
+     * Useful for storing space drawing settings independently of a [class@View].
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Binds the [property@SpaceDrawer:matrix] property to a [class@Gio.Settings] key.
+     *
+     * The [class@Gio.Settings] key must be of the same type as the
+     * [property@SpaceDrawer:matrix] property, that is, `"au"`.
+     *
+     * The [method@Gio.Settings.bind] function cannot be used, because the default GIO
+     * mapping functions don't support [struct@GLib.Variant] properties (maybe it will be
+     * supported by a future GIO version, in which case this function can be
+     * deprecated).
+     * @param settings - a #GSettings object.
+     * @param key - the `settings` key to bind.
+     * @param flags - flags for the binding.
+     */
     bindMatrixSetting(settings: Gio.Settings, key: string, flags: Gio.SettingsBindFlags): void;
     getEnableMatrix(): boolean;
+    /**
+     * Gets the value of the [property@SpaceDrawer:matrix] property, as a [struct@GLib.Variant].
+     *
+     * An empty array can be returned in case the matrix is a zero matrix.
+     *
+     * The [method@SpaceDrawer.get_types_for_locations] function may be more
+     * convenient to use.
+     */
     getMatrix(): GLib.Variant;
+    /**
+     * If only one location is specified, this function returns what kind of
+     * white spaces are drawn at that location.
+     *
+     * The value is retrieved from the [property@SpaceDrawer:matrix] property.
+     *
+     * If several locations are specified, this function returns the logical AND for
+     * those locations. Which means that if a certain kind of white space is present
+     * in the return value, then that kind of white space is drawn at all the
+     * specified @locations.
+     * @param locations - one or several #GtkSourceSpaceLocationFlags.
+     */
     getTypesForLocations(locations: SpaceLocationFlags): SpaceTypeFlags;
+    /**
+     * Sets whether the [property@SpaceDrawer:matrix] property is enabled.
+     * @param enableMatrix - the new value.
+     */
     setEnableMatrix(enableMatrix: boolean): void;
+    /**
+     * Sets a new value to the [property@SpaceDrawer:matrix] property, as a [struct@GLib.Variant].
+     *
+     * If `matrix` is %NULL, then an empty array is set.
+     *
+     * If `matrix` is floating, it is consumed.
+     *
+     * The [method@SpaceDrawer.set_types_for_locations] function may be more
+     * convenient to use.
+     * @param matrix - the new matrix value, or %NULL.
+     */
     setMatrix(matrix?: GLib.Variant | null): void;
+    /**
+     * Modifies the [property@SpaceDrawer:matrix] property at the specified
+     * @locations.
+     * @param locations - one or several #GtkSourceSpaceLocationFlags.
+     * @param types - a combination of #GtkSourceSpaceTypeFlags.
+     */
     setTypesForLocations(locations: SpaceLocationFlags, types: SpaceTypeFlags): void;
     connect(signal: "notify", handler: (self: SpaceDrawer, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gtksource/space-drawer.js

@@ -2,7 +2,75 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import * as GLib from "../glib/index.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * Represent white space characters with symbols.
+ *
+ * #GtkSourceSpaceDrawer provides a way to visualize white spaces, by drawing
+ * symbols.
+ *
+ * Call [method@View.get_space_drawer] to get the `GtkSourceSpaceDrawer`
+ * instance of a certain [class@View].
+ *
+ * By default, no white spaces are drawn because the
+ * [property@SpaceDrawer:enable-matrix] is %FALSE.
+ *
+ * To draw white spaces, [method@SpaceDrawer.set_types_for_locations] can
+ * be called to set the [property@SpaceDrawer:matrix] property (by default all
+ * space types are enabled at all locations). Then call
+ * [method@SpaceDrawer.set_enable_matrix].
+ *
+ * For a finer-grained method, there is also the [class@Tag]'s
+ * [property@Tag:draw-spaces] property.
+ *
+ * # Example
+ *
+ * To draw non-breaking spaces everywhere and draw all types of trailing spaces
+ * except newlines:
+ * ```c
+ * gtk_source_space_drawer_set_types_for_locations (space_drawer,
+ * GTK_SOURCE_SPACE_LOCATION_ALL,
+ * GTK_SOURCE_SPACE_TYPE_NBSP);
+ *
+ * gtk_source_space_drawer_set_types_for_locations (space_drawer,
+ * GTK_SOURCE_SPACE_LOCATION_TRAILING,
+ * GTK_SOURCE_SPACE_TYPE_ALL &
+ * ~GTK_SOURCE_SPACE_TYPE_NEWLINE);
+ *
+ * gtk_source_space_drawer_set_enable_matrix (space_drawer, TRUE);
+ * ```
+ * ```python
+ * space_drawer.set_types_for_locations(
+ * locations=GtkSource.SpaceLocationFlags.ALL,
+ * types=GtkSource.SpaceTypeFlags.NBSP,
+ * )
+ *
+ * all_types_except_newline = GtkSource.SpaceTypeFlags(
+ * int(GtkSource.SpaceTypeFlags.ALL) & ~int(GtkSource.SpaceTypeFlags.NEWLINE)
+ * )
+ * space_drawer.set_types_for_locations(
+ * locations=GtkSource.SpaceLocationFlags.TRAILING,
+ * types=all_types_except_newline,
+ * )
+ *
+ * space_drawer.set_enable_matrix(True)
+ * ```
+ *
+ * # Use-case: draw unwanted white spaces
+ *
+ * A possible use-case is to draw only unwanted white spaces. Examples:
+ *
+ * - Draw all trailing spaces.
+ * - If the indentation and alignment must be done with spaces, draw tabs.
+ *
+ * And non-breaking spaces can always be drawn, everywhere, to distinguish them
+ * from normal spaces.
+ */
 export class SpaceDrawer extends GObject.GObject {
+    /**
+     * Creates a new #GtkSourceSpaceDrawer object.
+     *
+     * Useful for storing space drawing settings independently of a [class@View].
+     */
     constructor(...args) {
         super(...args);
     }
@@ -12,6 +80,20 @@ export class SpaceDrawer extends GObject.GObject {
             borrowed: false,
         });
     }
+    /**
+     * Binds the [property@SpaceDrawer:matrix] property to a [class@Gio.Settings] key.
+     *
+     * The [class@Gio.Settings] key must be of the same type as the
+     * [property@SpaceDrawer:matrix] property, that is, `"au"`.
+     *
+     * The [method@Gio.Settings.bind] function cannot be used, because the default GIO
+     * mapping functions don't support [struct@GLib.Variant] properties (maybe it will be
+     * supported by a future GIO version, in which case this function can be
+     * deprecated).
+     * @param settings - a #GSettings object.
+     * @param key - the `settings` key to bind.
+     * @param flags - flags for the binding.
+     */
     bindMatrixSetting(settings, key, flags) {
         call("libgtksourceview-5.so.0", "gtk_source_space_drawer_bind_matrix_setting", [
             {
@@ -40,6 +122,14 @@ export class SpaceDrawer extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the value of the [property@SpaceDrawer:matrix] property, as a [struct@GLib.Variant].
+     *
+     * An empty array can be returned in case the matrix is a zero matrix.
+     *
+     * The [method@SpaceDrawer.get_types_for_locations] function may be more
+     * convenient to use.
+     */
     getMatrix() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_space_drawer_get_matrix", [
             {
@@ -54,6 +144,18 @@ export class SpaceDrawer extends GObject.GObject {
         });
         return getObject(ptr, GLib.Variant);
     }
+    /**
+     * If only one location is specified, this function returns what kind of
+     * white spaces are drawn at that location.
+     *
+     * The value is retrieved from the [property@SpaceDrawer:matrix] property.
+     *
+     * If several locations are specified, this function returns the logical AND for
+     * those locations. Which means that if a certain kind of white space is present
+     * in the return value, then that kind of white space is drawn at all the
+     * specified @locations.
+     * @param locations - one or several #GtkSourceSpaceLocationFlags.
+     */
     getTypesForLocations(locations) {
         return call("libgtksourceview-5.so.0", "gtk_source_space_drawer_get_types_for_locations", [
             {
@@ -66,6 +168,10 @@ export class SpaceDrawer extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Sets whether the [property@SpaceDrawer:matrix] property is enabled.
+     * @param enableMatrix - the new value.
+     */
     setEnableMatrix(enableMatrix) {
         call("libgtksourceview-5.so.0", "gtk_source_space_drawer_set_enable_matrix", [
             {
@@ -78,6 +184,17 @@ export class SpaceDrawer extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets a new value to the [property@SpaceDrawer:matrix] property, as a [struct@GLib.Variant].
+     *
+     * If `matrix` is %NULL, then an empty array is set.
+     *
+     * If `matrix` is floating, it is consumed.
+     *
+     * The [method@SpaceDrawer.set_types_for_locations] function may be more
+     * convenient to use.
+     * @param matrix - the new matrix value, or %NULL.
+     */
     setMatrix(matrix) {
         call("libgtksourceview-5.so.0", "gtk_source_space_drawer_set_matrix", [
             {
@@ -96,6 +213,12 @@ export class SpaceDrawer extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Modifies the [property@SpaceDrawer:matrix] property at the specified
+     * @locations.
+     * @param locations - one or several #GtkSourceSpaceLocationFlags.
+     * @param types - a combination of #GtkSourceSpaceTypeFlags.
+     */
     setTypesForLocations(locations, types) {
         call("libgtksourceview-5.so.0", "gtk_source_space_drawer_set_types_for_locations", [
             {

package/dist/generated/gtksource/style-scheme-chooser-button.d.ts

@@ -1,10 +1,31 @@
 import { StyleScheme } from "./style-scheme.js";
 import * as GObject from "../gobject/index.js";
 import * as Gtk from "../gtk/index.js";
+/**
+ * A button to launch a style scheme selection dialog.
+ *
+ * The `GtkSourceStyleSchemeChooserButton` is a button which displays
+ * the currently selected style scheme and allows to open a style scheme
+ * selection dialog to change the style scheme.
+ * It is suitable widget for selecting a style scheme in a preference dialog.
+ *
+ * In `GtkSourceStyleSchemeChooserButton`, a [class@StyleSchemeChooserWidget]
+ * is used to provide a dialog for selecting style schemes.
+ */
 export declare class StyleSchemeChooserButton extends Gtk.Button {
+    /**
+     * Creates a new #GtkSourceStyleSchemeChooserButton.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Gets the currently-selected scheme.
+     */
     getStyleScheme(): StyleScheme;
+    /**
+     * Sets the scheme.
+     * @param scheme - a #GtkSourceStyleScheme
+     */
     setStyleScheme(scheme: StyleScheme): void;
     connect(signal: "notify", handler: (self: StyleSchemeChooserButton, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gtksource/style-scheme-chooser-button.js

@@ -2,13 +2,30 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { StyleScheme } from "./style-scheme.js";
 import * as Gtk from "../gtk/index.js";
+/**
+ * A button to launch a style scheme selection dialog.
+ *
+ * The `GtkSourceStyleSchemeChooserButton` is a button which displays
+ * the currently selected style scheme and allows to open a style scheme
+ * selection dialog to change the style scheme.
+ * It is suitable widget for selecting a style scheme in a preference dialog.
+ *
+ * In `GtkSourceStyleSchemeChooserButton`, a [class@StyleSchemeChooserWidget]
+ * is used to provide a dialog for selecting style schemes.
+ */
 export class StyleSchemeChooserButton extends Gtk.Button {
+    /**
+     * Creates a new #GtkSourceStyleSchemeChooserButton.
+     */
     constructor(...args) {
         super(...args);
     }
     createPtr(_args) {
         return call("libgtksourceview-5.so.0", "gtk_source_style_scheme_chooser_button_new", [], { type: "gobject", borrowed: true });
     }
+    /**
+     * Gets the currently-selected scheme.
+     */
     getStyleScheme() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_style_scheme_chooser_get_style_scheme", [
             {
@@ -18,6 +35,10 @@ export class StyleSchemeChooserButton extends Gtk.Button {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, StyleScheme);
     }
+    /**
+     * Sets the scheme.
+     * @param scheme - a #GtkSourceStyleScheme
+     */
     setStyleScheme(scheme) {
         call("libgtksourceview-5.so.0", "gtk_source_style_scheme_chooser_set_style_scheme", [
             {

package/dist/generated/gtksource/style-scheme-chooser-widget.d.ts

@@ -1,10 +1,32 @@
 import { StyleScheme } from "./style-scheme.js";
 import * as GObject from "../gobject/index.js";
 import * as Gtk from "../gtk/index.js";
+/**
+ * A widget for choosing style schemes.
+ *
+ * The `GtkSourceStyleSchemeChooserWidget` widget lets the user select a
+ * style scheme. By default, the chooser presents a predefined list
+ * of style schemes.
+ *
+ * To change the initially selected style scheme,
+ * use [method@StyleSchemeChooser.set_style_scheme].
+ * To get the selected style scheme
+ * use [method@StyleSchemeChooser.get_style_scheme].
+ */
 export declare class StyleSchemeChooserWidget extends Gtk.Widget {
+    /**
+     * Creates a new #GtkSourceStyleSchemeChooserWidget.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Gets the currently-selected scheme.
+     */
     getStyleScheme(): StyleScheme;
+    /**
+     * Sets the scheme.
+     * @param scheme - a #GtkSourceStyleScheme
+     */
     setStyleScheme(scheme: StyleScheme): void;
     connect(signal: "notify", handler: (self: StyleSchemeChooserWidget, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gtksource/style-scheme-chooser-widget.js

@@ -2,13 +2,31 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { StyleScheme } from "./style-scheme.js";
 import * as Gtk from "../gtk/index.js";
+/**
+ * A widget for choosing style schemes.
+ *
+ * The `GtkSourceStyleSchemeChooserWidget` widget lets the user select a
+ * style scheme. By default, the chooser presents a predefined list
+ * of style schemes.
+ *
+ * To change the initially selected style scheme,
+ * use [method@StyleSchemeChooser.set_style_scheme].
+ * To get the selected style scheme
+ * use [method@StyleSchemeChooser.get_style_scheme].
+ */
 export class StyleSchemeChooserWidget extends Gtk.Widget {
+    /**
+     * Creates a new #GtkSourceStyleSchemeChooserWidget.
+     */
     constructor(...args) {
         super(...args);
     }
     createPtr(_args) {
         return call("libgtksourceview-5.so.0", "gtk_source_style_scheme_chooser_widget_new", [], { type: "gobject", borrowed: true });
     }
+    /**
+     * Gets the currently-selected scheme.
+     */
     getStyleScheme() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_style_scheme_chooser_get_style_scheme", [
             {
@@ -18,6 +36,10 @@ export class StyleSchemeChooserWidget extends Gtk.Widget {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, StyleScheme);
     }
+    /**
+     * Sets the scheme.
+     * @param scheme - a #GtkSourceStyleScheme
+     */
     setStyleScheme(scheme) {
         call("libgtksourceview-5.so.0", "gtk_source_style_scheme_chooser_set_style_scheme", [
             {

package/dist/generated/gtksource/style-scheme-chooser.d.ts

@@ -1,8 +1,24 @@
 import { StyleScheme } from "./style-scheme.js";
+/**
+ * Interface implemented by widgets for choosing style schemes.
+ *
+ * `GtkSourceStyleSchemeChooser` is an interface that is implemented by widgets
+ * for choosing style schemes.
+ *
+ * In GtkSourceView, the main widgets that implement this interface are
+ * [class@StyleSchemeChooserWidget] and [class@StyleSchemeChooserButton].
+ */
 export declare class StyleSchemeChooser {
     ptr: unknown;
     protected constructor(ptr: unknown);
     static fromPtr(ptr: unknown): StyleSchemeChooser;
+    /**
+     * Gets the currently-selected scheme.
+     */
     getStyleScheme(): StyleScheme;
+    /**
+     * Sets the scheme.
+     * @param scheme - a #GtkSourceStyleScheme
+     */
     setStyleScheme(scheme: StyleScheme): void;
 }