@girs/foundryadw-1 4.2.0 → 4.3.0

package/README.md

@@ -5,25 +5,25 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/foundryadw-1)
 
 
-GJS TypeScript type definitions for FoundryAdw-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
+GJS TypeScript type definitions for FoundryAdw-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.0.
 
 ## Install
 
-To use this type definitions, install them with NPM:
+Install the type definitions with npm:
 ```bash
 npm install @girs/foundryadw-1
 ```
 
 ## Usage
 
-You can import this package into your project like this:
+Import it like any other module:
 ```ts
 import FoundryAdw from '@girs/foundryadw-1';
 ```
 
 ### Ambient Modules
 
-You can also use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) to import this module like you would do this in JavaScript.
+[Ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) let you write the same import you would in plain JavaScript.
 For this you need to include `@girs/foundryadw-1` or `@girs/foundryadw-1/ambient` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/foundryadw-1'
 }
 ```
 
-Now you can import the ambient module with TypeScript support: 
+The ambient module now resolves with types:
 
 ```ts
 import FoundryAdw from 'gi://FoundryAdw?version=1';
@@ -50,7 +50,7 @@ import FoundryAdw from 'gi://FoundryAdw?version=1';
 
 ### Global import
 
-You can also import the module with Typescript support using the global `imports.gi` object of GJS.
+GJS's global `imports.gi` works too, with types.
 For this you need to include `@girs/foundryadw-1` or `@girs/foundryadw-1/import` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/foundryadw-1'
 }
 ```
 
-Now you have also type support for this, too:
+That form carries types as well:
 
 ```ts
 const FoundryAdw = imports.gi.FoundryAdw;
@@ -77,7 +77,7 @@ const FoundryAdw = imports.gi.FoundryAdw;
 
 ### Bundle
 
-Depending on your project configuration, it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). You can find examples using different bundlers [here](https://github.com/gjsify/ts-for-gir/tree/main/examples).
+Most projects want a bundler. [esbuild](https://esbuild.github.io/) is the smallest thing that works; the [examples directory](https://github.com/gjsify/ts-for-gir/tree/main/examples) has setups for several others.
 
 ## Other packages
 

package/foundryadw-1.d.ts

@@ -31,6 +31,7 @@ import type Json from '@girs/json-1.0';
 import type GtkSource from '@girs/gtksource-5';
 import type Foundry from '@girs/foundry-1';
 import type Dex from '@girs/dex-1';
+import type GioUnix from '@girs/giounix-2.0';
 import type Adw from '@girs/adw-1';
 
 export namespace FoundryAdw {
@@ -227,9 +228,11 @@ export namespace FoundryAdw {
             "notify::vexpand-set": (pspec: GObject.ParamSpec) => void;
             "notify::visible": (pspec: GObject.ParamSpec) => void;
             "notify::width-request": (pspec: GObject.ParamSpec) => void;
+            "notify::complete-text": (pspec: GObject.ParamSpec) => void;
             "notify::cursor-position": (pspec: GObject.ParamSpec) => void;
             "notify::editable": (pspec: GObject.ParamSpec) => void;
             "notify::enable-undo": (pspec: GObject.ParamSpec) => void;
+            "notify::input-interceptor": (pspec: GObject.ParamSpec) => void;
             "notify::max-width-chars": (pspec: GObject.ParamSpec) => void;
             "notify::selection-bound": (pspec: GObject.ParamSpec) => void;
             "notify::text": (pspec: GObject.ParamSpec) => void;
@@ -323,6 +326,24 @@ export namespace FoundryAdw {
          */
         set_file_type(file_type: Gio.FileType): void;
 
+        /**
+         * The contents of the entry, including uncommited content such as the
+         * preedit.
+         * @since 4.24
+         * @read-only
+          * @category Inherited from Gtk.Editable
+         */
+        get complete_text(): string;
+
+        /**
+         * The contents of the entry, including uncommited content such as the
+         * preedit.
+         * @since 4.24
+         * @read-only
+          * @category Inherited from Gtk.Editable
+         */
+        get completeText(): string;
+
         /**
          * The current position of the insertion cursor in chars.
          * @read-only
@@ -363,6 +384,22 @@ export namespace FoundryAdw {
         get enableUndo(): boolean;
         set enableUndo(val: boolean);
 
+        /**
+         * The widget used to intercept input for this editable
+         * @since 4.24
+          * @category Inherited from Gtk.Editable
+         */
+        get input_interceptor(): Gtk.Widget | null;
+        set input_interceptor(val: Gtk.Widget | null);
+
+        /**
+         * The widget used to intercept input for this editable
+         * @since 4.24
+          * @category Inherited from Gtk.Editable
+         */
+        get inputInterceptor(): Gtk.Widget | null;
+        set inputInterceptor(val: Gtk.Widget | null);
+
         /**
          * The desired maximum width of the entry, in characters.
          * @default -1
@@ -469,7 +506,7 @@ export namespace FoundryAdw {
         /**
          * Deletes the currently selected text of the editable.
          * 
-         * This call doesn’t do anything if there is no selected text.
+         * This call doesn’t do anything if there is no selected text.
          */
         delete_selection(): void;
 
@@ -516,6 +553,13 @@ export namespace FoundryAdw {
          */
         get_chars(start_pos: number, end_pos: number): string;
 
+        /**
+         * Retrieves the contents of `editable`, including *pseudo-content*
+         * such as the preedit buffer.
+         * @returns the complete contents of the editable
+         */
+        get_complete_text(): string;
+
         /**
          * Gets the {@link Gtk.Editable} that `editable` is delegating its
          * implementation to.
@@ -537,6 +581,13 @@ export namespace FoundryAdw {
          */
         get_enable_undo(): boolean;
 
+        /**
+         * Retrieves the widget that was previously set up as input interceptor
+         * for `editable`. See {@link Gtk.Editable.set_input_interceptor}.
+         * @returns The editable widget
+         */
+        get_input_interceptor(): Gtk.Widget | null;
+
         /**
          * Retrieves the desired maximum width of `editable`, in characters.
          * @returns the maximum width of the entry, in characters
@@ -643,6 +694,21 @@ export namespace FoundryAdw {
          */
         set_enable_undo(enable_undo: boolean): void;
 
+        /**
+         * Sets `interceptor` as the widget that `editable` will intercept key events from.
+         * 
+         * A typical usecase for this is implementing auto-showing search entries, so
+         * that textual input may be intercepted from another widget and handled first
+         * hand by the given editable. The events will be handled in the bubble phase
+         * of `interceptor`, which means that editable child widgets of `interceptor` will
+         * receive the text input before it can be captured.
+         * 
+         * Only those events that would be handled by an input method will be handled,
+         * this excludes combinations of Ctrl/Alt/Mod, and other shortcuts.
+         * @param interceptor the input interceptor widget
+         */
+        set_input_interceptor(interceptor: Gtk.Widget | null): void;
+
         /**
          * Sets the desired maximum width in characters of `editable`.
          * @param n_chars the new desired maximum width, in characters
@@ -729,6 +795,13 @@ export namespace FoundryAdw {
          */
         vfunc_do_insert_text(text: string, length: number, position: number): number;
 
+        /**
+         * Retrieves the contents of `editable`, including *pseudo-content*
+         * such as the preedit buffer.
+         * @virtual
+         */
+        vfunc_get_complete_text(): string;
+
         /**
          * Gets the {@link Gtk.Editable} that `editable` is delegating its
          * implementation to.
@@ -1421,7 +1494,7 @@ export namespace FoundryAdw {
         /**
          * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
          *   {@link Gtk.Widget} stores the name as object data. Implement this method if your
-         *   object has some notion of “ID” and it makes sense to map the XML id
+         *   object has some notion of “ID” and it makes sense to map the XML id
          *   attribute to it.
          * @param id 
          * @virtual
@@ -1975,7 +2048,7 @@ export namespace FoundryAdw {
         /**
          * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
          *   {@link Gtk.Widget} stores the name as object data. Implement this method if your
-         *   object has some notion of “ID” and it makes sense to map the XML id
+         *   object has some notion of “ID” and it makes sense to map the XML id
          *   attribute to it.
          * @param id 
          * @virtual
@@ -2461,7 +2534,7 @@ export namespace FoundryAdw {
         /**
          * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
          *   {@link Gtk.Widget} stores the name as object data. Implement this method if your
-         *   object has some notion of “ID” and it makes sense to map the XML id
+         *   object has some notion of “ID” and it makes sense to map the XML id
          *   attribute to it.
          * @param id 
          * @virtual
@@ -2923,7 +2996,7 @@ export namespace FoundryAdw {
         /**
          * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
          *   {@link Gtk.Widget} stores the name as object data. Implement this method if your
-         *   object has some notion of “ID” and it makes sense to map the XML id
+         *   object has some notion of “ID” and it makes sense to map the XML id
          *   attribute to it.
          * @param id 
          * @virtual
@@ -4005,7 +4078,7 @@ export namespace FoundryAdw {
         /**
          * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
          *   {@link Gtk.Widget} stores the name as object data. Implement this method if your
-         *   object has some notion of “ID” and it makes sense to map the XML id
+         *   object has some notion of “ID” and it makes sense to map the XML id
          *   attribute to it.
          * @param id 
          * @virtual
@@ -4725,7 +4798,7 @@ export namespace FoundryAdw {
         /**
          * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
          *   {@link Gtk.Widget} stores the name as object data. Implement this method if your
-         *   object has some notion of “ID” and it makes sense to map the XML id
+         *   object has some notion of “ID” and it makes sense to map the XML id
          *   attribute to it.
          * @param id 
          * @virtual

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/foundryadw-1",
-    "version": "4.2.0",
+    "version": "4.3.0",
     "description": "GJS TypeScript type definitions for FoundryAdw-1",
     "type": "module",
     "module": "foundryadw-1.js",
@@ -36,28 +36,29 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.2.0",
-      "@girs/peas-2": "^4.2.0",
-      "@girs/gio-2.0": "^4.2.0",
-      "@girs/gobject-2.0": "^4.2.0",
-      "@girs/glib-2.0": "^4.2.0",
-      "@girs/gmodule-2.0": "^4.2.0",
-      "@girs/gtk-4.0": "^4.2.0",
-      "@girs/gsk-4.0": "^4.2.0",
-      "@girs/graphene-1.0": "^4.2.0",
-      "@girs/gdk-4.0": "^4.2.0",
-      "@girs/cairo-1.0": "^4.2.0",
-      "@girs/pangocairo-1.0": "^4.2.0",
-      "@girs/pango-1.0": "^4.2.0",
-      "@girs/harfbuzz-0.0": "^4.2.0",
-      "@girs/freetype2-2.0": "^4.2.0",
-      "@girs/gdkpixbuf-2.0": "^4.2.0",
-      "@girs/foundrygtk-1": "^4.2.0",
-      "@girs/json-1.0": "^4.2.0",
-      "@girs/gtksource-5": "^4.2.0",
-      "@girs/foundry-1": "^4.2.0",
-      "@girs/dex-1": "^4.2.0",
-      "@girs/adw-1": "^4.2.0"    },
+      "@girs/gjs": "^4.3.0",
+      "@girs/peas-2": "^4.3.0",
+      "@girs/gio-2.0": "^4.3.0",
+      "@girs/gobject-2.0": "^4.3.0",
+      "@girs/glib-2.0": "^4.3.0",
+      "@girs/gmodule-2.0": "^4.3.0",
+      "@girs/gtk-4.0": "^4.3.0",
+      "@girs/gsk-4.0": "^4.3.0",
+      "@girs/graphene-1.0": "^4.3.0",
+      "@girs/gdk-4.0": "^4.3.0",
+      "@girs/cairo-1.0": "^4.3.0",
+      "@girs/pangocairo-1.0": "^4.3.0",
+      "@girs/pango-1.0": "^4.3.0",
+      "@girs/harfbuzz-0.0": "^4.3.0",
+      "@girs/freetype2-2.0": "^4.3.0",
+      "@girs/gdkpixbuf-2.0": "^4.3.0",
+      "@girs/foundrygtk-1": "^4.3.0",
+      "@girs/json-1.0": "^4.3.0",
+      "@girs/gtksource-5": "^4.3.0",
+      "@girs/foundry-1": "^4.3.0",
+      "@girs/dex-1": "^4.3.0",
+      "@girs/giounix-2.0": "^4.3.0",
+      "@girs/adw-1": "^4.3.0"    },
     "devDependencies": {
       "typescript": "*"
     },

package/tsconfig.json

@@ -78,6 +78,9 @@
       "@girs/dex-1": [
             "../dex-1/index.d.ts"
       ],
+      "@girs/giounix-2.0": [
+            "../giounix-2.0/index.d.ts"
+      ],
       "@girs/adw-1": [
             "../adw-1/index.d.ts"
       ],