@girs/gspell-1 5.1.0 → 5.3.0

package/README.md

@@ -4,7 +4,7 @@
 ![version](https://img.shields.io/npm/v/@girs/gspell-1)
 ![downloads/week](https://img.shields.io/npm/dw/@girs/gspell-1)
 
-GJS TypeScript type definitions for Gspell-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v5.1.0.
+GJS TypeScript type definitions for Gspell-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v5.3.0.
 
 This package contains type declarations only. It ships no runtime code, so it adds
 nothing to your program and works with any bundler or none at all.

package/gspell-1-vocabulary.d.ts

@@ -1,9 +1,9 @@
 /**
  * The GIR-derived widget VOCABULARY for Gspell-1.
  *
- * GENERATED — do not edit. Provenance: Gspell-1 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object Atk.ImplementorIface
+ * GENERATED — do not edit. Provenance: Gspell-1 — dropped empty base(s): Atk.ImplementorIface
  *
- * 3 concrete widgets, 4 declarations, 0 enum nick unions, 0 slot candidates.
+ * 9 instantiable GTypes (of which 3 concrete widgets), 11 declarations, 0 enum nick unions, 0 slot candidates.
  *
  * Module-scoped exports only. There is no `JSX` namespace here, no tag spelling and
  * no `on<Signal>` prop name: those are DIALECT, and every framework answers them
@@ -25,6 +25,8 @@
  */
 
 import type Gspell from './gspell-1.js';
+import type Gtk from '@girs/gtk-3.0';
+import type { GInitiallyUnownedConstructOnly, GInitiallyUnownedProps, GObjectConstructOnly, GObjectProps } from '@girs/gobject-2.0/vocabulary';
 import type { GtkActionableConstructOnly, GtkActionableProps, GtkActivatableConstructOnly, GtkActivatableProps, GtkBinConstructOnly, GtkBinProps, GtkBuildableConstructOnly, GtkBuildableProps, GtkButtonConstructOnly, GtkButtonProps, GtkContainerConstructOnly, GtkContainerProps, GtkDialogConstructOnly, GtkDialogProps, GtkWidgetConstructOnly, GtkWidgetProps, GtkWindowConstructOnly, GtkWindowProps } from '@girs/gtk-3.0/vocabulary';
 
 // ---------------------------------------------------------------------------
@@ -49,6 +51,13 @@ import type { GtkActionableConstructOnly, GtkActionableProps, GtkActivatableCons
 // GIR keeps them once, on the interface.
 // ---------------------------------------------------------------------------
 
+export interface GspellCheckerProps extends GObjectProps {
+    /** The #GspellLanguage used. */
+    language?: Gspell.Language | null;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GspellCheckerConstructOnly = GObjectConstructOnly;
+
 export interface GspellCheckerDialogProps extends GtkDialogProps, GtkBuildableProps {
     /** The #GspellNavigator to use. */
     'spell-navigator'?: Gspell.Navigator;
@@ -56,14 +65,45 @@ export interface GspellCheckerDialogProps extends GtkDialogProps, GtkBuildablePr
 /** Settable only at construction — a renderer must REBUILD, not patch. */
 export type GspellCheckerDialogConstructOnly = GtkDialogConstructOnly | GtkBuildableConstructOnly | 'spell-navigator';
 
-export interface GspellLanguageChooserProps {
+export interface GspellEntryProps extends GObjectProps {
+    /**
+     * The #GtkEntry.
+     * @since 1.4
+     */
+    entry?: Gtk.Entry;
+    /**
+     * Whether the inline spell checking is enabled.
+     * @since 1.4
+     * @default FALSE
+     */
+    'inline-spell-checking'?: boolean;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GspellEntryConstructOnly = GObjectConstructOnly | 'entry';
+
+export interface GspellEntryBufferProps extends GObjectProps {
+    /**
+     * The #GtkEntryBuffer.
+     * @since 1.4
+     */
+    buffer?: Gtk.EntryBuffer;
+    /**
+     * The #GspellChecker.
+     * @since 1.4
+     */
+    'spell-checker'?: Gspell.Checker | null;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GspellEntryBufferConstructOnly = GObjectConstructOnly | 'buffer';
+
+export interface GspellLanguageChooserProps extends GObjectProps {
     /** The selected #GspellLanguage. */
     language?: Gspell.Language | null;
     /** The empty string if the default language was set and the selection hasn't changed. */
     'language-code'?: string;
 }
 /** Settable only at construction — a renderer must REBUILD, not patch. */
-export type GspellLanguageChooserConstructOnly = never;
+export type GspellLanguageChooserConstructOnly = GObjectConstructOnly;
 
 export interface GspellLanguageChooserButtonProps extends GtkButtonProps, GspellLanguageChooserProps, GtkActionableProps, GtkActivatableProps, GtkBuildableProps {
 }
@@ -75,6 +115,45 @@ export interface GspellLanguageChooserDialogProps extends GtkDialogProps, Gspell
 /** Settable only at construction — a renderer must REBUILD, not patch. */
 export type GspellLanguageChooserDialogConstructOnly = GtkDialogConstructOnly | GspellLanguageChooserConstructOnly | GtkBuildableConstructOnly;
 
+export interface GspellNavigatorProps extends GInitiallyUnownedProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GspellNavigatorConstructOnly = GInitiallyUnownedConstructOnly;
+
+export interface GspellNavigatorTextViewProps extends GInitiallyUnownedProps, GspellNavigatorProps {
+    /** The #GtkTextView. */
+    view?: Gtk.TextView;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GspellNavigatorTextViewConstructOnly = GInitiallyUnownedConstructOnly | GspellNavigatorConstructOnly | 'view';
+
+export interface GspellTextBufferProps extends GObjectProps {
+    /** The #GtkTextBuffer. */
+    buffer?: Gtk.TextBuffer;
+    /** The #GspellChecker. */
+    'spell-checker'?: Gspell.Checker | null;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GspellTextBufferConstructOnly = GObjectConstructOnly | 'buffer';
+
+export interface GspellTextViewProps extends GObjectProps {
+    /**
+     * When the context menu is shown, whether to add a sub-menu to select the language for the spell checking.
+     * @since 1.2
+     * @default FALSE
+     */
+    'enable-language-menu'?: boolean;
+    /**
+     * Whether the inline spell checking is enabled.
+     * @default FALSE
+     */
+    'inline-spell-checking'?: boolean;
+    /** The #GtkTextView. */
+    view?: Gtk.TextView;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GspellTextViewConstructOnly = GObjectConstructOnly | 'view';
+
 // ---------------------------------------------------------------------------
 // The GType-keyed widget map.
 //
@@ -114,7 +193,11 @@ export interface Widgets {
     };
 }
 
-/** Every GType this namespace can create. A consumer derives its own tag map. */
+/**
+ * Every GType this namespace can create AND put on screen. A consumer derives its own
+ * tag map. For everything a UI file can instantiate — layout managers, event
+ * controllers, cell renderers, `GtkSizeGroup` — read `DECLS` below.
+ */
 export type WidgetGType = keyof Widgets;
 
 // ---------------------------------------------------------------------------
@@ -166,7 +249,38 @@ export const PROVENANCE: {
     readonly childHolders: number;
     readonly droppedBases: readonly string[];
     readonly inlinedBases: readonly string[];
+    /** `<decl>.<prop>` for every property printed `never` because TypeScript has no value for it. */
     readonly unsettableProps: readonly string[];
+    /**
+     * `<decl>.<prop>: <Ns>.<Name>` for every property printed `never` because the model
+     * could not resolve its type across a namespace boundary — two independently released
+     * GIRs disagreeing, which is what the main emitter answers `never` for as well.
+     */
+    readonly unresolvedProps: readonly string[];
+    /**
+     * `c:identifier-prefixes` from the GIR, verbatim and in order — `['G']` for Gio.
+     *
+     * The C prefix a type REFERENCE needs: resolving `Gio.Icon` means producing `GIcon`,
+     * and nothing else in this package states that `Gio` spells itself `G`. Carried rather
+     * than derived because GIR carries it, and a derivation over the `DECLS` keys is wrong
+     * wherever the C prefix is not a prefix of the type NAMES: gdkx11-4.0 and gdkwayland-4.0
+     * both state `Gdk` while every key they declare begins `GdkX11`/`GdkWayland`.
+     *
+     * Empty where the GIR states none — 17 of the 627 emitting namespaces — because
+     * inventing the namespace name there is a confident wrong answer in place of a missing
+     * one. A LIST because 20 of them state more than one, which no single string expresses.
+     */
+    readonly identifierPrefixes: readonly string[];
+    /**
+     * Sibling vocabularies this one's DECLARATIONS come from, as import specifiers.
+     *
+     * A chain link with no `OWN_PROPS` row is ambiguous on its own — `GtkSeparator` has no
+     * settable property, `GApplication` has its properties in another package — and this
+     * list is what tells the two apart. Enum and bitfield NUMBERS are not here: those are
+     * carried in this file, because a `PROP_ENUMS` row naming a foreign GType gives a
+     * consumer nothing to load and a `.ui` file using the property never names its owner.
+     */
+    readonly requiredVocabularies: readonly string[];
 };
 
 /** Declaration GType -> its own settable properties, as GObject registered them. */
@@ -180,7 +294,17 @@ export const OWN_PROPS: Readonly<Record<string, readonly string[]>>;
  */
 export const OWN_SIGNALS: Readonly<Record<string, readonly string[]>>;
 
-/** Widget GType -> every declaration its members come from, self first. */
+/**
+ * Instantiable GType -> every declaration its members come from, self first.
+ *
+ * The key set is what a UI description file can NAME: every registered, non-abstract
+ * class this namespace declares. GtkBuilder resolves a `<object class="…">` through
+ * `g_type_from_name`, which knows nothing about widgets, so this is wider than
+ * `Widgets` by design — `GtkSizeGroup`, `GtkTextTag`, every `GtkEventController`
+ * and every `GtkCellRenderer` are here and are not widgets.
+ *
+ * `Widgets` and `CHILD_HOLDERS` are the narrower questions and answer them unchanged.
+ */
 export const DECLS: Readonly<Record<string, readonly string[]>>;
 
 /** The GTypes in `DECLS` that hold a widget without being one — see `ChildHolders`. */
@@ -192,8 +316,8 @@ export const ENUM_NICKS: Readonly<Record<string, readonly string[]>>;
 /**
  * `<enum GType>.<nick>` -> the integer GObject registers for it, from GIR's `value`.
  *
- * Position in `ENUM_NICKS` is NOT this number. Counting is wrong on 6 of the 129 enums a
- * GTK 4 vocabulary carries -- 104 in Gtk-4.0 and 25 in Adw-1: `GtkResponseType` runs -1 to -11, `GtkTextWindowType` starts
+ * Position in `ENUM_NICKS` is NOT this number. Counting is wrong on 6 of the 137 enums a
+ * GTK 4 vocabulary carries -- 112 in Gtk-4.0 and 25 in Adw-1: `GtkResponseType` runs -1 to -11, `GtkTextWindowType` starts
  * at 1, `GtkOrdering` and `GtkConstraintRelation` are -1/0/1, `GtkAlign` has two names
  * on one value, and `GtkConstraintStrength.required` is 1001001000 where counting says 0.
  *
@@ -231,10 +355,11 @@ export const ENUM_VALUES_UNREADABLE: Readonly<Record<string, string>>;
  *
  * `ENUM_NICKS` carries no bitfield, because GObject cannot resolve a nick SET; that says
  * nothing about a single member's number, and the number is what a host without GI needs.
- * 21 writable widget properties in Gtk-4.0 and Adw-1 are bitfield-typed and are declared
- * bare `number` -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`, `AdwTabView:shortcuts`
- * among them. Counting is worst here: 95 of 121 Gtk-4.0 bitfield members disagree with their
- * position, against 29 of 685 enumeration members.
+ * 23 settable properties in Gtk-4.0 and Adw-1 are bitfield-typed and are declared bare
+ * `number` -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`, `AdwTabView:shortcuts`,
+ * `GtkDropTarget:actions` among them. Counting is worst here: 119 of the 156 Gtk-4.0
+ * bitfield members this vocabulary carries disagree with their declaration position,
+ * against 29 of 672 enumeration members.
  *
  * Combine with `|` as GObject does. There is no nick table to pair this with, so a name
  * here is resolvable and a SET still is not.
@@ -258,7 +383,7 @@ export const FLAG_VALUES_UNREADABLE: Readonly<Record<string, string>>;
  *
  * The GType named here is not always one THIS module gives numbers for. A nick vocabulary is
  * emitted once, by the namespace that owns the enum, so `AdwComboRow.search-match-mode` names
- * `GtkStringFilterMatchMode` and its rows are in `@girs/gtk-4.0/vocabulary` — 57 of the 438
+ * `GtkStringFilterMatchMode` and its rows are in `@girs/gtk-4.0/vocabulary` — 83 of the 909
  * entries in a full run resolve only with the owner's vocabulary loaded beside this one. An
  * owner with no vocabulary of its own (Gdk, Pango) is inlined here instead, so every entry
  * resolves against SOME module.

package/gspell-1-vocabulary.js

@@ -1,6 +1,6 @@
 // The widget vocabulary of Gspell-1 as runtime data.
 //
-// GENERATED — do not edit. Provenance: Gspell-1 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object Atk.ImplementorIface
+// GENERATED — do not edit. Provenance: Gspell-1 — dropped empty base(s): Atk.ImplementorIface
 //
 // The type half of this subpath is the sibling `.d.ts`. This file exists because
 // types are erased: a consumer that wants to ask the installed library whether every
@@ -11,28 +11,53 @@ export const PROVENANCE = {
     version: '1',
     libraryVersion: null,
     childHolders: 0,
-    droppedBases: ['GObject.InitiallyUnowned', 'GObject.Object', 'Atk.ImplementorIface'],
+    droppedBases: ['Atk.ImplementorIface'],
     inlinedBases: [],
     unsettableProps: [],
+    unresolvedProps: [],
+    identifierPrefixes: ['Gspell'],
+    requiredVocabularies: ['@girs/gobject-2.0/vocabulary', '@girs/gtk-3.0/vocabulary'],
 };
 
 export const OWN_PROPS = {
+    GspellChecker: ['language'],
     GspellCheckerDialog: ['spell-navigator'],
+    GspellEntry: ['entry', 'inline-spell-checking'],
+    GspellEntryBuffer: ['buffer', 'spell-checker'],
     GspellLanguageChooser: ['language', 'language-code'],
+    GspellNavigatorTextView: ['view'],
+    GspellTextBuffer: ['buffer', 'spell-checker'],
+    GspellTextView: ['enable-language-menu', 'inline-spell-checking', 'view'],
 };
 
-export const OWN_SIGNALS = {};
+export const OWN_SIGNALS = {
+    GspellChecker: ['session-cleared', 'word-added-to-personal', 'word-added-to-session'],
+};
 
+// Every GType this namespace can INSTANTIATE -> the declarations its members come from.
+//
+// The key set is what a UI description file can name: a registered, non-abstract class.
+// Not "every widget" — GtkBuilder resolves a name through `g_type_from_name`, which knows
+// nothing about widgets, and a `.ui` file is full of `GtkSizeGroup`, `GtkTextTag`,
+// `GtkEventController*` and `GtkCellRenderer*`. Use `Widgets` and `CHILD_HOLDERS`
+// below for the narrower questions; they did not move.
 export const DECLS = {
-    GspellCheckerDialog: ['GspellCheckerDialog', 'GtkDialog', 'GtkWindow', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
-    GspellLanguageChooserButton: ['GspellLanguageChooserButton', 'GtkButton', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GspellLanguageChooser', 'GtkActionable', 'GtkActivatable', 'GtkBuildable'],
-    GspellLanguageChooserDialog: ['GspellLanguageChooserDialog', 'GtkDialog', 'GtkWindow', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GspellLanguageChooser', 'GtkBuildable'],
+    GspellChecker: ['GspellChecker', 'GObject'],
+    GspellCheckerDialog: ['GspellCheckerDialog', 'GtkDialog', 'GtkWindow', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GtkBuildable'],
+    GspellEntry: ['GspellEntry', 'GObject'],
+    GspellEntryBuffer: ['GspellEntryBuffer', 'GObject'],
+    GspellLanguageChooserButton: ['GspellLanguageChooserButton', 'GtkButton', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GspellLanguageChooser', 'GtkActionable', 'GtkActivatable', 'GtkBuildable'],
+    GspellLanguageChooserDialog: ['GspellLanguageChooserDialog', 'GtkDialog', 'GtkWindow', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GspellLanguageChooser', 'GtkBuildable'],
+    GspellNavigatorTextView: ['GspellNavigatorTextView', 'GInitiallyUnowned', 'GObject', 'GspellNavigator'],
+    GspellTextBuffer: ['GspellTextBuffer', 'GObject'],
+    GspellTextView: ['GspellTextView', 'GObject'],
 };
 
-// The GTypes above that are NOT widgets: they hold one through `set_child`/`get_child`
-// and descend from `GObject.Object`. A renderer places them like a container; a check
-// asking "is this a widget" must not count them. Derived from the accessor pair, never
-// from a list — the count is in the provenance line above.
+// The GTypes above that ARE widgets are the `Widgets` map in the sibling `.d.ts`; these
+// are the ones that merely HOLD one, through `set_child`/`get_child`, descending from
+// `GObject.Object`. A renderer places them like a container; a check asking "is this a
+// widget" must not count them. Derived from the accessor pair, never from a list — the
+// count is in the provenance line above.
 export const CHILD_HOLDERS = [];
 
 export const ENUM_NICKS = {};
@@ -42,7 +67,7 @@ export const ENUM_NICKS = {};
 // It ships because position in `ENUM_NICKS` is not the value and a consumer with no
 // typelib has no other way to learn it: a surface without GI still has to hand GObject an
 // integer. The alternative a consumer reaches for first is counting, and counting is wrong
-// on 6 of the 129 enums a GTK 4 vocabulary carries (104 in Gtk-4.0, 25 in Adw-1) --
+// on 6 of the 137 enums a GTK 4 vocabulary carries (112 in Gtk-4.0, 25 in Adw-1) --
 // `GtkResponseType` runs -1 down to
 // -11, `GtkTextWindowType` starts at 1, and `GtkConstraintStrength.required` is
 // 1001001000 where counting answers 0.
@@ -79,11 +104,12 @@ export const ENUM_VALUES_UNREADABLE = {};
 // The number behind each member of a registered BITFIELD, keyed the same way.
 //
 // `ENUM_NICKS` refuses a bitfield because GObject cannot resolve a nick SET, and that
-// reason says nothing about one member's number. 21 writable widget properties in Gtk-4.0
-// and Adw-1 are bitfield-typed -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`,
-// `AdwTabView:shortcuts`, ... -- and they are typed bare `number`, so a host without GI
-// has nothing to compute one from. Counting is worst exactly here: 95 of 121 Gtk-4.0
-// bitfield members disagree with their position, against 29 of 685 enumeration members.
+// reason says nothing about one member's number. 23 settable properties in Gtk-4.0 and
+// Adw-1 are bitfield-typed -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`,
+// `AdwTabView:shortcuts`, `GtkDropTarget:actions`, ... -- and they are typed bare
+// `number`, so a host without GI has nothing to compute one from. Counting is worst
+// exactly here: 119 of the 156 Gtk-4.0 bitfield members this vocabulary carries disagree
+// with their declaration position, against 29 of 672 enumeration members.
 //
 // A table of its own rather than more rows in `ENUM_VALUES`, so that "every nick in
 // `ENUM_NICKS` has a number or a declared reason" stays a claim about one set.
@@ -106,7 +132,7 @@ export const FLAG_VALUES_UNREADABLE = {};
 // one are both entries a consumer would resolve wrongly, so neither is written.
 //
 // A GType named here has numbers in SOME vocabulary, not necessarily this one: the namespace
-// that OWNS an enum publishes it, so 57 of the 438 entries a full run emits want the owner's
+// that OWNS an enum publishes it, so 83 of the 909 entries a full run emits want the owner's
 // vocabulary loaded too. Owners that emit none (Gdk, Pango) are inlined into the tables above.
 export const PROP_ENUMS = {};
 
@@ -137,4 +163,10 @@ export const ARIA_VALUE_ENUMS = {};
 
 export const SLOT_CANDIDATES = {};
 
-export const SINCE = {};
+export const SINCE = {
+    'GspellEntry.entry': '1.4',
+    'GspellEntry.inline-spell-checking': '1.4',
+    'GspellEntryBuffer.buffer': '1.4',
+    'GspellEntryBuffer.spell-checker': '1.4',
+    'GspellTextView.enable-language-menu': '1.2',
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/gspell-1",
-    "version": "5.1.0",
+    "version": "5.3.0",
     "description": "GJS TypeScript type definitions for Gspell-1",
     "type": "module",
     "module": "gspell-1.js",
@@ -36,20 +36,20 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^5.1.0",
-      "@girs/gtk-3.0": "^5.1.0",
-      "@girs/xlib-2.0": "^5.1.0",
-      "@girs/gdk-3.0": "^5.1.0",
-      "@girs/cairo-1.0": "^5.1.0",
-      "@girs/gobject-2.0": "^5.1.0",
-      "@girs/glib-2.0": "^5.1.0",
-      "@girs/pango-1.0": "^5.1.0",
-      "@girs/harfbuzz-0.0": "^5.1.0",
-      "@girs/freetype2-2.0": "^5.1.0",
-      "@girs/gio-2.0": "^5.1.0",
-      "@girs/gmodule-2.0": "^5.1.0",
-      "@girs/gdkpixbuf-2.0": "^5.1.0",
-      "@girs/atk-1.0": "^5.1.0"    },
+      "@girs/gjs": "^5.3.0",
+      "@girs/gtk-3.0": "^5.3.0",
+      "@girs/xlib-2.0": "^5.3.0",
+      "@girs/gdk-3.0": "^5.3.0",
+      "@girs/cairo-1.0": "^5.3.0",
+      "@girs/gobject-2.0": "^5.3.0",
+      "@girs/glib-2.0": "^5.3.0",
+      "@girs/pango-1.0": "^5.3.0",
+      "@girs/harfbuzz-0.0": "^5.3.0",
+      "@girs/freetype2-2.0": "^5.3.0",
+      "@girs/gio-2.0": "^5.3.0",
+      "@girs/gmodule-2.0": "^5.3.0",
+      "@girs/gdkpixbuf-2.0": "^5.3.0",
+      "@girs/atk-1.0": "^5.3.0"    },
     "devDependencies": {
       "typescript": "*"
     },