@girs/clutter-16 4.2.0 → 4.4.0

package/README.md

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

@@ -12706,6 +12706,7 @@ export namespace Clutter {
          * This function does not realize child actors, except in the special
          * case that realizing the stage, when the stage is visible, will
          * suddenly map (and thus realize) the children of the stage.
+         * @deprecated since 1.16: Actors are automatically realized, and nothing   requires explicit realization.
          * @virtual
          */
         vfunc_realize(): void;
@@ -12788,6 +12789,7 @@ export namespace Clutter {
          * If you were using `clutter_actor_unrealize()` to implement
          * unrealizing children of your container, then don't, ClutterActor
          * will already take care of that.
+         * @deprecated since 1.16: Actors are automatically unrealized, and nothing   requires explicit realization.
          * @virtual
          */
         vfunc_unrealize(): void;
@@ -14364,6 +14366,7 @@ export namespace Clutter {
          * This function does not realize child actors, except in the special
          * case that realizing the stage, when the stage is visible, will
          * suddenly map (and thus realize) the children of the stage.
+         * @deprecated since 1.16: Actors are automatically realized, and nothing   requires explicit realization.
          */
         realize(): void;
 
@@ -15173,6 +15176,7 @@ export namespace Clutter {
          * If you were using `clutter_actor_unrealize()` to implement
          * unrealizing children of your container, then don't, ClutterActor
          * will already take care of that.
+         * @deprecated since 1.16: Actors are automatically unrealized, and nothing   requires explicit realization.
          */
         unrealize(): void;
 
@@ -15350,6 +15354,7 @@ export namespace Clutter {
          * `component`, on a scale from 0 (fully transparent) to 1.0
          * (fully opaque).
          * @returns An alpha value from 0 to 1.0, inclusive.
+         * @since 1.12
          */
         get_alpha(): number;
 
@@ -15382,6 +15387,7 @@ export namespace Clutter {
          * If the position can not be obtained (e.g. a non-embedded plug or missing
          * support), x and y are set to -1.
          * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
+         * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
          */
         get_position(coord_type: Atk.CoordType): [number, number];
 
@@ -15390,6 +15396,7 @@ export namespace Clutter {
          * 
          * If the size can not be obtained (e.g. a non-embedded plug or missing
          * support), width and height are set to -1.
+         * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
          */
         get_size(): [number, number];
 
@@ -15414,6 +15421,7 @@ export namespace Clutter {
          * functions to be executed when this object receives focus events
          * (in or out).
          * @param handler_id the handler id of the focus handler to be removed from `component`
+         * @deprecated since 2.9.4: If you need to track when an object gains or lose the focus, use the {@link Atk.Object.SignalSignatures.state_change | Atk.Object::state-change} "focused" notification instead.
          */
         remove_focus_handler(handler_id: number): void;
 
@@ -15425,6 +15433,7 @@ export namespace Clutter {
          * object shows up on the screen, given its current position within the parents.
          * @param type specify where the object should be made visible.
          * @returns whether scrolling was successful.
+         * @since 2.30
          */
         scroll_to(type: Atk.ScrollType): boolean;
 
@@ -15435,6 +15444,7 @@ export namespace Clutter {
          * @param x x-position where to scroll to
          * @param y y-position where to scroll to
          * @returns whether scrolling was successful.
+         * @since 2.30
          */
         scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
 
@@ -15492,6 +15502,7 @@ export namespace Clutter {
          * Returns the alpha value (i.e. the opacity) for this
          * `component`, on a scale from 0 (fully transparent) to 1.0
          * (fully opaque).
+         * @since 1.12
          * @virtual
          */
         vfunc_get_alpha(): number;
@@ -15526,6 +15537,7 @@ export namespace Clutter {
          * If the position can not be obtained (e.g. a non-embedded plug or missing
          * support), x and y are set to -1.
          * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
+         * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
          * @virtual
          */
         vfunc_get_position(coord_type: Atk.CoordType): [number, number];
@@ -15535,6 +15547,7 @@ export namespace Clutter {
          * 
          * If the size can not be obtained (e.g. a non-embedded plug or missing
          * support), width and height are set to -1.
+         * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
          * @virtual
          */
         vfunc_get_size(): [number, number];
@@ -15560,6 +15573,7 @@ export namespace Clutter {
          * functions to be executed when this object receives focus events
          * (in or out).
          * @param handler_id the handler id of the focus handler to be removed from `component`
+         * @deprecated since 2.9.4: If you need to track when an object gains or lose the focus, use the {@link Atk.Object.SignalSignatures.state_change | Atk.Object::state-change} "focused" notification instead.
          * @virtual
          */
         vfunc_remove_focus_handler(handler_id: number): void;
@@ -15571,6 +15585,7 @@ export namespace Clutter {
          * `component` in its parent, this only makes the parents scroll so that the
          * object shows up on the screen, given its current position within the parents.
          * @param type specify where the object should be made visible.
+         * @since 2.30
          * @virtual
          */
         vfunc_scroll_to(type: Atk.ScrollType): boolean;
@@ -15581,6 +15596,7 @@ export namespace Clutter {
          * @param coords specify whether coordinates are relative to the screen or to the parent object.
          * @param x x-position where to scroll to
          * @param y y-position where to scroll to
+         * @since 2.30
          * @virtual
          */
         vfunc_scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
@@ -23268,6 +23284,7 @@ export namespace Clutter {
         // Static methods
         /**
          * Retrieves the singleton instance of {@link Clutter.Settings}
+         * @deprecated Use {@link Clutter.Context.get_settings} instead
          */
         static get_default(): Settings;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/clutter-16",
-    "version": "4.2.0",
+    "version": "4.4.0",
     "description": "GJS TypeScript type definitions for Clutter-16",
     "type": "module",
     "module": "clutter-16.js",
@@ -31,21 +31,21 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.2.0",
-      "@girs/pango-1.0": "^4.2.0",
-      "@girs/cairo-1.0": "^4.2.0",
-      "@girs/gobject-2.0": "^4.2.0",
-      "@girs/glib-2.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/mtk-16": "^4.2.0",
-      "@girs/graphene-1.0": "^4.2.0",
-      "@girs/gl-1.0": "^4.2.0",
-      "@girs/cogl-16": "^4.2.0",
-      "@girs/xlib-2.0": "^4.2.0",
-      "@girs/atk-1.0": "^4.2.0"    },
+      "@girs/gjs": "^4.4.0",
+      "@girs/pango-1.0": "^4.4.0",
+      "@girs/cairo-1.0": "^4.4.0",
+      "@girs/gobject-2.0": "^4.4.0",
+      "@girs/glib-2.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/mtk-16": "^4.4.0",
+      "@girs/graphene-1.0": "^4.4.0",
+      "@girs/gl-1.0": "^4.4.0",
+      "@girs/cogl-16": "^4.4.0",
+      "@girs/xlib-2.0": "^4.4.0",
+      "@girs/atk-1.0": "^4.4.0"    },
     "devDependencies": {
       "typescript": "*"
     },