@girs/gcrgtk4-4 4.2.0 → 4.4.0

package/README.md

@@ -5,25 +5,25 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/gcrgtk4-4)
 
 
-GJS TypeScript type definitions for GcrGtk4-4 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
+GJS TypeScript type definitions for GcrGtk4-4 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.0.
 
 ## Install
 
-To use this type definitions, install them with NPM:
+Install the type definitions with npm:
 ```bash
 npm install @girs/gcrgtk4-4
 ```
 
 ## Usage
 
-You can import this package into your project like this:
+Import it like any other module:
 ```ts
 import GcrGtk4 from '@girs/gcrgtk4-4';
 ```
 
 ### 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/gcrgtk4-4` or `@girs/gcrgtk4-4/ambient` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/gcrgtk4-4'
 }
 ```
 
-Now you can import the ambient module with TypeScript support: 
+The ambient module now resolves with types:
 
 ```ts
 import GcrGtk4 from 'gi://GcrGtk4?version=4';
@@ -50,7 +50,7 @@ import GcrGtk4 from 'gi://GcrGtk4?version=4';
 
 ### 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/gcrgtk4-4` or `@girs/gcrgtk4-4/import` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/gcrgtk4-4'
 }
 ```
 
-Now you have also type support for this, too:
+That form carries types as well:
 
 ```ts
 const GcrGtk4 = imports.gi.GcrGtk4;
@@ -77,7 +77,7 @@ const GcrGtk4 = imports.gi.GcrGtk4;
 
 ### 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/gcrgtk4-4-surface.d.ts

@@ -84,6 +84,23 @@ export interface Widgets {
 /** Every GType this namespace can create. A consumer derives its own tag map. */
 export type WidgetGType = keyof Widgets;
 
+// ---------------------------------------------------------------------------
+// Child holders — the same shape, for objects that CARRY a widget without being one.
+//
+// `GtkListItem`, `GtkListHeader`, `GtkColumnViewCell` and `AdwToggle` descend from
+// `GObject.Object` and hold a widget through `set_child`/`get_child`. A renderer places
+// them exactly like a container, so they belong in the vocabulary; a check asking "is
+// this a widget" must still be able to say no. Hence a sibling table rather than four
+// more rows in `Widgets`: concatenate them when you mean both.
+// ---------------------------------------------------------------------------
+
+export interface ChildHolders {
+
+}
+
+/** Every GType this namespace holds a child in without it being a widget. */
+export type ChildHolderGType = keyof ChildHolders;
+
 /** The writable, optional, GObject-keyed property surface of one GType. */
 export type PropsOf<G extends WidgetGType> = Widgets[G]['props'];
 
@@ -119,6 +136,9 @@ export const OWN_SIGNALS: Readonly<Record<string, readonly string[]>>;
 /** Widget GType -> every declaration its members come from, self first. */
 export const DECLS: Readonly<Record<string, readonly string[]>>;
 
+/** The GTypes in `DECLS` that hold a widget without being one — see `ChildHolders`. */
+export const CHILD_HOLDERS: readonly string[];
+
 /** Enum GType -> the nicks this surface offers. */
 export const ENUM_NICKS: Readonly<Record<string, readonly string[]>>;
 

package/gcrgtk4-4-surface.js

@@ -18,6 +18,12 @@ export const DECLS = {
     GcrCertificateWidget: ['GcrCertificateWidget', 'GtkWidget', 'GtkAccessible', 'GtkBuildable', 'GtkConstraintTarget'],
 };
 
+// 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.
+export const CHILD_HOLDERS = [];
+
 export const ENUM_NICKS = {};
 
 export const SLOT_CANDIDATES = {};

package/gcrgtk4-4.d.ts

@@ -167,6 +167,7 @@ export namespace GcrGtk4 {
          * does not interrupts the user's current screen reader output.
          * @param message the string to announce
          * @param priority the priority of the announcement
+         * @since 4.14
          */
         announce(message: string, priority: Gtk.AccessibleAnnouncementPriority): void;
 
@@ -179,6 +180,7 @@ export namespace GcrGtk4 {
          * It is left to the accessible implementation to define the scope
          * and uniqueness of the identifier.
          * @returns the accessible identifier
+         * @since 4.22
          */
         get_accessible_id(): string | null;
 
@@ -187,6 +189,7 @@ export namespace GcrGtk4 {
          * 
          * This function returns `NULL` for top level widgets.
          * @returns the accessible parent
+         * @since 4.10
          */
         get_accessible_parent(): Gtk.Accessible | null;
 
@@ -199,6 +202,7 @@ export namespace GcrGtk4 {
         /**
          * Retrieves the implementation for the given accessible object.
          * @returns the accessible implementation object
+         * @since 4.10
          */
         get_at_context(): Gtk.ATContext;
 
@@ -209,18 +213,21 @@ export namespace GcrGtk4 {
          * implementations, e.g. to get the bounds from an ignored
          * child widget.
          * @returns true if the bounds are valid, and false otherwise
+         * @since 4.10
          */
         get_bounds(): [boolean, number, number, number, number];
 
         /**
          * Retrieves the first accessible child of an accessible object.
          * @returns the first accessible child
+         * @since 4.10
          */
         get_first_accessible_child(): Gtk.Accessible | null;
 
         /**
          * Retrieves the next accessible sibling of an accessible object
          * @returns the next accessible sibling
+         * @since 4.10
          */
         get_next_accessible_sibling(): Gtk.Accessible | null;
 
@@ -232,6 +239,7 @@ export namespace GcrGtk4 {
          * child widget, as is the case for {@link Gtk.Text} wrappers.
          * @param state platform state to query
          * @returns the value of state for the accessible
+         * @since 4.10
          */
         get_platform_state(state: Gtk.AccessiblePlatformState): boolean;
 
@@ -265,6 +273,7 @@ export namespace GcrGtk4 {
          * object is the container widget.
          * @param parent the parent accessible object
          * @param next_sibling the sibling accessible object
+         * @since 4.10
          */
         set_accessible_parent(parent: Gtk.Accessible | null, next_sibling: Gtk.Accessible | null): void;
 
@@ -274,6 +283,7 @@ export namespace GcrGtk4 {
          * That might be useful when a new child of a custom accessible
          * is created, and it needs to be linked to a previous child.
          * @param new_sibling the new next accessible sibling to set
+         * @since 4.10
          */
         update_next_accessible_sibling(new_sibling: Gtk.Accessible | null): void;
 
@@ -284,6 +294,7 @@ export namespace GcrGtk4 {
          * have a platform state but are not widgets. Widgets handle platform
          * states automatically.
          * @param state the platform state to update
+         * @since 4.18
          */
         update_platform_state(state: Gtk.AccessiblePlatformState): void;
 
@@ -331,6 +342,7 @@ export namespace GcrGtk4 {
          * 
          * It is left to the accessible implementation to define the scope
          * and uniqueness of the identifier.
+         * @since 4.22
          * @virtual
          */
         vfunc_get_accessible_id(): string | null;
@@ -339,12 +351,14 @@ export namespace GcrGtk4 {
          * Retrieves the accessible parent for an accessible object.
          * 
          * This function returns `NULL` for top level widgets.
+         * @since 4.10
          * @virtual
          */
         vfunc_get_accessible_parent(): Gtk.Accessible | null;
 
         /**
          * Retrieves the implementation for the given accessible object.
+         * @since 4.10
          * @virtual
          */
         vfunc_get_at_context(): Gtk.ATContext | null;
@@ -355,18 +369,21 @@ export namespace GcrGtk4 {
          * This functionality can be overridden by {@link Gtk.Accessible}
          * implementations, e.g. to get the bounds from an ignored
          * child widget.
+         * @since 4.10
          * @virtual
          */
         vfunc_get_bounds(): [boolean, number, number, number, number];
 
         /**
          * Retrieves the first accessible child of an accessible object.
+         * @since 4.10
          * @virtual
          */
         vfunc_get_first_accessible_child(): Gtk.Accessible | null;
 
         /**
          * Retrieves the next accessible sibling of an accessible object
+         * @since 4.10
          * @virtual
          */
         vfunc_get_next_accessible_sibling(): Gtk.Accessible | null;
@@ -378,6 +395,7 @@ export namespace GcrGtk4 {
          * implementations, e.g. to get platform state from an ignored
          * child widget, as is the case for {@link Gtk.Text} wrappers.
          * @param state platform state to query
+         * @since 4.10
          * @virtual
          */
         vfunc_get_platform_state(state: Gtk.AccessiblePlatformState): boolean;
@@ -473,7 +491,7 @@ export namespace GcrGtk4 {
         /**
          * 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/gcrgtk4-4",
-    "version": "4.2.0",
+    "version": "4.4.0",
     "description": "GJS TypeScript type definitions for GcrGtk4-4",
     "type": "module",
     "module": "gcrgtk4-4.js",
@@ -36,23 +36,23 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^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/gobject-2.0": "^4.2.0",
-      "@girs/glib-2.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/gio-2.0": "^4.2.0",
-      "@girs/gmodule-2.0": "^4.2.0",
-      "@girs/gdkpixbuf-2.0": "^4.2.0",
-      "@girs/gcr-4": "^4.2.0",
-      "@girs/gck-2": "^4.2.0"    },
+      "@girs/gjs": "^4.4.0",
+      "@girs/gtk-4.0": "^4.4.0",
+      "@girs/gsk-4.0": "^4.4.0",
+      "@girs/graphene-1.0": "^4.4.0",
+      "@girs/gobject-2.0": "^4.4.0",
+      "@girs/glib-2.0": "^4.4.0",
+      "@girs/gdk-4.0": "^4.4.0",
+      "@girs/cairo-1.0": "^4.4.0",
+      "@girs/pangocairo-1.0": "^4.4.0",
+      "@girs/pango-1.0": "^4.4.0",
+      "@girs/harfbuzz-0.0": "^4.4.0",
+      "@girs/freetype2-2.0": "^4.4.0",
+      "@girs/gio-2.0": "^4.4.0",
+      "@girs/gmodule-2.0": "^4.4.0",
+      "@girs/gdkpixbuf-2.0": "^4.4.0",
+      "@girs/gcr-4": "^4.4.0",
+      "@girs/gck-2": "^4.4.0"    },
     "devDependencies": {
       "typescript": "*"
     },