@girs/gtklayershell-0.1 0.1.0-4.0.0-beta.3

package/README.md

@@ -0,0 +1,86 @@
+
+# GtkLayerShell-0.1
+
+![version](https://img.shields.io/npm/v/@girs/gtklayershell-0.1)
+![downloads/week](https://img.shields.io/npm/dw/@girs/gtklayershell-0.1)
+
+
+GJS TypeScript type definitions for GtkLayerShell-0.1, generated from library version 0.1.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.3.
+
+
+## Install
+
+To use this type definitions, install them with NPM:
+```bash
+npm install @girs/gtklayershell-0.1
+```
+
+## Usage
+
+You can import this package into your project like this:
+```ts
+import GtkLayerShell from '@girs/gtklayershell-0.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.
+For this you need to include `@girs/gtklayershell-0.1` or `@girs/gtklayershell-0.1/ambient` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/gtklayershell-0.1'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/gtklayershell-0.1"],
+  ...
+}
+```
+
+Now you can import the ambient module with TypeScript support: 
+
+```ts
+import GtkLayerShell from 'gi://GtkLayerShell?version=0.1';
+```
+
+### 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/gtklayershell-0.1` or `@girs/gtklayershell-0.1/import` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/gtklayershell-0.1'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/gtklayershell-0.1"],
+  ...
+}
+```
+
+Now you have also type support for this, too:
+
+```ts
+const GtkLayerShell = imports.gi.GtkLayerShell;
+```
+
+### 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/gtklayershell-0.1-ambient.d.ts

@@ -0,0 +1,12 @@
+
+declare module 'gi://GtkLayerShell?version=0.1' {
+    import GtkLayerShell from '@girs/gtklayershell-0.1';
+    export default GtkLayerShell;
+}
+
+declare module 'gi://GtkLayerShell' {
+    import GtkLayerShell01 from 'gi://GtkLayerShell?version=0.1';
+    export default GtkLayerShell01;
+}
+
+

package/gtklayershell-0.1-ambient.js

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

package/gtklayershell-0.1-import.d.ts

@@ -0,0 +1,12 @@
+
+import GtkLayerShell01 from '@girs/gtklayershell-0.1';
+
+declare global {
+    export interface GjsGiImports {
+        GtkLayerShell: typeof GtkLayerShell01;
+    }
+}
+
+export default GjsGiImports;
+
+

package/gtklayershell-0.1-import.js

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

package/gtklayershell-0.1.d.ts

@@ -0,0 +1,241 @@
+/*
+ * 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
+ */
+
+import './gtklayershell-0.1-ambient.d.ts';
+
+/**
+ * GtkLayerShell-0.1
+ */
+
+import type Gtk from '@girs/gtk-3.0';
+import type xlib from '@girs/xlib-2.0';
+import type Gdk from '@girs/gdk-3.0';
+import type cairo from '@girs/cairo-1.0';
+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 GdkPixbuf from '@girs/gdkpixbuf-2.0';
+import type GModule from '@girs/gmodule-2.0';
+import type Atk from '@girs/atk-1.0';
+
+export namespace GtkLayerShell {
+    enum Edge {
+        /**
+         * The left edge of the screen.
+         */
+        LEFT,
+        /**
+         * The right edge of the screen.
+         */
+        RIGHT,
+        /**
+         * The top edge of the screen.
+         */
+        TOP,
+        /**
+         * The bottom edge of the screen.
+         */
+        BOTTOM,
+        /**
+         * Should not be used except to get the number of entries. (NOTE: may change in
+         * future releases as more entries are added)
+         */
+        ENTRY_NUMBER,
+    }
+    enum KeyboardMode {
+        /**
+         * This window should not receive keyboard events.
+         */
+        NONE,
+        /**
+         * This window should have exclusive focus if it is on the top or overlay layer.
+         */
+        EXCLUSIVE,
+        /**
+         * The user should be able to focus and unfocues this window in an implementation
+         * defined way. Not supported for protocol version < 4.
+         */
+        ON_DEMAND,
+        /**
+         * Should not be used except to get the number of entries. (NOTE: may change in
+         * future releases as more entries are added)
+         */
+        ENTRY_NUMBER,
+    }
+    enum Layer {
+        /**
+         * The background layer.
+         */
+        BACKGROUND,
+        /**
+         * The bottom layer.
+         */
+        BOTTOM,
+        /**
+         * The top layer.
+         */
+        TOP,
+        /**
+         * The overlay layer.
+         */
+        OVERLAY,
+        /**
+         * Should not be used except to get the number of entries. (NOTE: may change in
+         * future releases as more entries are added)
+         */
+        ENTRY_NUMBER,
+    }
+    /**
+     * When auto exclusive zone is enabled, exclusive zone is automatically set to the
+     * size of the `window` + relevant margin. To disable auto exclusive zone, just set the
+     * exclusive zone to 0 or any other fixed value.
+     *
+     * NOTE: you can control the auto exclusive zone by changing the margin on the non-anchored
+     * edge. This behavior is specific to gtk-layer-shell and not part of the underlying protocol
+     * @param window A layer surface.
+     */
+    function auto_exclusive_zone_enable(window: Gtk.Window): void;
+    function auto_exclusive_zone_is_enabled(window: Gtk.Window): boolean;
+    function get_anchor(window: Gtk.Window, edge: Edge): boolean;
+    function get_exclusive_zone(window: Gtk.Window): number;
+    function get_keyboard_interactivity(window: Gtk.Window): boolean;
+    function get_keyboard_mode(window: Gtk.Window): KeyboardMode;
+    function get_layer(window: Gtk.Window): Layer;
+    function get_major_version(): number;
+    function get_margin(window: Gtk.Window, edge: Edge): number;
+    function get_micro_version(): number;
+    function get_minor_version(): number;
+    /**
+     * NOTE: To get which monitor the surface is actually on, use
+     * gdk_display_get_monitor_at_window().
+     * @param window A layer surface.
+     * @returns the monitor this surface will/has requested to be on, can be %NULL.
+     */
+    function get_monitor(window: Gtk.Window): Gdk.Monitor;
+    /**
+     * NOTE: this function does not return ownership of the string. Do not free the returned string.
+     * Future calls into the library may invalidate the returned string.
+     * @param window A layer surface.
+     * @returns a reference to the namespace property. If namespace is unset, returns the default namespace ("gtk-layer-shell"). Never returns %NULL.
+     */
+    function get_namespace(window: Gtk.Window): string;
+    /**
+     * May block for a Wayland roundtrip the first time it's called.
+     * @returns version of the zwlr_layer_shell_v1 protocol supported by the compositor or 0 if the protocol is not supported.
+     */
+    function get_protocol_version(): number;
+    function get_zwlr_layer_surface_v1(window: Gtk.Window): any | null;
+    /**
+     * Set the `window` up to be a layer surface once it is mapped. this must be called before
+     * the `window` is realized.
+     * @param window A #GtkWindow to be turned into a layer surface.
+     */
+    function init_for_window(window: Gtk.Window): void;
+    function is_layer_window(window: Gtk.Window): boolean;
+    /**
+     * May block for a Wayland roundtrip the first time it's called.
+     * @returns %TRUE if the platform is Wayland and Wayland compositor supports the zwlr_layer_shell_v1 protocol.
+     */
+    function is_supported(): boolean;
+    /**
+     * Set whether `window` should be anchored to `edge`.
+     * - If two perpendicular edges are anchored, the surface with be anchored to that corner
+     * - If two opposite edges are anchored, the window will be stretched across the screen in that direction
+     *
+     * Default is %FALSE for each #GtkLayerShellEdge
+     * @param window A layer surface.
+     * @param edge A #GtkLayerShellEdge this layer surface may be anchored to.
+     * @param anchor_to_edge Whether or not to anchor this layer surface to @edge.
+     */
+    function set_anchor(window: Gtk.Window, edge: Edge, anchor_to_edge: boolean): void;
+    /**
+     * Has no effect unless the surface is anchored to an edge. Requests that the compositor
+     * does not place other surfaces within the given exclusive zone of the anchored edge.
+     * For example, a panel can request to not be covered by maximized windows. See
+     * wlr-layer-shell-unstable-v1.xml for details.
+     *
+     * Default is 0
+     * @param window A layer surface.
+     * @param exclusive_zone The size of the exclusive zone.
+     */
+    function set_exclusive_zone(window: Gtk.Window, exclusive_zone: number): void;
+    /**
+     * Whether the `window` should receive keyboard events from the compositor.
+     *
+     * Default is %FALSE
+     * @param window A layer surface.
+     * @param interactivity Whether the layer surface should receive keyboard events.
+     */
+    function set_keyboard_interactivity(window: Gtk.Window, interactivity: boolean): void;
+    /**
+     * Sets if/when `window` should receive keyboard events from the compositor, see
+     * GtkLayerShellKeyboardMode for details.
+     *
+     * Default is %GTK_LAYER_SHELL_KEYBOARD_MODE_NONE
+     * @param window A layer surface.
+     * @param mode The type of keyboard interactivity requested.
+     */
+    function set_keyboard_mode(window: Gtk.Window, mode: KeyboardMode): void;
+    /**
+     * Set the "layer" on which the surface appears (controls if it is over top of or below other surfaces). The layer may
+     * be changed on-the-fly in the current version of the layer shell protocol, but on compositors that only support an
+     * older version the `window` is remapped so the change can take effect.
+     *
+     * Default is %GTK_LAYER_SHELL_LAYER_TOP
+     * @param window A layer surface.
+     * @param layer The layer on which this surface appears.
+     */
+    function set_layer(window: Gtk.Window, layer: Layer): void;
+    /**
+     * Set the margin for a specific `edge` of a `window`. Effects both surface's distance from
+     * the edge and its exclusive zone size (if auto exclusive zone enabled).
+     *
+     * Default is 0 for each #GtkLayerShellEdge
+     * @param window A layer surface.
+     * @param edge The #GtkLayerShellEdge for which to set the margin.
+     * @param margin_size The margin for @edge to be set.
+     */
+    function set_margin(window: Gtk.Window, edge: Edge, margin_size: number): void;
+    /**
+     * Set the output for the window to be placed on, or %NULL to let the compositor choose.
+     * If the window is currently mapped, it will get remapped so the change can take effect.
+     *
+     * Default is %NULL
+     * @param window A layer surface.
+     * @param monitor The output this layer surface will be placed on (%NULL to let the compositor decide).
+     */
+    function set_monitor(window: Gtk.Window, monitor: Gdk.Monitor): void;
+    /**
+     * Set the "namespace" of the surface.
+     *
+     * No one is quite sure what this is for, but it probably should be something generic
+     * ("panel", "osk", etc). The `name_space` string is copied, and caller maintains
+     * ownership of original. If the window is currently mapped, it will get remapped so
+     * the change can take effect.
+     *
+     * Default is "gtk-layer-shell" (which will be used if set to %NULL)
+     * @param window A layer surface.
+     * @param name_space The namespace of this layer surface.
+     */
+    function set_namespace(window: Gtk.Window, name_space: string): 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 GtkLayerShell;
+// END

package/gtklayershell-0.1.js

@@ -0,0 +1,6 @@
+
+  // @ts-expect-error
+  import GtkLayerShell from 'gi://GtkLayerShell?version=0.1';
+  export { GtkLayerShell };
+  export default GtkLayerShell;
+

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@girs/gtklayershell-0.1",
+  "version": "0.1.0-4.0.0-beta.3",
+  "description": "GJS TypeScript type definitions for GtkLayerShell-0.1, generated from library version 0.1.0",
+  "type": "module",
+  "module": "gtklayershell-0.1.js",
+  "main": "gtklayershell-0.1.js",
+  "exports": {
+    "./ambient": {
+      "types": "./gtklayershell-0.1-ambient.d.ts",
+      "import": "./gtklayershell-0.1-ambient.js",
+      "default": "./gtklayershell-0.1-ambient.js"
+    },
+    "./import": {
+      "types": "./gtklayershell-0.1-import.d.ts",
+      "import": "./gtklayershell-0.1-import.js",
+      "default": "./gtklayershell-0.1-import.js"
+    },
+    ".": {
+      "types": "./gtklayershell-0.1.d.ts",
+      "import": "./gtklayershell-0.1.js",
+      "default": "./gtklayershell-0.1.js"
+    }
+  },
+  "scripts": {
+    "test": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit gtklayershell-0.1.d.ts"
+  },
+  "dependencies": {
+    "@girs/atk-1.0": "^2.52.0-4.0.0-beta.3",
+    "@girs/cairo-1.0": "^1.0.0-4.0.0-beta.3",
+    "@girs/freetype2-2.0": "^2.0.0-4.0.0-beta.3",
+    "@girs/gdk-3.0": "^3.24.41-4.0.0-beta.3",
+    "@girs/gdkpixbuf-2.0": "^2.0.0-4.0.0-beta.3",
+    "@girs/gio-2.0": "^2.80.0-4.0.0-beta.3",
+    "@girs/gjs": "^4.0.0-beta.3",
+    "@girs/glib-2.0": "^2.80.0-4.0.0-beta.3",
+    "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.3",
+    "@girs/gobject-2.0": "^2.80.0-4.0.0-beta.3",
+    "@girs/gtk-3.0": "^3.24.41-4.0.0-beta.3",
+    "@girs/harfbuzz-0.0": "^8.3.1-4.0.0-beta.3",
+    "@girs/pango-1.0": "^1.51.0-4.0.0-beta.3",
+    "@girs/xlib-2.0": "^2.0.0-4.0.0-beta.3"
+  },
+  "devDependencies": {
+    "typescript": "*"
+  },
+  "keywords": [
+    "Gir",
+    "TypeScript",
+    "types",
+    "GObject-Introspection",
+    "GJS",
+    "GtkLayerShell-0.1"
+  ],
+  "author": "ts-for-gir",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gjsify/ts-for-gir.git"
+  },
+  "bugs": {
+    "url": "https://github.com/gjsify/ts-for-gir/issues"
+  },
+  "homepage": "https://github.com/gjsify/types/tree/main/gtklayershell-0.1#readme"
+}

package/tsconfig.json

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

package/typedoc.json

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