@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/pango/font-face.js

@@ -3,6 +3,10 @@ import { getObject } from "@gtkx/ffi";
 import { FontDescription } from "./font-description.js";
 import { FontFamily } from "./font-family.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * A `PangoFontFace` is used to represent a group of fonts with
+ * the same family, slant, weight, and width, but varying sizes.
+ */
 export class FontFace extends GObject.GObject {
     constructor(...args) {
         super(...args);
@@ -18,6 +22,13 @@ export class FontFace extends GObject.GObject {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Returns a font description that matches the face.
+     *
+     * The resulting font description will have the family, style,
+     * variant, weight and stretch of the face, but its size field
+     * will be unset.
+     */
     describe() {
         const ptr = call("libpango-1.0.so.0", "pango_font_face_describe", [
             {
@@ -32,6 +43,13 @@ export class FontFace extends GObject.GObject {
         });
         return getObject(ptr, FontDescription);
     }
+    /**
+     * Gets a name representing the style of this face.
+     *
+     * Note that a font family may contain multiple faces
+     * with the same name (e.g. a variable and a non-variable
+     * face for the same style).
+     */
     getFaceName() {
         return call("libpango-1.0.so.0", "pango_font_face_get_face_name", [
             {
@@ -40,6 +58,9 @@ export class FontFace extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Gets the `PangoFontFamily` that `face` belongs to.
+     */
     getFamily() {
         const ptr = call("libpango-1.0.so.0", "pango_font_face_get_family", [
             {
@@ -49,6 +70,13 @@ export class FontFace extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, FontFamily);
     }
+    /**
+     * Returns whether a `PangoFontFace` is synthesized.
+     *
+     * This will be the case if the underlying font rendering engine
+     * creates this face from another face, by shearing, emboldening,
+     * lightening or modifying it in some other way.
+     */
     isSynthesized() {
         return call("libpango-1.0.so.0", "pango_font_face_is_synthesized", [
             {
@@ -57,6 +85,16 @@ export class FontFace extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * List the available sizes for a font.
+     *
+     * This is only applicable to bitmap fonts. For scalable fonts, stores
+     * %NULL at the location pointed to by `sizes` and 0 at the location pointed
+     * to by @n_sizes. The sizes returned are in Pango units and are sorted
+     * in ascending order.
+     * @param sizes - location to store a pointer to an array of int. This array
+     * @param nSizes - location to store the number of elements in @sizes
+     */
     listSizes(nSizes, sizes) {
         call("libpango-1.0.so.0", "pango_font_face_list_sizes", [
             {

package/dist/generated/pango/font-family.d.ts

@@ -1,13 +1,68 @@
 import { Ref } from "@gtkx/native";
 import { FontFace } from "./font-face.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * A `PangoFontFamily` is used to represent a family of related
+ * font faces.
+ *
+ * The font faces in a family share a common design, but differ in
+ * slant, weight, width or other aspects.
+ */
 export declare class FontFamily extends GObject.GObject {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Gets the `PangoFontFace` of `family` with the given name.
+     * @param name - the name of a face. If the name is %NULL,
+     */
     getFace(name?: string | null): FontFace | null;
+    /**
+     * Gets the name of the family.
+     *
+     * The name is unique among all fonts for the font backend and can
+     * be used in a `PangoFontDescription` to specify that a face from
+     * this family is desired.
+     */
     getName(): string;
+    /**
+     * A monospace font is a font designed for text display where the the
+     * characters form a regular grid.
+     *
+     * For Western languages this would
+     * mean that the advance width of all characters are the same, but
+     * this categorization also includes Asian fonts which include
+     * double-width characters: characters that occupy two grid cells.
+     * g_unichar_iswide() returns a result that indicates whether a
+     * character is typically double-width in a monospace font.
+     *
+     * The best way to find out the grid-cell size is to call
+     * [method@Pango.FontMetrics.get_approximate_digit_width], since the
+     * results of [method@Pango.FontMetrics.get_approximate_char_width] may
+     * be affected by double-width characters.
+     */
     isMonospace(): boolean;
+    /**
+     * A variable font is a font which has axes that can be modified to
+     * produce different faces.
+     *
+     * Such axes are also known as _variations_; see
+     * [method@Pango.FontDescription.set_variations] for more information.
+     */
     isVariable(): boolean;
+    /**
+     * Lists the different font faces that make up @family.
+     *
+     * The faces in a family share a common design, but differ in slant, weight,
+     * width and other aspects.
+     *
+     * Note that the returned faces are not in any particular order, and
+     * multiple faces may have the same name or characteristics.
+     *
+     * `PangoFontFamily` also implemented the [iface@Gio.ListModel] interface
+     * for enumerating faces.
+     * @param faces - location to store an array of pointers to `PangoFontFace` objects,
+     * @param nFaces - location to store number of elements in @faces.
+     */
     listFaces(nFaces: Ref<number>, faces?: Ref<FontFace[]> | null): void;
     connect(signal: "notify", handler: (self: FontFamily, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/pango/font-family.js

@@ -2,6 +2,13 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { FontFace } from "./font-face.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * A `PangoFontFamily` is used to represent a family of related
+ * font faces.
+ *
+ * The font faces in a family share a common design, but differ in
+ * slant, weight, width or other aspects.
+ */
 export class FontFamily extends GObject.GObject {
     constructor(...args) {
         super(...args);
@@ -17,6 +24,10 @@ export class FontFamily extends GObject.GObject {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Gets the `PangoFontFace` of `family` with the given name.
+     * @param name - the name of a face. If the name is %NULL,
+     */
     getFace(name) {
         const ptr = call("libpango-1.0.so.0", "pango_font_family_get_face", [
             {
@@ -33,6 +44,13 @@ export class FontFamily extends GObject.GObject {
             return null;
         return getObject(ptr, FontFace);
     }
+    /**
+     * Gets the name of the family.
+     *
+     * The name is unique among all fonts for the font backend and can
+     * be used in a `PangoFontDescription` to specify that a face from
+     * this family is desired.
+     */
     getName() {
         return call("libpango-1.0.so.0", "pango_font_family_get_name", [
             {
@@ -41,6 +59,22 @@ export class FontFamily extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * A monospace font is a font designed for text display where the the
+     * characters form a regular grid.
+     *
+     * For Western languages this would
+     * mean that the advance width of all characters are the same, but
+     * this categorization also includes Asian fonts which include
+     * double-width characters: characters that occupy two grid cells.
+     * g_unichar_iswide() returns a result that indicates whether a
+     * character is typically double-width in a monospace font.
+     *
+     * The best way to find out the grid-cell size is to call
+     * [method@Pango.FontMetrics.get_approximate_digit_width], since the
+     * results of [method@Pango.FontMetrics.get_approximate_char_width] may
+     * be affected by double-width characters.
+     */
     isMonospace() {
         return call("libpango-1.0.so.0", "pango_font_family_is_monospace", [
             {
@@ -49,6 +83,13 @@ export class FontFamily extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * A variable font is a font which has axes that can be modified to
+     * produce different faces.
+     *
+     * Such axes are also known as _variations_; see
+     * [method@Pango.FontDescription.set_variations] for more information.
+     */
     isVariable() {
         return call("libpango-1.0.so.0", "pango_font_family_is_variable", [
             {
@@ -57,6 +98,20 @@ export class FontFamily extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Lists the different font faces that make up @family.
+     *
+     * The faces in a family share a common design, but differ in slant, weight,
+     * width and other aspects.
+     *
+     * Note that the returned faces are not in any particular order, and
+     * multiple faces may have the same name or characteristics.
+     *
+     * `PangoFontFamily` also implemented the [iface@Gio.ListModel] interface
+     * for enumerating faces.
+     * @param faces - location to store an array of pointers to `PangoFontFace` objects,
+     * @param nFaces - location to store number of elements in @faces.
+     */
     listFaces(nFaces, faces) {
         call("libpango-1.0.so.0", "pango_font_family_list_faces", [
             {

package/dist/generated/pango/font-map.d.ts

@@ -6,17 +6,105 @@ import { Font } from "./font.js";
 import { FontFamily } from "./font-family.js";
 import { Fontset } from "./fontset.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * A `PangoFontMap` represents the set of fonts available for a
+ * particular rendering system.
+ *
+ * This is a virtual object with implementations being specific to
+ * particular rendering systems.
+ */
 export declare class FontMap extends GObject.GObject {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Loads a font file with one or more fonts into the `PangoFontMap`.
+     *
+     * The added fonts will take precedence over preexisting
+     * fonts with the same name.
+     * @param filename - Path to the font file
+     */
     addFontFile(filename: string): boolean;
+    /**
+     * Forces a change in the fontmap, which will cause any `PangoContext`
+     * using this fontmap to change.
+     *
+     * This function is only useful when implementing a new backend
+     * for Pango, something applications won't do. Backends should
+     * call this function if they have attached extra data to the
+     * fontmap and such data is changed.
+     */
     changed(): void;
+    /**
+     * Creates a `PangoContext` connected to @fontmap.
+     *
+     * This is equivalent to [ctor@Pango.Context.new] followed by
+     * [method@Pango.Context.set_font_map].
+     *
+     * If you are using Pango as part of a higher-level system,
+     * that system may have it's own way of create a `PangoContext`.
+     * For instance, the GTK toolkit has, among others,
+     * gtk_widget_get_pango_context(). Use those instead.
+     */
     createContext(): Context;
+    /**
+     * Gets a font family by name.
+     * @param name - a family name
+     */
     getFamily(name: string): FontFamily;
+    /**
+     * Returns the current serial number of @fontmap.
+     *
+     * The serial number is initialized to an small number larger than zero
+     * when a new fontmap is created and is increased whenever the fontmap
+     * is changed. It may wrap, but will never have the value 0. Since it can
+     * wrap, never compare it with "less than", always use "not equals".
+     *
+     * The fontmap can only be changed using backend-specific API, like changing
+     * fontmap resolution.
+     *
+     * This can be used to automatically detect changes to a `PangoFontMap`,
+     * like in `PangoContext`.
+     */
     getSerial(): number;
+    /**
+     * List all families for a fontmap.
+     *
+     * Note that the returned families are not in any particular order.
+     *
+     * `PangoFontMap` also implemented the [iface@Gio.ListModel] interface
+     * for enumerating families.
+     * @param families - location to
+     * @param nFamilies - location to store the number of elements in @families
+     */
     listFamilies(families: Ref<FontFamily[]>, nFamilies: Ref<number>): void;
+    /**
+     * Load the font in the fontmap that is the closest match for @desc.
+     * @param context - the `PangoContext` the font will be used with
+     * @param desc - a `PangoFontDescription` describing the font to load
+     */
     loadFont(context: Context, desc: FontDescription): Font | null;
+    /**
+     * Load a set of fonts in the fontmap that can be used to render
+     * a font matching @desc.
+     * @param context - the `PangoContext` the font will be used with
+     * @param desc - a `PangoFontDescription` describing the font to load
+     * @param language - a `PangoLanguage` the fonts will be used for
+     */
     loadFontset(context: Context, desc: FontDescription, language: Language): Fontset | null;
+    /**
+     * Returns a new font that is like @font, except that it is scaled
+     * by @scale, its backend-dependent configuration (e.g. cairo font options)
+     * is replaced by the one in @context, and its variations are replaced
+     * by @variations.
+     *
+     * Note that the scaling here is meant to be linear, so this
+     * scaling can be used to render a font on a hi-dpi display
+     * without changing its optical size.
+     * @param font - a font in @fontmap
+     * @param scale - the scale factor to apply
+     * @param context - a `PangoContext`
+     * @param variations - font variations to use
+     */
     reloadFont(font: Font, scale: number, context?: Context | null, variations?: string | null): Font;
     connect(signal: "notify", handler: (self: FontMap, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/pango/font-map.js

@@ -5,6 +5,13 @@ import { Font } from "./font.js";
 import { FontFamily } from "./font-family.js";
 import { Fontset } from "./fontset.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * A `PangoFontMap` represents the set of fonts available for a
+ * particular rendering system.
+ *
+ * This is a virtual object with implementations being specific to
+ * particular rendering systems.
+ */
 export class FontMap extends GObject.GObject {
     constructor(...args) {
         super(...args);
@@ -20,6 +27,13 @@ export class FontMap extends GObject.GObject {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Loads a font file with one or more fonts into the `PangoFontMap`.
+     *
+     * The added fonts will take precedence over preexisting
+     * fonts with the same name.
+     * @param filename - Path to the font file
+     */
     addFontFile(filename) {
         const error = { value: null };
         const result = call("libpango-1.0.so.0", "pango_font_map_add_font_file", [
@@ -48,6 +62,15 @@ export class FontMap extends GObject.GObject {
         }
         return result;
     }
+    /**
+     * Forces a change in the fontmap, which will cause any `PangoContext`
+     * using this fontmap to change.
+     *
+     * This function is only useful when implementing a new backend
+     * for Pango, something applications won't do. Backends should
+     * call this function if they have attached extra data to the
+     * fontmap and such data is changed.
+     */
     changed() {
         call("libpango-1.0.so.0", "pango_font_map_changed", [
             {
@@ -56,6 +79,17 @@ export class FontMap extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Creates a `PangoContext` connected to @fontmap.
+     *
+     * This is equivalent to [ctor@Pango.Context.new] followed by
+     * [method@Pango.Context.set_font_map].
+     *
+     * If you are using Pango as part of a higher-level system,
+     * that system may have it's own way of create a `PangoContext`.
+     * For instance, the GTK toolkit has, among others,
+     * gtk_widget_get_pango_context(). Use those instead.
+     */
     createContext() {
         const ptr = call("libpango-1.0.so.0", "pango_font_map_create_context", [
             {
@@ -65,6 +99,10 @@ export class FontMap extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Context);
     }
+    /**
+     * Gets a font family by name.
+     * @param name - a family name
+     */
     getFamily(name) {
         const ptr = call("libpango-1.0.so.0", "pango_font_map_get_family", [
             {
@@ -78,6 +116,20 @@ export class FontMap extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, FontFamily);
     }
+    /**
+     * Returns the current serial number of @fontmap.
+     *
+     * The serial number is initialized to an small number larger than zero
+     * when a new fontmap is created and is increased whenever the fontmap
+     * is changed. It may wrap, but will never have the value 0. Since it can
+     * wrap, never compare it with "less than", always use "not equals".
+     *
+     * The fontmap can only be changed using backend-specific API, like changing
+     * fontmap resolution.
+     *
+     * This can be used to automatically detect changes to a `PangoFontMap`,
+     * like in `PangoContext`.
+     */
     getSerial() {
         return call("libpango-1.0.so.0", "pango_font_map_get_serial", [
             {
@@ -86,6 +138,16 @@ export class FontMap extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * List all families for a fontmap.
+     *
+     * Note that the returned families are not in any particular order.
+     *
+     * `PangoFontMap` also implemented the [iface@Gio.ListModel] interface
+     * for enumerating families.
+     * @param families - location to
+     * @param nFamilies - location to store the number of elements in @families
+     */
     listFamilies(families, nFamilies) {
         call("libpango-1.0.so.0", "pango_font_map_list_families", [
             {
@@ -108,6 +170,11 @@ export class FontMap extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Load the font in the fontmap that is the closest match for @desc.
+     * @param context - the `PangoContext` the font will be used with
+     * @param desc - a `PangoFontDescription` describing the font to load
+     */
     loadFont(context, desc) {
         const ptr = call("libpango-1.0.so.0", "pango_font_map_load_font", [
             {
@@ -132,6 +199,13 @@ export class FontMap extends GObject.GObject {
             return null;
         return getObject(ptr, Font);
     }
+    /**
+     * Load a set of fonts in the fontmap that can be used to render
+     * a font matching @desc.
+     * @param context - the `PangoContext` the font will be used with
+     * @param desc - a `PangoFontDescription` describing the font to load
+     * @param language - a `PangoLanguage` the fonts will be used for
+     */
     loadFontset(context, desc, language) {
         const ptr = call("libpango-1.0.so.0", "pango_font_map_load_fontset", [
             {
@@ -165,6 +239,20 @@ export class FontMap extends GObject.GObject {
             return null;
         return getObject(ptr, Fontset);
     }
+    /**
+     * Returns a new font that is like @font, except that it is scaled
+     * by @scale, its backend-dependent configuration (e.g. cairo font options)
+     * is replaced by the one in @context, and its variations are replaced
+     * by @variations.
+     *
+     * Note that the scaling here is meant to be linear, so this
+     * scaling can be used to render a font on a hi-dpi display
+     * without changing its optical size.
+     * @param font - a font in @fontmap
+     * @param scale - the scale factor to apply
+     * @param context - a `PangoContext`
+     * @param variations - font variations to use
+     */
     reloadFont(font, scale, context, variations) {
         const ptr = call("libpango-1.0.so.0", "pango_font_map_reload_font", [
             {

package/dist/generated/pango/font-metrics.d.ts

@@ -1,16 +1,94 @@
+/**
+ * A `PangoFontMetrics` structure holds the overall metric information
+ * for a font.
+ *
+ * The information in a `PangoFontMetrics` structure may be restricted
+ * to a script. The fields of this structure are private to implementations
+ * of a font backend. See the documentation of the corresponding getters
+ * for documentation of their meaning.
+ *
+ * For an overview of the most important metrics, see:
+ */
 export declare class FontMetrics {
     ptr: unknown;
     constructor();
     protected createPtr(_init: Record<string, unknown>): unknown;
+    /**
+     * Gets the approximate character width for a font metrics structure.
+     *
+     * This is merely a representative value useful, for example, for
+     * determining the initial size for a window. Actual characters in
+     * text will be wider and narrower than this.
+     */
     getApproximateCharWidth(): number;
+    /**
+     * Gets the approximate digit width for a font metrics structure.
+     *
+     * This is merely a representative value useful, for example, for
+     * determining the initial size for a window. Actual digits in
+     * text can be wider or narrower than this, though this value
+     * is generally somewhat more accurate than the result of
+     * pango_font_metrics_get_approximate_char_width() for digits.
+     */
     getApproximateDigitWidth(): number;
+    /**
+     * Gets the ascent from a font metrics structure.
+     *
+     * The ascent is the distance from the baseline to the logical top
+     * of a line of text. (The logical top may be above or below the top
+     * of the actual drawn ink. It is necessary to lay out the text to
+     * figure where the ink will be.)
+     */
     getAscent(): number;
+    /**
+     * Gets the descent from a font metrics structure.
+     *
+     * The descent is the distance from the baseline to the logical bottom
+     * of a line of text. (The logical bottom may be above or below the
+     * bottom of the actual drawn ink. It is necessary to lay out the text
+     * to figure where the ink will be.)
+     */
     getDescent(): number;
+    /**
+     * Gets the line height from a font metrics structure.
+     *
+     * The line height is the recommended distance between successive
+     * baselines in wrapped text using this font.
+     *
+     * If the line height is not available, 0 is returned.
+     */
     getHeight(): number;
+    /**
+     * Gets the suggested position to draw the strikethrough.
+     *
+     * The value returned is the distance *above* the
+     * baseline of the top of the strikethrough.
+     */
     getStrikethroughPosition(): number;
+    /**
+     * Gets the suggested thickness to draw for the strikethrough.
+     */
     getStrikethroughThickness(): number;
+    /**
+     * Gets the suggested position to draw the underline.
+     *
+     * The value returned is the distance *above* the baseline of the top
+     * of the underline. Since most fonts have underline positions beneath
+     * the baseline, this value is typically negative.
+     */
     getUnderlinePosition(): number;
+    /**
+     * Gets the suggested thickness to draw for the underline.
+     */
     getUnderlineThickness(): number;
+    /**
+     * Increase the reference count of a font metrics structure by one.
+     */
     ref(): FontMetrics | null;
+    /**
+     * Decrease the reference count of a font metrics structure by one.
+     *
+     * If the result is zero, frees the structure and any associated memory.
+     */
     unref(): void;
 }