@girs/clutterx11-4 4.0.0-4.0.0-beta.38

package/README.md

@@ -0,0 +1,85 @@
+
+# ClutterX11-4
+
+![version](https://img.shields.io/npm/v/@girs/clutterx11-4)
+![downloads/week](https://img.shields.io/npm/dw/@girs/clutterx11-4)
+
+
+GJS TypeScript type definitions for ClutterX11-4, generated from library version 4.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.38.
+
+## Install
+
+To use this type definitions, install them with NPM:
+```bash
+npm install @girs/clutterx11-4
+```
+
+## Usage
+
+You can import this package into your project like this:
+```ts
+import ClutterX11 from '@girs/clutterx11-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.
+For this you need to include `@girs/clutterx11-4` or `@girs/clutterx11-4/ambient` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/clutterx11-4'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/clutterx11-4"],
+  ...
+}
+```
+
+Now you can import the ambient module with TypeScript support: 
+
+```ts
+import ClutterX11 from 'gi://ClutterX11?version=4';
+```
+
+### Global import
+
+You can also import the module with Typescript support using the global `imports.gi` object of GJS.
+For this you need to include `@girs/clutterx11-4` or `@girs/clutterx11-4/import` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/clutterx11-4'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/clutterx11-4"],
+  ...
+}
+```
+
+Now you have also type support for this, too:
+
+```ts
+const ClutterX11 = imports.gi.ClutterX11;
+```
+
+### 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).
+
+## Other packages
+
+All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
+

package/clutterx11-4-ambient.d.ts

@@ -0,0 +1,9 @@
+declare module 'gi://ClutterX11?version=4' {
+    import ClutterX114 from '@girs/clutterx11-4';
+    export default ClutterX114;
+}
+
+declare module 'gi://ClutterX11' {
+    import ClutterX114 from 'gi://ClutterX11?version=4';
+    export default ClutterX114;
+}

package/clutterx11-4-ambient.js

@@ -0,0 +1,2 @@
+export {}
+

package/clutterx11-4-import.d.ts

@@ -0,0 +1 @@
+// Module import type definition not generated, otherwise this would cause a type conflict, this is because several GIR modules were generated with the same namespace: "ClutterX11"

package/clutterx11-4-import.js

@@ -0,0 +1,3 @@
+const gi = globalThis.imports?.gi || {};
+export default gi;
+

package/clutterx11-4.d.ts

@@ -0,0 +1,237 @@
+/**
+ * Type Definitions for Gjs (https://gjs.guide/)
+ *
+ * These type definitions are automatically generated, do not edit them by hand.
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
+ *
+ * The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
+ */
+
+import '@girs/gjs';
+
+// Module dependencies
+import type xlib from '@girs/xlib-2.0';
+import type CoglPango from '@girs/coglpango-4';
+import type PangoCairo from '@girs/pangocairo-1.0';
+import type cairo from 'cairo';
+import type GObject from '@girs/gobject-2.0';
+import type GLib from '@girs/glib-2.0';
+import type Pango from '@girs/pango-1.0';
+import type HarfBuzz from '@girs/harfbuzz-0.0';
+import type freetype2 from '@girs/freetype2-2.0';
+import type Gio from '@girs/gio-2.0';
+import type GModule from '@girs/gmodule-2.0';
+import type Cogl from '@girs/cogl-4';
+import type GL from '@girs/gl-1.0';
+import type Clutter from '@girs/clutter-4';
+import type Json from '@girs/json-1.0';
+import type Atk from '@girs/atk-1.0';
+
+export namespace ClutterX11 {
+    /**
+     * ClutterX11-4
+     */
+
+    /**
+     * Return values for the #ClutterX11FilterFunc function.
+     */
+
+    /**
+     * Return values for the #ClutterX11FilterFunc function.
+     */
+    export namespace FilterReturn {
+        export const $gtype: GObject.GType<FilterReturn>;
+    }
+
+    enum FilterReturn {
+        /**
+         * The event was not handled, continues the
+         *   processing
+         */
+        CONTINUE,
+        /**
+         * Native event translated into a Clutter
+         *   event, stops the processing
+         */
+        TRANSLATE,
+        /**
+         * Remove the event, stops the processing
+         */
+        REMOVE,
+    }
+    /**
+     * Disables the internal polling of X11 events in the main loop.
+     *
+     * Libraries or applications calling this function will be responsible of
+     * polling all X11 events.
+     *
+     * You also must call clutter_x11_handle_event() to let Clutter process
+     * events and maintain its internal state.
+     *
+     * This function can only be called before calling clutter_init().
+     *
+     * Even with event handling disabled, Clutter will still select
+     * all the events required to maintain its internal state on the stage
+     * Window; compositors using Clutter and input regions to pass events
+     * through to application windows should not rely on an empty input
+     * region, and should instead clear it themselves explicitly using the
+     * XFixes extension.
+     *
+     * This function should not be normally used by applications.
+     */
+    function disable_event_retrieval(): void;
+    /**
+     * Retrieves the group for the modifiers set in `event`
+     * @param event a #ClutterEvent of type %CLUTTER_KEY_PRESS or %CLUTTER_KEY_RELEASE
+     * @returns the group id
+     */
+    function event_get_key_group(event: Clutter.Event): number;
+    /**
+     * Retrieves the touch detail froma #ClutterEventSequence.
+     * @param sequence a #ClutterEventSequence
+     * @returns the touch detail
+     */
+    function event_sequence_get_touch_detail(sequence: Clutter.EventSequence): number;
+    /**
+     * Retrieves the pointer to the default display.
+     * @returns the default display
+     */
+    function get_default_display(): xlib.Display;
+    /**
+     * Gets the number of the default X Screen object.
+     * @returns the number of the default screen
+     */
+    function get_default_screen(): number;
+    /**
+     * Gets the stage for a particular X window.
+     * @param win an X Window ID
+     * @returns A #ClutterStage, or% NULL if a stage   does not exist for the window
+     */
+    function get_stage_from_window(win: xlib.Window): Clutter.Stage;
+    /**
+     * Retrieves whether the Clutter X11 backend is using ARGB visuals by default
+     * @returns %TRUE if ARGB visuals are queried by default
+     */
+    function get_use_argb_visual(): boolean;
+    /**
+     * Retrieves whether the Clutter X11 backend will create stereo
+     * stages if possible.
+     * @returns %TRUE if stereo stages are used if possible
+     */
+    function get_use_stereo_stage(): boolean;
+    /**
+     * This function processes a single X event; it can be used to hook
+     * into external X11 event processing (for example, a GDK filter
+     * function).
+     *
+     * If clutter_x11_disable_event_retrieval() has been called, you must
+     * let this function process events to update Clutter's internal state.
+     * @param xevent pointer to XEvent structure
+     * @returns #ClutterX11FilterReturn. %CLUTTER_X11_FILTER_REMOVE  indicates that Clutter has internally handled the event and the  caller should do no further processing. %CLUTTER_X11_FILTER_CONTINUE  indicates that Clutter is either not interested in the event,  or has used the event to update internal state without taking  any exclusive action. %CLUTTER_X11_FILTER_TRANSLATE will not  occur.
+     */
+    function handle_event(xevent: xlib.XEvent): FilterReturn;
+    /**
+     * Retrieves whether Clutter is running on an X11 server with the
+     * XComposite extension
+     * @returns %TRUE if the XComposite extension is available
+     */
+    function has_composite_extension(): boolean;
+    /**
+     * Queries the X11 backend to check if event collection has been disabled.
+     * @returns TRUE if event retrival has been disabled. FALSE otherwise.
+     */
+    function has_event_retrieval(): boolean;
+    /**
+     * Gets whether Clutter has XInput support.
+     * @returns %TRUE if Clutter was compiled with XInput support   and XInput support is available at run time.
+     */
+    function has_xinput(): boolean;
+    /**
+     * Sets the display connection Clutter should use; must be called
+     * before clutter_init(), clutter_init_with_args() or other functions
+     * pertaining Clutter's initialization process.
+     *
+     * If you are parsing the command line arguments by retrieving Clutter's
+     * #GOptionGroup with clutter_get_option_group() and calling
+     * g_option_context_parse() yourself, you should also call
+     * clutter_x11_set_display() before g_option_context_parse().
+     * @param xdpy pointer to a X display connection.
+     */
+    function set_display(xdpy: xlib.Display): void;
+    /**
+     * Target the #ClutterStage to use an existing external X Window
+     * @param stage a #ClutterStage
+     * @param xwindow an existing X Window id
+     * @returns %TRUE if foreign window is valid
+     */
+    function set_stage_foreign(stage: Clutter.Stage, xwindow: xlib.Window): boolean;
+    /**
+     * Sets whether the Clutter X11 backend should request ARGB visuals by default
+     * or not.
+     *
+     * By default, Clutter requests RGB visuals.
+     *
+     * If no ARGB visuals are found, the X11 backend will fall back to
+     * requesting a RGB visual instead.
+     *
+     * ARGB visuals are required for the #ClutterStage:use-alpha property to work.
+     *
+     * This function can only be called once, and before clutter_init() is
+     * called.
+     * @param use_argb %TRUE if ARGB visuals should be requested by default
+     */
+    function set_use_argb_visual(use_argb: boolean): void;
+    /**
+     * Sets whether the backend object for Clutter stages, will,
+     * if possible, be created with the ability to support stereo drawing
+     * (drawing separate images for the left and right eyes).
+     *
+     * This function must be called before clutter_init() is called.
+     * During paint callbacks, cogl_framebuffer_is_stereo() can be called
+     * on the framebuffer retrieved by cogl_get_draw_framebuffer() to
+     * determine if stereo support was successfully enabled, and
+     * cogl_framebuffer_set_stereo_mode() to determine which buffers
+     * will be drawn to.
+     *
+     * Note that this function *does not* cause the stage to be drawn
+     * multiple times with different perspective transformations and thus
+     * appear in 3D, it simply enables individual ClutterActors to paint
+     * different images for the left and and right eye.
+     * @param use_stereo %TRUE if the stereo stages should be used if possible.
+     */
+    function set_use_stereo_stage(use_stereo: boolean): void;
+    /**
+     * Traps every X error until clutter_x11_untrap_x_errors() is called.
+     */
+    function trap_x_errors(): void;
+    /**
+     * Removes the X error trap and returns the current status.
+     * @returns the trapped error code, or 0 for success
+     */
+    function untrap_x_errors(): number;
+    interface FilterFunc {
+        (xev: xlib.XEvent, cev: Clutter.Event): FilterReturn;
+    }
+    abstract class XInputDevice {
+        static $gtype: GObject.GType<XInputDevice>;
+
+        // Constructors
+
+        _init(...args: any[]): void;
+    }
+
+    /**
+     * Name of the imported GIR library
+     * `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
+     */
+    const __name__: string;
+    /**
+     * Version of the imported GIR library
+     * `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
+     */
+    const __version__: string;
+}
+
+export default ClutterX11;
+
+// END

package/clutterx11-4.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import ClutterX11 from 'gi://ClutterX11?version=4';
+export default ClutterX11;
+

package/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Type Definitions for Gjs (https://gjs.guide/)
+ *
+ * These type definitions are automatically generated, do not edit them by hand.
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
+ *
+ * This template is used to generate the index.d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
+ */
+
+import './clutterx11-4-ambient.d.ts';
+
+import ClutterX11 from './clutterx11-4.js';
+export default ClutterX11;

package/index.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import ClutterX11 from './clutterx11-4.js';
+export default ClutterX11;
+

package/package.json

@@ -0,0 +1,67 @@
+{
+    "name": "@girs/clutterx11-4",
+    "version": "4.0.0-4.0.0-beta.38",
+    "description": "GJS TypeScript type definitions for ClutterX11-4, generated from library version 4.0.0",
+    "type": "module",
+    "module": "clutterx11-4.js",
+    "main": "clutterx11-4.js",
+    "exports": {
+      "./ambient": {
+        "types": "./clutterx11-4-ambient.d.ts",
+        "import": "./clutterx11-4-ambient.js",
+        "default": "./clutterx11-4-ambient.js"
+      },
+      "./import": {
+        "types": "./clutterx11-4-import.d.ts",
+        "import": "./clutterx11-4-import.js",
+        "default": "./clutterx11-4-import.js"
+      },
+      "./clutterx11-4": {
+        "types": "./clutterx11-4.d.ts",
+        "import": "./clutterx11-4.js",
+        "default": "./clutterx11-4.js"
+      },
+      ".": {
+        "types": "./index.d.ts",
+        "import": "./index.js",
+        "default": "./index.js"
+      }
+    },
+    "scripts": {
+      "test": "tsc --project tsconfig.json"
+    },
+    "dependencies": {
+      "@girs/gjs": "4.0.0-beta.38",
+      "@girs/xlib-2.0": "2.0.0-4.0.0-beta.38",
+      "@girs/coglpango-4": "4.0.0-4.0.0-beta.38",
+      "@girs/pangocairo-1.0": "1.0.0-4.0.0-beta.38",
+      "@girs/cairo-1.0": "1.0.0-4.0.0-beta.38",
+      "@girs/gobject-2.0": "2.86.0-4.0.0-beta.38",
+      "@girs/glib-2.0": "2.86.0-4.0.0-beta.38",
+      "@girs/pango-1.0": "1.57.0-4.0.0-beta.38",
+      "@girs/harfbuzz-0.0": "11.5.0-4.0.0-beta.38",
+      "@girs/freetype2-2.0": "2.0.0-4.0.0-beta.38",
+      "@girs/gio-2.0": "2.86.0-4.0.0-beta.38",
+      "@girs/gmodule-2.0": "2.0.0-4.0.0-beta.38",
+      "@girs/cogl-4": "4.0.0-4.0.0-beta.38",
+      "@girs/gl-1.0": "1.0.0-4.0.0-beta.38",
+      "@girs/clutter-4": "4.0.0-4.0.0-beta.38",
+      "@girs/json-1.0": "1.10.8-4.0.0-beta.38",
+      "@girs/atk-1.0": "2.58.0-4.0.0-beta.38"    },
+    "devDependencies": {
+      "typescript": "*"
+    },
+    "keywords": ["Gir", "TypeScript", "types", "GObject-Introspection", "GJS", "ClutterX11-4"],
+    "author": "ts-for-gir",
+    "license": "MIT",
+    "repository": {
+      "type": "git",
+      "url": "git+https://github.com/gjsify/types.git"
+    },
+    "bugs": {
+      "url": "https://github.com/gjsify/ts-for-gir/issues"
+    },
+    "homepage": "https://github.com/gjsify/types/tree/main/clutterx11-4#readme"
+}
+
+

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    // General settings for code interpretation
+    "target": "ESNext",
+    "module": "NodeNext",
+    "lib": ["ESNext"],
+    "types": [],
+    "experimentalDecorators": true,
+    "moduleResolution": "NodeNext",
+    "noEmit": true,
+    "noEmitOnError": false,
+    "baseUrl": "./",
+    "rootDir": ".",
+    // General settings for code generation
+    "removeComments": false,
+    "inlineSourceMap": false,
+    "inlineSources": false,
+    "newLine": "LF",
+    // Show diagnostics
+    "diagnostics": true
+  },
+  "include": ["./clutterx11-4.d.ts"]
+}
+
+

package/typedoc.json

@@ -0,0 +1,7 @@
+{
+    "entryPoints": ["./clutterx11-4.d.ts"],
+    "readme": "./README.md",
+    "name": "ClutterX11-4",
+    "tsconfig": "./tsconfig.json"
+}
+