@gtkx/ffi 0.10.4 → 0.11.0

package/dist/generated/gtk/imcontext.js

@@ -1,524 +0,0 @@
-import { call } from "../../batch.js";
-import { getNativeObject } from "../../native/object.js";
-import { registerNativeClass } from "../../registry.js";
-import * as GObject from "../gobject/index.js";
-import * as Pango from "../pango/index.js";
-/**
- * The interface for GTK input methods.
- *
- * `GtkIMContext` is used by GTK text input widgets like `GtkText`
- * to map from key events to Unicode character strings.
- *
- * An input method may consume multiple key events in sequence before finally
- * outputting the composed result. This is called *preediting*, and an input
- * method may provide feedback about this process by displaying the intermediate
- * composition states as preedit text. To do so, the `GtkIMContext` will emit
- * {@link Gtk.IMContext.:preedit-start}, {@link Gtk.IMContext.:preedit-changed}
- * and {@link Gtk.IMContext.:preedit-end} signals.
- *
- * For instance, the built-in GTK input method {@link Gtk.IMContextSimple}
- * implements the input of arbitrary Unicode code points by holding down the
- * `Control` and `Shift` keys and then typing `u`
- * followed by the hexadecimal digits of the code point. When releasing the
- * `Control` and `Shift` keys, preediting ends and the
- * character is inserted as text. For example,
- *
- * Ctrl+Shift+u 2 0 A C
- *
- * results in the € sign.
- *
- * Additional input methods can be made available for use by GTK widgets as
- * loadable modules. An input method module is a small shared library which
- * provides a `GIOExtension` for the extension point named "gtk-im-module".
- *
- * To connect a widget to the users preferred input method, you should use
- * {@link Gtk.IMMulticontext}.
- */
-const SIGNAL_META = {
-    commit: {
-        params: [{ type: "string", borrowed: true }],
-        returnType: { type: "undefined" },
-    },
-    "delete-surrounding": {
-        params: [
-            { type: "int", size: 32, unsigned: false },
-            { type: "int", size: 32, unsigned: false },
-        ],
-        returnType: { type: "boolean" },
-    },
-    "preedit-changed": { params: [], returnType: { type: "undefined" } },
-    "preedit-end": { params: [], returnType: { type: "undefined" } },
-    "preedit-start": { params: [], returnType: { type: "undefined" } },
-    "retrieve-surrounding": { params: [], returnType: { type: "boolean" } },
-    notify: {
-        params: [{ type: "gparam", borrowed: true }],
-        returnType: { type: "undefined" },
-    },
-};
-export class IMContext extends GObject.GObject {
-    static glibTypeName = "GtkIMContext";
-    static objectType = "gobject";
-    constructor() {
-        super();
-    }
-    /**
-     * Requests the platform to show an on-screen keyboard for user input.
-     *
-     * This method will return %TRUE if this request was actually performed
-     * to the platform, other environmental factors may result in an on-screen
-     * keyboard effectively not showing up.
-     * @param event - a {@link Gdk.Event}
-     */
-    activateOsk(event) {
-        return call("libgtk-4.so.1", "gtk_im_context_activate_osk", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-            {
-                type: { type: "gobject", borrowed: true },
-                value: event?.id ?? event,
-                optional: true,
-            },
-        ], { type: "boolean" });
-    }
-    /**
-     * Asks the widget that the input context is attached to delete
-     * characters around the cursor position by emitting the
-     * `::delete_surrounding` signal.
-     *
-     * Note that `offset` and `n_chars` are in characters not in bytes
-     * which differs from the usage other places in `GtkIMContext`.
-     *
-     * In order to use this function, you should first call
-     * {@link Gtk.IMContext.get_surrounding} to get the current context,
-     * and call this function immediately afterwards to make sure that you
-     * know what you are deleting. You should also account for the fact
-     * that even if the signal was handled, the input context might not
-     * have deleted all the characters that were requested to be deleted.
-     *
-     * This function is used by an input method that wants to make
-     * substitutions in the existing text in response to new input.
-     * It is not useful for applications.
-     * @param offset - offset from cursor position in chars;
-     * @param nChars - number of characters to delete.
-     */
-    deleteSurrounding(offset, nChars) {
-        return call("libgtk-4.so.1", "gtk_im_context_delete_surrounding", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-            {
-                type: { type: "int", size: 32, unsigned: false },
-                value: offset,
-            },
-            {
-                type: { type: "int", size: 32, unsigned: false },
-                value: nChars,
-            },
-        ], { type: "boolean" });
-    }
-    /**
-     * Allow an input method to forward key press and release events
-     * to another input method without necessarily having a `GdkEvent`
-     * available.
-     * @param press - whether to forward a key press or release event
-     * @param surface - the surface the event is for
-     * @param device - the device that the event is for
-     * @param time - the timestamp for the event
-     * @param keycode - the keycode for the event
-     * @param state - modifier state for the event
-     * @param group - the active keyboard group for the event
-     */
-    filterKey(press, surface, device, time, keycode, state, group) {
-        return call("libgtk-4.so.1", "gtk_im_context_filter_key", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-            {
-                type: { type: "boolean" },
-                value: press,
-            },
-            {
-                type: { type: "gobject", borrowed: true },
-                value: surface?.id ?? surface,
-            },
-            {
-                type: { type: "gobject", borrowed: true },
-                value: device?.id ?? device,
-            },
-            {
-                type: { type: "int", size: 32, unsigned: true },
-                value: time,
-            },
-            {
-                type: { type: "int", size: 32, unsigned: true },
-                value: keycode,
-            },
-            {
-                type: { type: "int", size: 32, unsigned: true },
-                value: state,
-            },
-            {
-                type: { type: "int", size: 32, unsigned: false },
-                value: group,
-            },
-        ], { type: "boolean" });
-    }
-    /**
-     * Allow an input method to internally handle key press and release
-     * events.
-     *
-     * If this function returns %TRUE, then no further processing
-     * should be done for this key event.
-     * @param event - the key event
-     */
-    filterKeypress(event) {
-        return call("libgtk-4.so.1", "gtk_im_context_filter_keypress", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-            {
-                type: { type: "gobject", borrowed: true },
-                value: event?.id ?? event,
-            },
-        ], { type: "boolean" });
-    }
-    /**
-     * Notify the input method that the widget to which this
-     * input context corresponds has gained focus.
-     *
-     * The input method may, for example, change the displayed
-     * feedback to reflect this change.
-     */
-    focusIn() {
-        call("libgtk-4.so.1", "gtk_im_context_focus_in", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-        ], { type: "undefined" });
-    }
-    /**
-     * Notify the input method that the widget to which this
-     * input context corresponds has lost focus.
-     *
-     * The input method may, for example, change the displayed
-     * feedback or reset the contexts state to reflect this change.
-     */
-    focusOut() {
-        call("libgtk-4.so.1", "gtk_im_context_focus_out", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-        ], { type: "undefined" });
-    }
-    /**
-     * Retrieve the current preedit string for the input context,
-     * and a list of attributes to apply to the string.
-     *
-     * This string should be displayed inserted at the insertion point.
-     * @param str - location to store the retrieved
-     * @param attrs - location to store the retrieved
-     * @param cursorPos - location to store position of cursor
-     */
-    getPreeditString(str, attrs, cursorPos) {
-        call("libgtk-4.so.1", "gtk_im_context_get_preedit_string", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-            {
-                type: { type: "ref", innerType: { type: "string" } },
-                value: str,
-            },
-            {
-                type: {
-                    type: "ref",
-                    innerType: {
-                        type: "boxed",
-                        innerType: "PangoAttrList",
-                        lib: "libpango-1.0.so.0",
-                        getTypeFn: "pango_attr_list_get_type",
-                    },
-                },
-                value: attrs,
-            },
-            {
-                type: {
-                    type: "ref",
-                    innerType: { type: "int", size: 32, unsigned: false },
-                },
-                value: cursorPos,
-            },
-        ], { type: "undefined" });
-        attrs.value = getNativeObject(attrs.value, Pango.AttrList);
-    }
-    /**
-     * Retrieves context around the insertion point.
-     *
-     * Input methods typically want context in order to constrain input text
-     * based on existing text; this is important for languages such as Thai
-     * where only some sequences of characters are allowed.
-     *
-     * This function is implemented by emitting the
-     * {@link Gtk.IMContext.:retrieve-surrounding} signal on the input method;
-     * in response to this signal, a widget should provide as much context as
-     * is available, up to an entire paragraph, by calling
-     * {@link Gtk.IMContext.set_surrounding}.
-     *
-     * Note that there is no obligation for a widget to respond to the
-     * `::retrieve-surrounding` signal, so input methods must be prepared to
-     * function without context.
-     * @param text - location to store a UTF-8 encoded
-     * @param cursorIndex - location to store byte index of the insertion
-     */
-    getSurrounding(text, cursorIndex) {
-        return call("libgtk-4.so.1", "gtk_im_context_get_surrounding", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-            {
-                type: { type: "ref", innerType: { type: "string" } },
-                value: text,
-            },
-            {
-                type: {
-                    type: "ref",
-                    innerType: { type: "int", size: 32, unsigned: false },
-                },
-                value: cursorIndex,
-            },
-        ], { type: "boolean" });
-    }
-    /**
-     * Retrieves context around the insertion point.
-     *
-     * Input methods typically want context in order to constrain input
-     * text based on existing text; this is important for languages such
-     * as Thai where only some sequences of characters are allowed.
-     *
-     * This function is implemented by emitting the
-     * {@link Gtk.IMContext.:retrieve-surrounding} signal on the input method;
-     * in response to this signal, a widget should provide as much context as
-     * is available, up to an entire paragraph, by calling
-     * {@link Gtk.IMContext.set_surrounding_with_selection}.
-     *
-     * Note that there is no obligation for a widget to respond to the
-     * `::retrieve-surrounding` signal, so input methods must be prepared to
-     * function without context.
-     * @param text - location to store a UTF-8 encoded
-     * @param cursorIndex - location to store byte index of the insertion
-     * @param anchorIndex - location to store byte index of the selection
-     */
-    getSurroundingWithSelection(text, cursorIndex, anchorIndex) {
-        return call("libgtk-4.so.1", "gtk_im_context_get_surrounding_with_selection", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-            {
-                type: { type: "ref", innerType: { type: "string" } },
-                value: text,
-            },
-            {
-                type: {
-                    type: "ref",
-                    innerType: { type: "int", size: 32, unsigned: false },
-                },
-                value: cursorIndex,
-            },
-            {
-                type: {
-                    type: "ref",
-                    innerType: { type: "int", size: 32, unsigned: false },
-                },
-                value: anchorIndex,
-            },
-        ], { type: "boolean" });
-    }
-    /**
-     * Notify the input method that a change such as a change in cursor
-     * position has been made.
-     *
-     * This will typically cause the input method to clear the preedit state.
-     */
-    reset() {
-        call("libgtk-4.so.1", "gtk_im_context_reset", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-        ], { type: "undefined" });
-    }
-    /**
-     * Set the client widget for the input context.
-     *
-     * This is the `GtkWidget` holding the input focus. This widget is
-     * used in order to correctly position status windows, and may
-     * also be used for purposes internal to the input method.
-     * @param widget - the client widget. This may be %NULL to indicate
-     */
-    setClientWidget(widget) {
-        call("libgtk-4.so.1", "gtk_im_context_set_client_widget", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-            {
-                type: { type: "gobject", borrowed: true },
-                value: widget?.id ?? widget,
-                optional: true,
-            },
-        ], { type: "undefined" });
-    }
-    /**
-     * Notify the input method that a change in cursor
-     * position has been made.
-     *
-     * The location is relative to the client widget.
-     * @param area - new location
-     */
-    setCursorLocation(area) {
-        call("libgtk-4.so.1", "gtk_im_context_set_cursor_location", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-            {
-                type: {
-                    type: "boxed",
-                    borrowed: true,
-                    innerType: "GdkRectangle",
-                    lib: "libgtk-4.so.1",
-                    getTypeFn: "gdk_rectangle_get_type",
-                },
-                value: area?.id ?? area,
-            },
-        ], { type: "undefined" });
-    }
-    /**
-     * Sets surrounding context around the insertion point and preedit
-     * string.
-     *
-     * This function is expected to be called in response to the
-     * {@link Gtk.IMContext.:retrieve-surrounding} signal, and will
-     * likely have no effect if called at other times.
-     * @param text - text surrounding the insertion point, as UTF-8.
-     * @param len - the length of `text`, or -1 if `text` is nul-terminated
-     * @param cursorIndex - the byte index of the insertion cursor within `text`.
-     */
-    setSurrounding(text, len, cursorIndex) {
-        call("libgtk-4.so.1", "gtk_im_context_set_surrounding", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-            {
-                type: { type: "string", borrowed: true },
-                value: text,
-            },
-            {
-                type: { type: "int", size: 32, unsigned: false },
-                value: len,
-            },
-            {
-                type: { type: "int", size: 32, unsigned: false },
-                value: cursorIndex,
-            },
-        ], { type: "undefined" });
-    }
-    /**
-     * Sets surrounding context around the insertion point and preedit
-     * string. This function is expected to be called in response to the
-     * {@link Gtk.IMContext.:retrieve_surrounding} signal, and will likely
-     * have no effect if called at other times.
-     * @param text - text surrounding the insertion point, as UTF-8.
-     * @param len - the length of `text`, or -1 if `text` is nul-terminated
-     * @param cursorIndex - the byte index of the insertion cursor within `text`
-     * @param anchorIndex - the byte index of the selection bound within `text`
-     */
-    setSurroundingWithSelection(text, len, cursorIndex, anchorIndex) {
-        call("libgtk-4.so.1", "gtk_im_context_set_surrounding_with_selection", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-            {
-                type: { type: "string", borrowed: true },
-                value: text,
-            },
-            {
-                type: { type: "int", size: 32, unsigned: false },
-                value: len,
-            },
-            {
-                type: { type: "int", size: 32, unsigned: false },
-                value: cursorIndex,
-            },
-            {
-                type: { type: "int", size: 32, unsigned: false },
-                value: anchorIndex,
-            },
-        ], { type: "undefined" });
-    }
-    /**
-     * Sets whether the IM context should use the preedit string
-     * to display feedback.
-     *
-     * If `use_preedit` is %FALSE (default is %TRUE), then the IM context
-     * may use some other method to display feedback, such as displaying
-     * it in a child of the root window.
-     * @param usePreedit - whether the IM context should use the preedit string.
-     */
-    setUsePreedit(usePreedit) {
-        call("libgtk-4.so.1", "gtk_im_context_set_use_preedit", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-            {
-                type: { type: "boolean" },
-                value: usePreedit,
-            },
-        ], { type: "undefined" });
-    }
-    connect(signal, handler, after = false) {
-        const meta = SIGNAL_META[signal];
-        const selfType = { type: "gobject", borrowed: true };
-        const argTypes = meta ? [selfType, ...meta.params] : [selfType];
-        const returnType = meta?.returnType;
-        const wrappedHandler = (...args) => {
-            const self = getNativeObject(args[0]);
-            const callbackArgs = args.slice(1);
-            if (!meta)
-                return handler(self, ...callbackArgs);
-            const wrapped = meta.params.map((t, i) => {
-                if (t?.type === "gobject" && callbackArgs[i] != null) {
-                    return getNativeObject(callbackArgs[i]);
-                }
-                if (t?.type === "gparam" && callbackArgs[i] != null) {
-                    return getNativeObject(callbackArgs[i], GObject.ParamSpec);
-                }
-                return callbackArgs[i];
-            });
-            const result = handler(self, ...wrapped);
-            return result;
-        };
-        return call("libgtk-4.so.1", "g_signal_connect_closure", [
-            { type: { type: "gobject" }, value: this.id },
-            { type: { type: "string" }, value: signal },
-            {
-                type: { type: "callback", argTypes, returnType },
-                value: wrappedHandler,
-            },
-            { type: { type: "boolean" }, value: after },
-        ], { type: "int", size: 64, unsigned: true });
-    }
-}
-registerNativeClass(IMContext);

package/dist/generated/gtk/immulticontext.d.ts

@@ -1,34 +0,0 @@
-import * as GObject from "../gobject/index.js";
-import { IMContext } from "./imcontext.js";
-export declare class IMMulticontext extends IMContext {
-    static readonly glibTypeName: string;
-    static readonly objectType: "gobject";
-    /**
-     * Creates a new `GtkIMMulticontext`.
-     */
-    constructor();
-    /**
-     * Gets the id of the currently active delegate of the `context`.
-     */
-    getContextId(): string;
-    /**
-     * Sets the context id for `context`.
-     *
-     * This causes the currently active delegate of `context` to be
-     * replaced by the delegate corresponding to the new context id.
-     *
-     * Setting this to a non-%NULL value overrides the system-wide
-     * IM module setting. See the {@link Gtk.Settings.gtk-im-module}
-     * property.
-     * @param contextId - the id to use
-     */
-    setContextId(contextId?: string): void;
-    connect(signal: "commit", handler: (self: IMMulticontext, str: string) => void, after?: boolean): number;
-    connect(signal: "delete-surrounding", handler: (self: IMMulticontext, offset: number, nChars: number) => boolean, after?: boolean): number;
-    connect(signal: "preedit-changed", handler: (self: IMMulticontext) => void, after?: boolean): number;
-    connect(signal: "preedit-end", handler: (self: IMMulticontext) => void, after?: boolean): number;
-    connect(signal: "preedit-start", handler: (self: IMMulticontext) => void, after?: boolean): number;
-    connect(signal: "retrieve-surrounding", handler: (self: IMMulticontext) => boolean, after?: boolean): number;
-    connect(signal: "notify", handler: (self: IMMulticontext, pspec: GObject.ParamSpec) => void, after?: boolean): number;
-    connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;
-}

package/dist/generated/gtk/immulticontext.js

@@ -1,125 +0,0 @@
-import { call } from "../../batch.js";
-import { getNativeObject } from "../../native/object.js";
-import { isInstantiating, setInstantiating } from "../../native/base.js";
-import { registerNativeClass } from "../../registry.js";
-import * as GObject from "../gobject/index.js";
-import { IMContext } from "./imcontext.js";
-/**
- * Supports switching between multiple input methods.
- *
- * Text widgets such as `GtkText` or `GtkTextView` use a `GtkIMMultiContext`
- * to implement their `im-module` property for switching between different
- * input methods.
- */
-const SIGNAL_META = {
-    commit: {
-        params: [{ type: "string", borrowed: true }],
-        returnType: { type: "undefined" },
-    },
-    "delete-surrounding": {
-        params: [
-            { type: "int", size: 32, unsigned: false },
-            { type: "int", size: 32, unsigned: false },
-        ],
-        returnType: { type: "boolean" },
-    },
-    "preedit-changed": { params: [], returnType: { type: "undefined" } },
-    "preedit-end": { params: [], returnType: { type: "undefined" } },
-    "preedit-start": { params: [], returnType: { type: "undefined" } },
-    "retrieve-surrounding": { params: [], returnType: { type: "boolean" } },
-    notify: {
-        params: [{ type: "gparam", borrowed: true }],
-        returnType: { type: "undefined" },
-    },
-};
-export class IMMulticontext extends IMContext {
-    static glibTypeName = "GtkIMMulticontext";
-    static objectType = "gobject";
-    /**
-     * Creates a new `GtkIMMulticontext`.
-     */
-    constructor() {
-        if (!isInstantiating) {
-            setInstantiating(true);
-            // @ts-ignore
-            super();
-            setInstantiating(false);
-            this.id = call("libgtk-4.so.1", "gtk_im_multicontext_new", [], {
-                type: "gobject",
-                borrowed: false,
-            });
-        }
-        else {
-            // @ts-ignore
-            super();
-        }
-    }
-    /**
-     * Gets the id of the currently active delegate of the `context`.
-     */
-    getContextId() {
-        return call("libgtk-4.so.1", "gtk_im_multicontext_get_context_id", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-        ], { type: "string", borrowed: true });
-    }
-    /**
-     * Sets the context id for `context`.
-     *
-     * This causes the currently active delegate of `context` to be
-     * replaced by the delegate corresponding to the new context id.
-     *
-     * Setting this to a non-%NULL value overrides the system-wide
-     * IM module setting. See the {@link Gtk.Settings.gtk-im-module}
-     * property.
-     * @param contextId - the id to use
-     */
-    setContextId(contextId) {
-        call("libgtk-4.so.1", "gtk_im_multicontext_set_context_id", [
-            {
-                type: { type: "gobject" },
-                value: this.id,
-            },
-            {
-                type: { type: "string", borrowed: true },
-                value: contextId,
-                optional: true,
-            },
-        ], { type: "undefined" });
-    }
-    connect(signal, handler, after = false) {
-        const meta = SIGNAL_META[signal];
-        const selfType = { type: "gobject", borrowed: true };
-        const argTypes = meta ? [selfType, ...meta.params] : [selfType];
-        const returnType = meta?.returnType;
-        const wrappedHandler = (...args) => {
-            const self = getNativeObject(args[0]);
-            const callbackArgs = args.slice(1);
-            if (!meta)
-                return handler(self, ...callbackArgs);
-            const wrapped = meta.params.map((t, i) => {
-                if (t?.type === "gobject" && callbackArgs[i] != null) {
-                    return getNativeObject(callbackArgs[i]);
-                }
-                if (t?.type === "gparam" && callbackArgs[i] != null) {
-                    return getNativeObject(callbackArgs[i], GObject.ParamSpec);
-                }
-                return callbackArgs[i];
-            });
-            const result = handler(self, ...wrapped);
-            return result;
-        };
-        return call("libgtk-4.so.1", "g_signal_connect_closure", [
-            { type: { type: "gobject" }, value: this.id },
-            { type: { type: "string" }, value: signal },
-            {
-                type: { type: "callback", argTypes, returnType },
-                value: wrappedHandler,
-            },
-            { type: { type: "boolean" }, value: after },
-        ], { type: "int", size: 64, unsigned: true });
-    }
-}
-registerNativeClass(IMMulticontext);