@gtkx/ffi 0.1.45 → 0.1.46

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

@@ -4,29 +4,251 @@ import * as Gdk from "../gdk/index.js";
 import * as GdkPixbuf from "../gdkpixbuf/index.js";
 import * as Gio from "../gio/index.js";
 import { Widget } from "./widget.js";
+/**
+ * Displays an image.
+ *
+ *
+ *
+ * Various kinds of object can be displayed as an image; most typically,
+ * you would load a `GdkTexture` from a file, using the convenience function
+ * [ctor@Gtk.Image.new_from_file], for instance:
+ *
+ * ```c
+ * GtkWidget *image = gtk_image_new_from_file ("myfile.png");
+ * ```
+ *
+ * If the file isn’t loaded successfully, the image will contain a
+ * “broken image” icon similar to that used in many web browsers.
+ *
+ * If you want to handle errors in loading the file yourself, for example
+ * by displaying an error message, then load the image with an image
+ * loading framework such as libglycin, then create the `GtkImage` with
+ * [ctor@Gtk.Image.new_from_paintable].
+ *
+ * Sometimes an application will want to avoid depending on external data
+ * files, such as image files. See the documentation of `GResource` inside
+ * GIO, for details. In this case, [property@Gtk.Image:resource],
+ * [ctor@Gtk.Image.new_from_resource], and [method@Gtk.Image.set_from_resource]
+ * should be used.
+ *
+ * `GtkImage` displays its image as an icon, with a size that is determined
+ * by the application. See [class@Gtk.Picture] if you want to show an image
+ * at is actual size.
+ *
+ * ## CSS nodes
+ *
+ * `GtkImage` has a single CSS node with the name `image`. The style classes
+ * `.normal-icons` or `.large-icons` may appear, depending on the
+ * [property@Gtk.Image:icon-size] property.
+ *
+ * ## Accessibility
+ *
+ * `GtkImage` uses the [enum@Gtk.AccessibleRole.img] role.
+ */
 export declare class Image extends Widget {
+    /**
+     * Creates a new empty `GtkImage` widget.
+     */
     constructor(...args: unknown[]);
+    /**
+     * Creates a new `GtkImage` displaying the file @filename.
+     *
+     * If the file isn’t found or can’t be loaded, the resulting `GtkImage`
+     * will display a “broken image” icon. This function never returns %NULL,
+     * it always returns a valid `GtkImage` widget.
+     *
+     * If you need to detect failures to load the file, use an
+     * image loading framework such as libglycin to load the file
+     * yourself, then create the `GtkImage` from the texture.
+     *
+     * The storage type (see [method@Gtk.Image.get_storage_type])
+     * of the returned image is not defined, it will be whatever
+     * is appropriate for displaying the file.
+     * @param filename - a filename
+     */
     static newFromFile(filename: string): Image;
+    /**
+     * Creates a `GtkImage` displaying an icon from the current icon theme.
+     *
+     * If the icon name isn’t known, a “broken image” icon will be
+     * displayed instead. If the current icon theme is changed, the icon
+     * will be updated appropriately.
+     * @param icon - an icon
+     */
     static newFromGicon(icon: Gio.Icon): Image;
+    /**
+     * Creates a `GtkImage` displaying an icon from the current icon theme.
+     *
+     * If the icon name isn’t known, a “broken image” icon will be
+     * displayed instead. If the current icon theme is changed, the icon
+     * will be updated appropriately.
+     * @param iconName - an icon name
+     */
     static newFromIconName(iconName?: string | null): Image;
+    /**
+     * Creates a new `GtkImage` displaying @paintable.
+     *
+     * The `GtkImage` does not assume a reference to the paintable; you still
+     * need to unref it if you own references. `GtkImage` will add its own
+     * reference rather than adopting yours.
+     *
+     * The `GtkImage` will track changes to the `paintable` and update
+     * its size and contents in response to it.
+     *
+     * Note that paintables are still subject to the icon size that is
+     * set on the image. If you want to display a paintable at its intrinsic
+     * size, use [class@Gtk.Picture] instead.
+     *
+     * If `paintable` is a [iface@Gtk.SymbolicPaintable], then it will be
+     * recolored with the symbolic palette from the theme.
+     * @param paintable - a `GdkPaintable`
+     */
     static newFromPaintable(paintable?: Gdk.Paintable | null): Image;
+    /**
+     * Creates a new `GtkImage` displaying @pixbuf.
+     *
+     * The `GtkImage` does not assume a reference to the pixbuf; you still
+     * need to unref it if you own references. `GtkImage` will add its own
+     * reference rather than adopting yours.
+     *
+     * This is a helper for [ctor@Gtk.Image.new_from_paintable], and you can't
+     * get back the exact pixbuf once this is called, only a texture.
+     *
+     * Note that this function just creates an `GtkImage` from the pixbuf.
+     * The `GtkImage` created will not react to state changes. Should you
+     * want that, you should use [ctor@Gtk.Image.new_from_icon_name].
+     * @param pixbuf - a `GdkPixbuf`
+     */
     static newFromPixbuf(pixbuf?: GdkPixbuf.Pixbuf | null): Image;
+    /**
+     * Creates a new `GtkImage` displaying the resource file @resource_path.
+     *
+     * If the file isn’t found or can’t be loaded, the resulting `GtkImage` will
+     * display a “broken image” icon. This function never returns %NULL,
+     * it always returns a valid `GtkImage` widget.
+     *
+     * If you need to detect failures to load the file, use an
+     * image loading framework such as libglycin to load the file
+     * yourself, then create the `GtkImage` from the texture.
+     *
+     * The storage type (see [method@Gtk.Image.get_storage_type]) of
+     * the returned image is not defined, it will be whatever is
+     * appropriate for displaying the file.
+     * @param resourcePath - a resource path
+     */
     static newFromResource(resourcePath: string): Image;
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Resets the image to be empty.
+     */
     clear(): void;
+    /**
+     * Gets the `GIcon` being displayed by the `GtkImage`.
+     *
+     * The storage type of the image must be %GTK_IMAGE_EMPTY or
+     * %GTK_IMAGE_GICON (see [method@Gtk.Image.get_storage_type]).
+     * The caller of this function does not own a reference to the
+     * returned `GIcon`.
+     */
     getGicon(): Gio.Icon | null;
+    /**
+     * Gets the icon name and size being displayed by the `GtkImage`.
+     *
+     * The storage type of the image must be %GTK_IMAGE_EMPTY or
+     * %GTK_IMAGE_ICON_NAME (see [method@Gtk.Image.get_storage_type]).
+     * The returned string is owned by the `GtkImage` and should not
+     * be freed.
+     */
     getIconName(): string | null;
+    /**
+     * Gets the icon size used by the `image` when rendering icons.
+     */
     getIconSize(): IconSize;
+    /**
+     * Gets the image `GdkPaintable` being displayed by the `GtkImage`.
+     *
+     * The storage type of the image must be %GTK_IMAGE_EMPTY or
+     * %GTK_IMAGE_PAINTABLE (see [method@Gtk.Image.get_storage_type]).
+     * The caller of this function does not own a reference to the
+     * returned paintable.
+     */
     getPaintable(): Gdk.Paintable | null;
+    /**
+     * Gets the pixel size used for named icons.
+     */
     getPixelSize(): number;
+    /**
+     * Gets the type of representation being used by the `GtkImage`
+     * to store image data.
+     *
+     * If the `GtkImage` has no image data, the return value will
+     * be %GTK_IMAGE_EMPTY.
+     */
     getStorageType(): ImageType;
+    /**
+     * Sets a `GtkImage` to show a file.
+     *
+     * See [ctor@Gtk.Image.new_from_file] for details.
+     *
+     * ::: warning
+     * Note that this function should not be used with untrusted data.
+     * Use a proper image loading framework such as libglycin, which can
+     * load many image formats into a `GdkTexture`, and then use
+     * [method@Gtk.Image.set_from_paintable].
+     * @param filename - a filename
+     */
     setFromFile(filename?: string | null): void;
+    /**
+     * Sets a `GtkImage` to show a `GIcon`.
+     *
+     * See [ctor@Gtk.Image.new_from_gicon] for details.
+     * @param icon - an icon
+     */
     setFromGicon(icon: Gio.Icon): void;
+    /**
+     * Sets a `GtkImage` to show a named icon.
+     *
+     * See [ctor@Gtk.Image.new_from_icon_name] for details.
+     * @param iconName - an icon name
+     */
     setFromIconName(iconName?: string | null): void;
+    /**
+     * Sets a `GtkImage` to show a `GdkPaintable`.
+     *
+     * See [ctor@Gtk.Image.new_from_paintable] for details.
+     * @param paintable - a `GdkPaintable`
+     */
     setFromPaintable(paintable?: Gdk.Paintable | null): void;
+    /**
+     * Sets a `GtkImage` to show a `GdkPixbuf`.
+     *
+     * See [ctor@Gtk.Image.new_from_pixbuf] for details.
+     *
+     * Note: This is a helper for [method@Gtk.Image.set_from_paintable],
+     * and you can't get back the exact pixbuf once this is called,
+     * only a paintable.
+     * @param pixbuf - a `GdkPixbuf` or `NULL`
+     */
     setFromPixbuf(pixbuf?: GdkPixbuf.Pixbuf | null): void;
+    /**
+     * Sets a `GtkImage` to show a resource.
+     *
+     * See [ctor@Gtk.Image.new_from_resource] for details.
+     * @param resourcePath - a resource path
+     */
     setFromResource(resourcePath?: string | null): void;
+    /**
+     * Suggests an icon size to the theme for named icons.
+     * @param iconSize - the new icon size
+     */
     setIconSize(iconSize: IconSize): void;
+    /**
+     * Sets the pixel size to use for named icons.
+     *
+     * If the pixel size is set to a value != -1, it is used instead
+     * of the icon size set by [method@Gtk.Image.set_icon_size].
+     * @param pixelSize - the new pixel size
+     */
     setPixelSize(pixelSize: number): void;
     connect(signal: "notify", handler: (self: Image, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gtk/image.js

@@ -3,10 +3,70 @@ import { getObject } from "@gtkx/ffi";
 import * as Gdk from "../gdk/index.js";
 import * as Gio from "../gio/index.js";
 import { Widget } from "./widget.js";
+/**
+ * Displays an image.
+ *
+ *
+ *
+ * Various kinds of object can be displayed as an image; most typically,
+ * you would load a `GdkTexture` from a file, using the convenience function
+ * [ctor@Gtk.Image.new_from_file], for instance:
+ *
+ * ```c
+ * GtkWidget *image = gtk_image_new_from_file ("myfile.png");
+ * ```
+ *
+ * If the file isn’t loaded successfully, the image will contain a
+ * “broken image” icon similar to that used in many web browsers.
+ *
+ * If you want to handle errors in loading the file yourself, for example
+ * by displaying an error message, then load the image with an image
+ * loading framework such as libglycin, then create the `GtkImage` with
+ * [ctor@Gtk.Image.new_from_paintable].
+ *
+ * Sometimes an application will want to avoid depending on external data
+ * files, such as image files. See the documentation of `GResource` inside
+ * GIO, for details. In this case, [property@Gtk.Image:resource],
+ * [ctor@Gtk.Image.new_from_resource], and [method@Gtk.Image.set_from_resource]
+ * should be used.
+ *
+ * `GtkImage` displays its image as an icon, with a size that is determined
+ * by the application. See [class@Gtk.Picture] if you want to show an image
+ * at is actual size.
+ *
+ * ## CSS nodes
+ *
+ * `GtkImage` has a single CSS node with the name `image`. The style classes
+ * `.normal-icons` or `.large-icons` may appear, depending on the
+ * [property@Gtk.Image:icon-size] property.
+ *
+ * ## Accessibility
+ *
+ * `GtkImage` uses the [enum@Gtk.AccessibleRole.img] role.
+ */
 export class Image extends Widget {
+    /**
+     * Creates a new empty `GtkImage` widget.
+     */
     constructor(...args) {
         super(...args);
     }
+    /**
+     * Creates a new `GtkImage` displaying the file @filename.
+     *
+     * If the file isn’t found or can’t be loaded, the resulting `GtkImage`
+     * will display a “broken image” icon. This function never returns %NULL,
+     * it always returns a valid `GtkImage` widget.
+     *
+     * If you need to detect failures to load the file, use an
+     * image loading framework such as libglycin to load the file
+     * yourself, then create the `GtkImage` from the texture.
+     *
+     * The storage type (see [method@Gtk.Image.get_storage_type])
+     * of the returned image is not defined, it will be whatever
+     * is appropriate for displaying the file.
+     * @param filename - a filename
+     */
     static newFromFile(filename) {
         const ptr = call("libgtk-4.so.1", "gtk_image_new_from_file", [
             {
@@ -16,6 +76,14 @@ export class Image extends Widget {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Image);
     }
+    /**
+     * Creates a `GtkImage` displaying an icon from the current icon theme.
+     *
+     * If the icon name isn’t known, a “broken image” icon will be
+     * displayed instead. If the current icon theme is changed, the icon
+     * will be updated appropriately.
+     * @param icon - an icon
+     */
     static newFromGicon(icon) {
         const ptr = call("libgtk-4.so.1", "gtk_image_new_from_gicon", [
             {
@@ -25,6 +93,14 @@ export class Image extends Widget {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Image);
     }
+    /**
+     * Creates a `GtkImage` displaying an icon from the current icon theme.
+     *
+     * If the icon name isn’t known, a “broken image” icon will be
+     * displayed instead. If the current icon theme is changed, the icon
+     * will be updated appropriately.
+     * @param iconName - an icon name
+     */
     static newFromIconName(iconName) {
         const ptr = call("libgtk-4.so.1", "gtk_image_new_from_icon_name", [
             {
@@ -35,6 +111,24 @@ export class Image extends Widget {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Image);
     }
+    /**
+     * Creates a new `GtkImage` displaying @paintable.
+     *
+     * The `GtkImage` does not assume a reference to the paintable; you still
+     * need to unref it if you own references. `GtkImage` will add its own
+     * reference rather than adopting yours.
+     *
+     * The `GtkImage` will track changes to the `paintable` and update
+     * its size and contents in response to it.
+     *
+     * Note that paintables are still subject to the icon size that is
+     * set on the image. If you want to display a paintable at its intrinsic
+     * size, use [class@Gtk.Picture] instead.
+     *
+     * If `paintable` is a [iface@Gtk.SymbolicPaintable], then it will be
+     * recolored with the symbolic palette from the theme.
+     * @param paintable - a `GdkPaintable`
+     */
     static newFromPaintable(paintable) {
         const ptr = call("libgtk-4.so.1", "gtk_image_new_from_paintable", [
             {
@@ -45,6 +139,21 @@ export class Image extends Widget {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Image);
     }
+    /**
+     * Creates a new `GtkImage` displaying @pixbuf.
+     *
+     * The `GtkImage` does not assume a reference to the pixbuf; you still
+     * need to unref it if you own references. `GtkImage` will add its own
+     * reference rather than adopting yours.
+     *
+     * This is a helper for [ctor@Gtk.Image.new_from_paintable], and you can't
+     * get back the exact pixbuf once this is called, only a texture.
+     *
+     * Note that this function just creates an `GtkImage` from the pixbuf.
+     * The `GtkImage` created will not react to state changes. Should you
+     * want that, you should use [ctor@Gtk.Image.new_from_icon_name].
+     * @param pixbuf - a `GdkPixbuf`
+     */
     static newFromPixbuf(pixbuf) {
         const ptr = call("libgtk-4.so.1", "gtk_image_new_from_pixbuf", [
             {
@@ -55,6 +164,22 @@ export class Image extends Widget {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Image);
     }
+    /**
+     * Creates a new `GtkImage` displaying the resource file @resource_path.
+     *
+     * If the file isn’t found or can’t be loaded, the resulting `GtkImage` will
+     * display a “broken image” icon. This function never returns %NULL,
+     * it always returns a valid `GtkImage` widget.
+     *
+     * If you need to detect failures to load the file, use an
+     * image loading framework such as libglycin to load the file
+     * yourself, then create the `GtkImage` from the texture.
+     *
+     * The storage type (see [method@Gtk.Image.get_storage_type]) of
+     * the returned image is not defined, it will be whatever is
+     * appropriate for displaying the file.
+     * @param resourcePath - a resource path
+     */
     static newFromResource(resourcePath) {
         const ptr = call("libgtk-4.so.1", "gtk_image_new_from_resource", [
             {
@@ -70,6 +195,9 @@ export class Image extends Widget {
             borrowed: true,
         });
     }
+    /**
+     * Resets the image to be empty.
+     */
     clear() {
         call("libgtk-4.so.1", "gtk_image_clear", [
             {
@@ -78,6 +206,14 @@ export class Image extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the `GIcon` being displayed by the `GtkImage`.
+     *
+     * The storage type of the image must be %GTK_IMAGE_EMPTY or
+     * %GTK_IMAGE_GICON (see [method@Gtk.Image.get_storage_type]).
+     * The caller of this function does not own a reference to the
+     * returned `GIcon`.
+     */
     getGicon() {
         const ptr = call("libgtk-4.so.1", "gtk_image_get_gicon", [
             {
@@ -89,6 +225,14 @@ export class Image extends Widget {
             return null;
         return getObject(ptr, Gio.Icon);
     }
+    /**
+     * Gets the icon name and size being displayed by the `GtkImage`.
+     *
+     * The storage type of the image must be %GTK_IMAGE_EMPTY or
+     * %GTK_IMAGE_ICON_NAME (see [method@Gtk.Image.get_storage_type]).
+     * The returned string is owned by the `GtkImage` and should not
+     * be freed.
+     */
     getIconName() {
         return call("libgtk-4.so.1", "gtk_image_get_icon_name", [
             {
@@ -97,6 +241,9 @@ export class Image extends Widget {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Gets the icon size used by the `image` when rendering icons.
+     */
     getIconSize() {
         return call("libgtk-4.so.1", "gtk_image_get_icon_size", [
             {
@@ -105,6 +252,14 @@ export class Image extends Widget {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the image `GdkPaintable` being displayed by the `GtkImage`.
+     *
+     * The storage type of the image must be %GTK_IMAGE_EMPTY or
+     * %GTK_IMAGE_PAINTABLE (see [method@Gtk.Image.get_storage_type]).
+     * The caller of this function does not own a reference to the
+     * returned paintable.
+     */
     getPaintable() {
         const ptr = call("libgtk-4.so.1", "gtk_image_get_paintable", [
             {
@@ -116,6 +271,9 @@ export class Image extends Widget {
             return null;
         return getObject(ptr, Gdk.Paintable);
     }
+    /**
+     * Gets the pixel size used for named icons.
+     */
     getPixelSize() {
         return call("libgtk-4.so.1", "gtk_image_get_pixel_size", [
             {
@@ -124,6 +282,13 @@ export class Image extends Widget {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the type of representation being used by the `GtkImage`
+     * to store image data.
+     *
+     * If the `GtkImage` has no image data, the return value will
+     * be %GTK_IMAGE_EMPTY.
+     */
     getStorageType() {
         return call("libgtk-4.so.1", "gtk_image_get_storage_type", [
             {
@@ -132,6 +297,18 @@ export class Image extends Widget {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Sets a `GtkImage` to show a file.
+     *
+     * See [ctor@Gtk.Image.new_from_file] for details.
+     *
+     * ::: warning
+     * Note that this function should not be used with untrusted data.
+     * Use a proper image loading framework such as libglycin, which can
+     * load many image formats into a `GdkTexture`, and then use
+     * [method@Gtk.Image.set_from_paintable].
+     * @param filename - a filename
+     */
     setFromFile(filename) {
         call("libgtk-4.so.1", "gtk_image_set_from_file", [
             {
@@ -145,6 +322,12 @@ export class Image extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets a `GtkImage` to show a `GIcon`.
+     *
+     * See [ctor@Gtk.Image.new_from_gicon] for details.
+     * @param icon - an icon
+     */
     setFromGicon(icon) {
         call("libgtk-4.so.1", "gtk_image_set_from_gicon", [
             {
@@ -157,6 +340,12 @@ export class Image extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets a `GtkImage` to show a named icon.
+     *
+     * See [ctor@Gtk.Image.new_from_icon_name] for details.
+     * @param iconName - an icon name
+     */
     setFromIconName(iconName) {
         call("libgtk-4.so.1", "gtk_image_set_from_icon_name", [
             {
@@ -170,6 +359,12 @@ export class Image extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets a `GtkImage` to show a `GdkPaintable`.
+     *
+     * See [ctor@Gtk.Image.new_from_paintable] for details.
+     * @param paintable - a `GdkPaintable`
+     */
     setFromPaintable(paintable) {
         call("libgtk-4.so.1", "gtk_image_set_from_paintable", [
             {
@@ -183,6 +378,16 @@ export class Image extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets a `GtkImage` to show a `GdkPixbuf`.
+     *
+     * See [ctor@Gtk.Image.new_from_pixbuf] for details.
+     *
+     * Note: This is a helper for [method@Gtk.Image.set_from_paintable],
+     * and you can't get back the exact pixbuf once this is called,
+     * only a paintable.
+     * @param pixbuf - a `GdkPixbuf` or `NULL`
+     */
     setFromPixbuf(pixbuf) {
         call("libgtk-4.so.1", "gtk_image_set_from_pixbuf", [
             {
@@ -196,6 +401,12 @@ export class Image extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets a `GtkImage` to show a resource.
+     *
+     * See [ctor@Gtk.Image.new_from_resource] for details.
+     * @param resourcePath - a resource path
+     */
     setFromResource(resourcePath) {
         call("libgtk-4.so.1", "gtk_image_set_from_resource", [
             {
@@ -209,6 +420,10 @@ export class Image extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Suggests an icon size to the theme for named icons.
+     * @param iconSize - the new icon size
+     */
     setIconSize(iconSize) {
         call("libgtk-4.so.1", "gtk_image_set_icon_size", [
             {
@@ -221,6 +436,13 @@ export class Image extends Widget {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the pixel size to use for named icons.
+     *
+     * If the pixel size is set to a value != -1, it is used instead
+     * of the icon size set by [method@Gtk.Image.set_icon_size].
+     * @param pixelSize - the new pixel size
+     */
     setPixelSize(pixelSize) {
         call("libgtk-4.so.1", "gtk_image_set_pixel_size", [
             {

package/dist/generated/gtk/imcontext-simple.d.ts

@@ -1,8 +1,55 @@
 import * as GObject from "../gobject/index.js";
 import { IMContext } from "./imcontext.js";
+/**
+ * Supports compose sequences, dead keys and numeric Unicode input.
+ *
+ * ## Compose sequences
+ *
+ * `GtkIMContextSimple` reads compose sequences from the first of the
+ * following files that is found: ~/.config/gtk-4.0/Compose, ~/.XCompose,
+ * /usr/share/X11/locale/$locale/Compose (for locales that have a nontrivial
+ * Compose file). A subset of the file syntax described in the Compose(5)
+ * manual page is supported. Additionally, `include "%L"` loads GTK’s built-in
+ * table of compose sequences rather than the locale-specific one from X11.
+ *
+ * If none of these files is found, `GtkIMContextSimple` uses a built-in table
+ * of compose sequences that is derived from the X11 Compose files.
+ *
+ * Note that compose sequences typically start with the Compose_key, which is
+ * often not available as a dedicated key on keyboards. Keyboard layouts may
+ * map this keysym to other keys, such as the right Control key.
+ *
+ * ## Unicode characters
+ *
+ * `GtkIMContextSimple` also supports numeric entry of Unicode characters
+ * by typing `Ctrl`-`Shift`-`u`, followed by a
+ * hexadecimal Unicode codepoint.
+ *
+ * For example,
+ *
+ * Ctrl-Shift-u 1 2 3 Enter
+ *
+ * yields U+0123 LATIN SMALL LETTER G WITH CEDILLA, i.e. ģ.
+ *
+ * ## Dead keys
+ *
+ * `GtkIMContextSimple` supports dead keys. For example, typing
+ *
+ * dead_acute a
+ *
+ * yields U+00E! LATIN SMALL LETTER_A WITH ACUTE, i.e. á. Note that this
+ * depends on the keyboard layout including dead keys.
+ */
 export declare class IMContextSimple extends IMContext {
+    /**
+     * Creates a new `GtkIMContextSimple`.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Adds an additional table from the X11 compose file.
+     * @param composeFile - The path of compose file
+     */
     addComposeFile(composeFile: string): void;
     connect(signal: "notify", handler: (self: IMContextSimple, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;