@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/pango/context.js

@@ -8,7 +8,30 @@ import { Font } from "./font.js";
 import { FontMap } from "./font-map.js";
 import { Fontset } from "./fontset.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * A `PangoContext` stores global information used to control the
+ * itemization process.
+ *
+ * The information stored by `PangoContext` includes the fontmap used
+ * to look up fonts, and default values such as the default language,
+ * default gravity, or default font.
+ *
+ * To obtain a `PangoContext`, use [method@Pango.FontMap.create_context].
+ */
 export class Context extends GObject.GObject {
+    /**
+     * Creates a new `PangoContext` initialized to default values.
+     *
+     * This function is not particularly useful as it should always
+     * be followed by a [method@Pango.Context.set_font_map] call, and the
+     * function [method@Pango.FontMap.create_context] does these two steps
+     * together and hence users are recommended to use that.
+     *
+     * 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.
+     */
     constructor(...args) {
         super(...args);
     }
@@ -18,6 +41,15 @@ export class Context extends GObject.GObject {
             borrowed: false,
         });
     }
+    /**
+     * Forces a change in the context, which will cause any `PangoLayout`
+     * using this context to re-layout.
+     *
+     * 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 context
+     * and such data is changed.
+     */
     changed() {
         call("libpango-1.0.so.0", "pango_context_changed", [
             {
@@ -26,6 +58,11 @@ export class Context extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Retrieves the base direction for the context.
+     *
+     * See [method@Pango.Context.set_base_dir].
+     */
     getBaseDir() {
         return call("libpango-1.0.so.0", "pango_context_get_base_dir", [
             {
@@ -34,6 +71,11 @@ export class Context extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Retrieves the base gravity for the context.
+     *
+     * See [method@Pango.Context.set_base_gravity].
+     */
     getBaseGravity() {
         return call("libpango-1.0.so.0", "pango_context_get_base_gravity", [
             {
@@ -42,6 +84,9 @@ export class Context extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Retrieve the default font description for the context.
+     */
     getFontDescription() {
         const ptr = call("libpango-1.0.so.0", "pango_context_get_font_description", [
             {
@@ -58,6 +103,9 @@ export class Context extends GObject.GObject {
             return null;
         return getObject(ptr, FontDescription);
     }
+    /**
+     * Gets the `PangoFontMap` used to look up fonts for this context.
+     */
     getFontMap() {
         const ptr = call("libpango-1.0.so.0", "pango_context_get_font_map", [
             {
@@ -69,6 +117,14 @@ export class Context extends GObject.GObject {
             return null;
         return getObject(ptr, FontMap);
     }
+    /**
+     * Retrieves the gravity for the context.
+     *
+     * This is similar to [method@Pango.Context.get_base_gravity],
+     * except for when the base gravity is %PANGO_GRAVITY_AUTO for
+     * which [func@Pango.Gravity.get_for_matrix] is used to return the
+     * gravity from the current context matrix.
+     */
     getGravity() {
         return call("libpango-1.0.so.0", "pango_context_get_gravity", [
             {
@@ -77,6 +133,11 @@ export class Context extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Retrieves the gravity hint for the context.
+     *
+     * See [method@Pango.Context.set_gravity_hint] for details.
+     */
     getGravityHint() {
         return call("libpango-1.0.so.0", "pango_context_get_gravity_hint", [
             {
@@ -85,6 +146,9 @@ export class Context extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Retrieves the global language tag for the context.
+     */
     getLanguage() {
         const ptr = call("libpango-1.0.so.0", "pango_context_get_language", [
             {
@@ -99,6 +163,12 @@ export class Context extends GObject.GObject {
         });
         return getObject(ptr, Language);
     }
+    /**
+     * Gets the transformation matrix that will be applied when
+     * rendering with this context.
+     *
+     * See [method@Pango.Context.set_matrix].
+     */
     getMatrix() {
         const ptr = call("libpango-1.0.so.0", "pango_context_get_matrix", [
             {
@@ -115,6 +185,21 @@ export class Context extends GObject.GObject {
             return null;
         return getObject(ptr, Matrix);
     }
+    /**
+     * Get overall metric information for a particular font description.
+     *
+     * Since the metrics may be substantially different for different scripts,
+     * a language tag can be provided to indicate that the metrics should be
+     * retrieved that correspond to the script(s) used by that language.
+     *
+     * The `PangoFontDescription` is interpreted in the same way as by [func@itemize],
+     * and the family name may be a comma separated list of names. If characters
+     * from multiple of these families would be used to render the string, then
+     * the returned fonts would be a composite of the metrics for the fonts loaded
+     * for the individual families.
+     * @param desc - a `PangoFontDescription` structure. %NULL means that the
+     * @param language - language tag used to determine which script to get
+     */
     getMetrics(desc, language) {
         const ptr = call("libpango-1.0.so.0", "pango_context_get_metrics", [
             {
@@ -149,6 +234,10 @@ export class Context extends GObject.GObject {
         });
         return getObject(ptr, FontMetrics);
     }
+    /**
+     * Returns whether font rendering with this context should
+     * round glyph positions and widths.
+     */
     getRoundGlyphPositions() {
         return call("libpango-1.0.so.0", "pango_context_get_round_glyph_positions", [
             {
@@ -157,6 +246,20 @@ export class Context extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns the current serial number of @context.
+     *
+     * The serial number is initialized to an small number larger than zero
+     * when a new context is created and is increased whenever the context
+     * is changed using any of the setter functions, or the `PangoFontMap` it
+     * uses to find fonts has changed. The serial may wrap, but will never
+     * have the value 0. Since it can wrap, never compare it with "less than",
+     * always use "not equals".
+     *
+     * This can be used to automatically detect changes to a `PangoContext`,
+     * and is only useful when implementing objects that need update when their
+     * `PangoContext` changes, like `PangoLayout`.
+     */
     getSerial() {
         return call("libpango-1.0.so.0", "pango_context_get_serial", [
             {
@@ -165,6 +268,11 @@ export class Context extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * List all families for a context.
+     * @param families - location
+     * @param nFamilies - location to store the number of elements in @descs
+     */
     listFamilies(families, nFamilies) {
         call("libpango-1.0.so.0", "pango_context_list_families", [
             {
@@ -187,6 +295,11 @@ export class Context extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Loads the font in one of the fontmaps in the context
+     * that is the closest match for @desc.
+     * @param desc - a `PangoFontDescription` describing the font to load
+     */
     loadFont(desc) {
         const ptr = call("libpango-1.0.so.0", "pango_context_load_font", [
             {
@@ -207,6 +320,12 @@ export class Context extends GObject.GObject {
             return null;
         return getObject(ptr, Font);
     }
+    /**
+     * Load a set of fonts in the context that can be used to render
+     * a font matching @desc.
+     * @param desc - a `PangoFontDescription` describing the fonts to load
+     * @param language - a `PangoLanguage` the fonts will be used for
+     */
     loadFontset(desc, language) {
         const ptr = call("libpango-1.0.so.0", "pango_context_load_fontset", [
             {
@@ -236,6 +355,17 @@ export class Context extends GObject.GObject {
             return null;
         return getObject(ptr, Fontset);
     }
+    /**
+     * Sets the base direction for the context.
+     *
+     * The base direction is used in applying the Unicode bidirectional
+     * algorithm; if the `direction` is %PANGO_DIRECTION_LTR or
+     * %PANGO_DIRECTION_RTL, then the value will be used as the paragraph
+     * direction in the Unicode bidirectional algorithm. A value of
+     * %PANGO_DIRECTION_WEAK_LTR or %PANGO_DIRECTION_WEAK_RTL is used only
+     * for paragraphs that do not contain any strong characters themselves.
+     * @param direction - the new base direction
+     */
     setBaseDir(direction) {
         call("libpango-1.0.so.0", "pango_context_set_base_dir", [
             {
@@ -248,6 +378,12 @@ export class Context extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the base gravity for the context.
+     *
+     * The base gravity is used in laying vertical text out.
+     * @param gravity - the new base gravity
+     */
     setBaseGravity(gravity) {
         call("libpango-1.0.so.0", "pango_context_set_base_gravity", [
             {
@@ -260,6 +396,10 @@ export class Context extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Set the default font description for the context
+     * @param desc - the new pango font description
+     */
     setFontDescription(desc) {
         call("libpango-1.0.so.0", "pango_context_set_font_description", [
             {
@@ -278,6 +418,15 @@ export class Context extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the font map to be searched when fonts are looked-up
+     * in this context.
+     *
+     * This is only for internal use by Pango backends, a `PangoContext`
+     * obtained via one of the recommended methods should already have a
+     * suitable font map.
+     * @param fontMap - the `PangoFontMap` to set.
+     */
     setFontMap(fontMap) {
         call("libpango-1.0.so.0", "pango_context_set_font_map", [
             {
@@ -291,6 +440,15 @@ export class Context extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the gravity hint for the context.
+     *
+     * The gravity hint is used in laying vertical text out, and
+     * is only relevant if gravity of the context as returned by
+     * [method@Pango.Context.get_gravity] is set to %PANGO_GRAVITY_EAST
+     * or %PANGO_GRAVITY_WEST.
+     * @param hint - the new gravity hint
+     */
     setGravityHint(hint) {
         call("libpango-1.0.so.0", "pango_context_set_gravity_hint", [
             {
@@ -303,6 +461,13 @@ export class Context extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the global language tag for the context.
+     *
+     * The default language for the locale of the running process
+     * can be found using [func@Pango.Language.get_default].
+     * @param language - the new language tag.
+     */
     setLanguage(language) {
         call("libpango-1.0.so.0", "pango_context_set_language", [
             {
@@ -321,6 +486,17 @@ export class Context extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the transformation matrix that will be applied when rendering
+     * with this context.
+     *
+     * Note that reported metrics are in the user space coordinates before
+     * the application of the matrix, not device-space coordinates after the
+     * application of the matrix. So, they don't scale with the matrix, though
+     * they may change slightly for different matrices, depending on how the
+     * text is fit to the pixel grid.
+     * @param matrix - a `PangoMatrix`, or %NULL to unset any existing
+     */
     setMatrix(matrix) {
         call("libpango-1.0.so.0", "pango_context_set_matrix", [
             {
@@ -339,6 +515,18 @@ export class Context extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether font rendering with this context should
+     * round glyph positions and widths to integral positions,
+     * in device units.
+     *
+     * This is useful when the renderer can't handle subpixel
+     * positioning of glyphs.
+     *
+     * The default value is to round glyph positions, to remain
+     * compatible with previous Pango behavior.
+     * @param roundPositions - whether to round glyph positions
+     */
     setRoundGlyphPositions(roundPositions) {
         call("libpango-1.0.so.0", "pango_context_set_round_glyph_positions", [
             {

package/dist/generated/pango/coverage.d.ts

@@ -1,16 +1,66 @@
 import { Ref } from "@gtkx/native";
 import { CoverageLevel } from "./enums.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * A `PangoCoverage` structure is a map from Unicode characters
+ * to [enum@Pango.CoverageLevel] values.
+ *
+ * It is often necessary in Pango to determine if a particular
+ * font can represent a particular character, and also how well
+ * it can represent that character. The `PangoCoverage` is a data
+ * structure that is used to represent that information. It is an
+ * opaque structure with no public fields.
+ */
 export declare class Coverage extends GObject.GObject {
+    /**
+     * Create a new `PangoCoverage`
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Convert data generated from [method@Pango.Coverage.to_bytes]
+     * back to a `PangoCoverage`.
+     * @param bytes - binary data
+     * @param nBytes - the size of `bytes` in bytes
+     */
     static fromBytes(bytes: number[], nBytes: number): Coverage;
+    /**
+     * Copy an existing `PangoCoverage`.
+     */
     copy(): Coverage;
+    /**
+     * Determine whether a particular index is covered by @coverage.
+     * @param index_ - the index to check
+     */
     get(index_: number): CoverageLevel;
+    /**
+     * Set the coverage for each index in `coverage` to be the max (better)
+     * value of the current coverage for the index and the coverage for
+     * the corresponding index in @other.
+     * @param other - another `PangoCoverage`
+     */
     max(other: Coverage): void;
+    /**
+     * Increase the reference count on the `PangoCoverage` by one.
+     */
     ref(): Coverage;
+    /**
+     * Modify a particular index within @coverage
+     * @param index_ - the index to modify
+     * @param level - the new level for @index_
+     */
     set(index_: number, level: CoverageLevel): void;
+    /**
+     * Convert a `PangoCoverage` structure into a flat binary format.
+     * @param bytes - location to store result (must be freed with g_free())
+     * @param nBytes - location to store size of result
+     */
     toBytes(bytes: Ref<number[]>, nBytes: Ref<number>): void;
+    /**
+     * Decrease the reference count on the `PangoCoverage` by one.
+     *
+     * If the result is zero, free the coverage and all associated memory.
+     */
     unref(): void;
     connect(signal: "notify", handler: (self: Coverage, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/pango/coverage.js

@@ -1,7 +1,20 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
+/**
+ * A `PangoCoverage` structure is a map from Unicode characters
+ * to [enum@Pango.CoverageLevel] values.
+ *
+ * It is often necessary in Pango to determine if a particular
+ * font can represent a particular character, and also how well
+ * it can represent that character. The `PangoCoverage` is a data
+ * structure that is used to represent that information. It is an
+ * opaque structure with no public fields.
+ */
 export class Coverage extends GObject.GObject {
+    /**
+     * Create a new `PangoCoverage`
+     */
     constructor(...args) {
         super(...args);
     }
@@ -11,6 +24,12 @@ export class Coverage extends GObject.GObject {
             borrowed: false,
         });
     }
+    /**
+     * Convert data generated from [method@Pango.Coverage.to_bytes]
+     * back to a `PangoCoverage`.
+     * @param bytes - binary data
+     * @param nBytes - the size of `bytes` in bytes
+     */
     static fromBytes(bytes, nBytes) {
         const ptr = call("libpango-1.0.so.0", "pango_coverage_from_bytes", [
             {
@@ -27,6 +46,9 @@ export class Coverage extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Coverage);
     }
+    /**
+     * Copy an existing `PangoCoverage`.
+     */
     copy() {
         const ptr = call("libpango-1.0.so.0", "pango_coverage_copy", [
             {
@@ -36,6 +58,10 @@ export class Coverage extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Coverage);
     }
+    /**
+     * Determine whether a particular index is covered by @coverage.
+     * @param index_ - the index to check
+     */
     get(index_) {
         return call("libpango-1.0.so.0", "pango_coverage_get", [
             {
@@ -48,6 +74,12 @@ export class Coverage extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Set the coverage for each index in `coverage` to be the max (better)
+     * value of the current coverage for the index and the coverage for
+     * the corresponding index in @other.
+     * @param other - another `PangoCoverage`
+     */
     max(other) {
         call("libpango-1.0.so.0", "pango_coverage_max", [
             {
@@ -60,6 +92,9 @@ export class Coverage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Increase the reference count on the `PangoCoverage` by one.
+     */
     ref() {
         const ptr = call("libpango-1.0.so.0", "pango_coverage_ref", [
             {
@@ -69,6 +104,11 @@ export class Coverage extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Coverage);
     }
+    /**
+     * Modify a particular index within @coverage
+     * @param index_ - the index to modify
+     * @param level - the new level for @index_
+     */
     set(index_, level) {
         call("libpango-1.0.so.0", "pango_coverage_set", [
             {
@@ -85,6 +125,11 @@ export class Coverage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Convert a `PangoCoverage` structure into a flat binary format.
+     * @param bytes - location to store result (must be freed with g_free())
+     * @param nBytes - location to store size of result
+     */
     toBytes(bytes, nBytes) {
         call("libpango-1.0.so.0", "pango_coverage_to_bytes", [
             {
@@ -110,6 +155,11 @@ export class Coverage extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Decrease the reference count on the `PangoCoverage` by one.
+     *
+     * If the result is zero, free the coverage and all associated memory.
+     */
     unref() {
         call("libpango-1.0.so.0", "pango_coverage_unref", [
             {