@girs/gobject-2.0 2.84.4-4.0.0-beta.35 → 2.86.0-4.0.0-beta.37

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/gobject-2.0)
 
 
-GJS TypeScript type definitions for GObject-2.0, generated from library version 2.84.4 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.35.
+GJS TypeScript type definitions for GObject-2.0, generated from library version 2.86.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.37.
 
 ## Install
 

package/gobject-2.0.d.ts

@@ -449,15 +449,29 @@ export namespace GObject {
      */
     const VALUE_COLLECT_FORMAT_MAX_LENGTH: number;
     /**
-     * For string values, indicates that the string contained is canonical and will
-     * exist for the duration of the process. See g_value_set_interned_string().
+     * Flag to indicate that a string in a [struct`GObject`.Value] is canonical and
+     * will exist for the duration of the process.
+     *
+     * See [method`GObject`.Value.set_interned_string].
+     *
+     * This flag should be checked by implementations of
+     * [callback`GObject`.TypeValueFreeFunc], [callback`GObject`.TypeValueCollectFunc]
+     * and [callback`GObject`.TypeValueLCopyFunc].
      */
     const VALUE_INTERNED_STRING: number;
     /**
-     * If passed to G_VALUE_COLLECT(), allocated data won't be copied
-     * but used verbatim. This does not affect ref-counted types like
-     * objects. This does not affect usage of g_value_copy(), the data will
+     * Flag to indicate that allocated data in a [struct`GObject`.Value] shouldn’t be
+     * copied.
+     *
+     * If passed to [func`GObject`.VALUE_COLLECT], allocated data won’t be copied
+     * but used verbatim. This does not affect ref-counted types like objects.
+     *
+     * This does not affect usage of [method`GObject`.Value.copy]: the data will
      * be copied if it is not ref-counted.
+     *
+     * This flag should be checked by implementations of
+     * [callback`GObject`.TypeValueFreeFunc], [callback`GObject`.TypeValueCollectFunc]
+     * and [callback`GObject`.TypeValueLCopyFunc].
      */
     const VALUE_NOCOPY_CONTENTS: number;
     /**
@@ -951,9 +965,9 @@ export namespace GObject {
      * ```
      *
      * @param g_enum_type the type identifier of the type being completed
-     * @param const_values An array of #GEnumValue structs for the possible  enumeration values. The array is terminated by a struct with all  members being 0.
+     * @param const_values An array of #GEnumValue  structs for the possible enumeration values. The array is terminated  by a struct with all members being 0.
      */
-    function enum_complete_type_info(g_enum_type: GType, const_values: EnumValue): TypeInfo;
+    function enum_complete_type_info(g_enum_type: GType, const_values: EnumValue[]): TypeInfo;
     /**
      * Returns the #GEnumValue for a value.
      * @param enum_class a #GEnumClass
@@ -1001,9 +1015,9 @@ export namespace GObject {
      * function of a #GTypePlugin implementation, see the example for
      * g_enum_complete_type_info() above.
      * @param g_flags_type the type identifier of the type being completed
-     * @param const_values An array of #GFlagsValue structs for the possible  enumeration values. The array is terminated by a struct with all  members being 0.
+     * @param const_values An array of #GFlagsValue  structs for the possible enumeration values. The array is terminated  by a struct with all members being 0.
      */
-    function flags_complete_type_info(g_flags_type: GType, const_values: FlagsValue): TypeInfo;
+    function flags_complete_type_info(g_flags_type: GType, const_values: FlagsValue[]): TypeInfo;
     /**
      * Returns the first #GFlagsValue which is set in `value`.
      * @param flags_class a #GFlagsClass
@@ -2144,15 +2158,6 @@ export namespace GObject {
      * @returns the   #GTypeClass structure for the given type ID or %NULL if the class   does not currently exist or is dynamically loaded
      */
     function type_class_peek_static(type: GType): TypeClass | null;
-    /**
-     * Increments the reference count of the class structure belonging to
-     * `type`.
-     *
-     * This function will demand-create the class if it doesn't exist already.
-     * @param type type ID of a classed type
-     * @returns the #GTypeClass   structure for the given type ID
-     */
-    function type_class_ref(type: GType): TypeClass;
     /**
      * Returns the default interface vtable for the given `g_type`.
      *
@@ -2178,21 +2183,6 @@ export namespace GObject {
      * @returns the default   vtable for the interface, or %NULL if the type is not currently   in use
      */
     function type_default_interface_peek(g_type: GType): TypeInterface;
-    /**
-     * Increments the reference count for the interface type `g_type,`
-     * and returns the default interface vtable for the type.
-     *
-     * If the type is not currently in use, then the default vtable
-     * for the type will be created and initialized by calling
-     * the base interface init and default vtable init functions for
-     * the type (the `base_init` and `class_init` members of #GTypeInfo).
-     * Calling g_type_default_interface_ref() is useful when you
-     * want to make sure that signals and properties for an interface
-     * have been installed.
-     * @param g_type an interface type
-     * @returns the default   vtable for the interface; call g_type_default_interface_unref()   when you are done using the interface.
-     */
-    function type_default_interface_ref(g_type: GType): TypeInterface;
     /**
      * Decrements the reference count for the type corresponding to the
      * interface default vtable `g_iface`.
@@ -2492,21 +2482,23 @@ export namespace GObject {
     function type_set_qdata(type: GType, quark: GLib.Quark, data?: any | null): void;
     function type_test_flags(type: GType, flags: number): boolean;
     /**
-     * Returns whether a #GValue of type `src_type` can be copied into
-     * a #GValue of type `dest_type`.
-     * @param src_type source type to be copied.
-     * @param dest_type destination type for copying.
-     * @returns %TRUE if g_value_copy() is possible with @src_type and @dest_type.
+     * Checks whether a [method`GObject`.Value.copy] is able to copy values of type
+     * `src_type` into values of type `dest_type`.
+     * @param src_type source type to be copied
+     * @param dest_type destination type for copying
+     * @returns true if the copy is possible; false otherwise
      */
     function value_type_compatible(src_type: GType, dest_type: GType): boolean;
     /**
-     * Check whether g_value_transform() is able to transform values
-     * of type `src_type` into values of type `dest_type`. Note that for
-     * the types to be transformable, they must be compatible or a
-     * transformation function must be registered.
-     * @param src_type Source type.
-     * @param dest_type Target type.
-     * @returns %TRUE if the transformation is possible, %FALSE otherwise.
+     * Checks whether [method`GObject`.Value.transform] is able to transform values
+     * of type `src_type` into values of type `dest_type`.
+     *
+     * Note that for the types to be transformable, they must be compatible or a
+     * transformation function must be registered using
+     * [func`GObject`.Value.register_transform_func].
+     * @param src_type source type
+     * @param dest_type target type
+     * @returns true if the transformation is possible; false otherwise
      */
     function value_type_transformable(src_type: GType, dest_type: GType): boolean;
     function variant_get_gtype(): GType;
@@ -4860,10 +4852,10 @@ export namespace GObject {
          * Since 2.56 if `module` is %NULL this will call g_type_register_static()
          * instead. This can be used when making a static build of the module.
          * @param name name for the type
-         * @param const_static_values an array of #GEnumValue structs for the                       possible enumeration values. The array is                       terminated by a struct with all members being                       0.
+         * @param const_static_values an array of #GEnumValue  structs for the possible enumeration values. The array is terminated by a  struct with all members being 0.
          * @returns the new or existing type ID
          */
-        register_enum(name: string, const_static_values: EnumValue): GType;
+        register_enum(name: string, const_static_values: EnumValue[]): GType;
         /**
          * Looks up or registers a flags type that is implemented with a particular
          * type plugin. If a type with name `type_name` was previously registered,
@@ -4876,10 +4868,10 @@ export namespace GObject {
          * Since 2.56 if `module` is %NULL this will call g_type_register_static()
          * instead. This can be used when making a static build of the module.
          * @param name name for the type
-         * @param const_static_values an array of #GFlagsValue structs for the                       possible flags values. The array is                       terminated by a struct with all members being                       0.
+         * @param const_static_values an array of #GFlagsValue  structs for the possible flags values. The array is terminated by a struct  with all members being 0.
          * @returns the new or existing type ID
          */
-        register_flags(name: string, const_static_values: FlagsValue): GType;
+        register_flags(name: string, const_static_values: FlagsValue[]): GType;
         /**
          * Looks up or registers a type that is implemented with a particular
          * type plugin. If a type with name `type_name` was previously registered,
@@ -6143,14 +6135,6 @@ export namespace GObject {
          * @param type type ID of a classed type
          */
         static peek_static(type: GType): TypeClass | null;
-        /**
-         * Increments the reference count of the class structure belonging to
-         * `type`.
-         *
-         * This function will demand-create the class if it doesn't exist already.
-         * @param type type ID of a classed type
-         */
-        static ref(type: GType): TypeClass;
 
         // Methods
 
@@ -6451,14 +6435,23 @@ export namespace GObject {
     /**
      * An opaque structure used to hold different types of values.
      *
+     * Before it can be used, a `GValue` has to be initialized to a specific type by
+     * calling [method`GObject`.Value.init] on it.
+     *
+     * Many types which are stored within a `GValue` need to allocate data on the
+     * heap, so [method`GObject`.Value.unset] must always be called on a `GValue` to
+     * free any such data once you’re finished with the `GValue`, even if the
+     * `GValue` itself is stored on the stack.
+     *
      * The data within the structure has protected scope: it is accessible only
-     * to functions within a #GTypeValueTable structure, or implementations of
-     * the g_value_*() API. That is, code portions which implement new fundamental
-     * types.
+     * to functions within a [struct`GObject`.TypeValueTable] structure, or
+     * implementations of the `g_value_*()` API. That is, code which implements new
+     * fundamental types.
      *
-     * #GValue users cannot make any assumptions about how data is stored
+     * `GValue` users cannot make any assumptions about how data is stored
      * within the 2 element `data` union, and the `g_type` member should
-     * only be accessed through the G_VALUE_TYPE() macro.
+     * only be accessed through the [func`GObject`.VALUE_TYPE] macro and related
+     * macros.
      */
     class Value {
         static $gtype: GType<Value>;
@@ -6470,19 +6463,21 @@ export namespace GObject {
         // Static methods
 
         /**
-         * Returns whether a #GValue of type `src_type` can be copied into
-         * a #GValue of type `dest_type`.
-         * @param src_type source type to be copied.
-         * @param dest_type destination type for copying.
+         * Checks whether a [method`GObject`.Value.copy] is able to copy values of type
+         * `src_type` into values of type `dest_type`.
+         * @param src_type source type to be copied
+         * @param dest_type destination type for copying
          */
         static type_compatible(src_type: GType, dest_type: GType): boolean;
         /**
-         * Check whether g_value_transform() is able to transform values
-         * of type `src_type` into values of type `dest_type`. Note that for
-         * the types to be transformable, they must be compatible or a
-         * transformation function must be registered.
-         * @param src_type Source type.
-         * @param dest_type Target type.
+         * Checks whether [method`GObject`.Value.transform] is able to transform values
+         * of type `src_type` into values of type `dest_type`.
+         *
+         * Note that for the types to be transformable, they must be compatible or a
+         * transformation function must be registered using
+         * [func`GObject`.Value.register_transform_func].
+         * @param src_type source type
+         * @param dest_type target type
          */
         static type_transformable(src_type: GType, dest_type: GType): boolean;
 
@@ -6490,7 +6485,7 @@ export namespace GObject {
 
         /**
          * Copies the value of `src_value` into `dest_value`.
-         * @param dest_value An initialized #GValue structure of the same type as @src_value.
+         * @param dest_value an initialized [struct@GObject.Value] structure of the same type   as @src_value
          */
         copy(dest_value: Value | any): void;
         /**
@@ -6513,8 +6508,9 @@ export namespace GObject {
         dup_variant(): GLib.Variant | null;
         /**
          * Determines if `value` will fit inside the size of a pointer value.
+         *
          * This is an internal function introduced mainly for C marshallers.
-         * @returns %TRUE if @value will fit inside a pointer value.
+         * @returns true if @value will fit inside a pointer value; false otherwise
          */
         fits_pointer(): boolean;
         /**
@@ -6626,33 +6622,51 @@ export namespace GObject {
          */
         get_variant(): GLib.Variant | null;
         /**
-         * Initializes `value` with the default value of `type`.
-         * @param g_type Type the #GValue should hold values of.
-         * @returns the #GValue structure that has been passed in
+         * Initializes `value` to store values of the given `type,` and sets its value
+         * to the default for `type`.
+         *
+         * This must be called before any other methods on a [struct`GObject`.Value], so
+         * the value knows what type it’s meant to store.
+         *
+         * ```c
+         *   GValue value = G_VALUE_INIT;
+         *
+         *   g_value_init (&value, SOME_G_TYPE);
+         *   …
+         *   g_value_unset (&value);
+         * ```
+         * @param g_type type the [struct@GObject.Value] should hold values of
+         * @returns the [struct@GObject.Value] structure that has been   passed in
          */
         init(g_type: GType): unknown;
         /**
-         * Initializes and sets `value` from an instantiatable type via the
-         * value_table's collect_value() function.
+         * Initializes and sets `value` from an instantiatable type.
+         *
+         * This calls the [callback`GObject`.TypeValueCollectFunc] function for the type
+         * the [struct`GObject`.Value] contains.
          *
          * Note: The `value` will be initialised with the exact type of
-         * `instance`.  If you wish to set the `value'`s type to a different GType
-         * (such as a parent class GType), you need to manually call
-         * g_value_init() and g_value_set_instance().
+         * `instance`.  If you wish to set the `value’`s type to a different
+         * [type`GObject`.Type] (such as a parent class type), you need to manually call
+         * [method`GObject`.Value.init] and [method`GObject`.Value.set_instance].
          * @param instance the instance
          */
         init_from_instance(instance: TypeInstance): void;
         /**
-         * Returns the value contents as pointer. This function asserts that
-         * g_value_fits_pointer() returned %TRUE for the passed in value.
+         * Returns the value contents as a pointer.
+         *
+         * This function asserts that [method`GObject`.Value.fits_pointer] returned true
+         * for the passed in value.
+         *
          * This is an internal function introduced mainly for C marshallers.
-         * @returns the value contents as pointer
+         * @returns the value contents as a pointer
          */
         peek_pointer(): any | null;
         /**
          * Clears the current value in `value` and resets it to the default value
-         * (as if the value had just been initialized).
-         * @returns the #GValue structure that has been passed in
+         * (as if the value had just been initialized using
+         * [method`GObject`.Value.init]).
+         * @returns the [struct@GObject.Value] structure that has been passed in
          */
         reset(): unknown;
         /**
@@ -6662,7 +6676,7 @@ export namespace GObject {
         set_boolean(v_boolean: boolean): void;
         /**
          * Set the contents of a %G_TYPE_BOXED derived #GValue to `v_boxed`.
-         * @param v_boxed boxed value to be set
+         * @param v_boxed caller-owned boxed object to be duplicated for the #GValue
          */
         set_boxed(v_boxed?: any | null): void;
         /**
@@ -6701,8 +6715,10 @@ export namespace GObject {
          */
         set_gtype(v_gtype: GType): void;
         /**
-         * Sets `value` from an instantiatable type via the
-         * value_table's collect_value() function.
+         * Sets `value` from an instantiatable type.
+         *
+         * This calls the [callback`GObject`.TypeValueCollectFunc] function for the type
+         * the [struct`GObject`.Value] contains.
          * @param instance the instance
          */
         set_instance(instance?: any | null): void;
@@ -6855,21 +6871,27 @@ export namespace GObject {
         take_variant(variant?: GLib.Variant | null): void;
         /**
          * Tries to cast the contents of `src_value` into a type appropriate
-         * to store in `dest_value,` e.g. to transform a %G_TYPE_INT value
-         * into a %G_TYPE_FLOAT value. Performing transformations between
-         * value types might incur precision lossage. Especially
-         * transformations into strings might reveal seemingly arbitrary
-         * results and shouldn't be relied upon for production code (such
-         * as rcfile value or object property serialization).
-         * @param dest_value Target value.
-         * @returns Whether a transformation rule was found and could be applied.  Upon failing transformations, @dest_value is left untouched.
+         * to store in `dest_value`.
+         *
+         * If a transformation is not possible, `dest_value` is not modified.
+         *
+         * For example, this could transform a `G_TYPE_INT` value into a `G_TYPE_FLOAT`
+         * value.
+         *
+         * Performing transformations between value types might incur precision loss.
+         * Especially transformations into strings might reveal seemingly arbitrary
+         * results and the format of particular transformations to strings is not
+         * guaranteed over time.
+         * @param dest_value target value
+         * @returns true on success; false otherwise
          */
         transform(dest_value: Value | any): boolean;
         /**
-         * Clears the current value in `value` (if any) and "unsets" the type,
-         * this releases all resources associated with this GValue. An unset
-         * value is the same as an uninitialized (zero-filled) #GValue
-         * structure.
+         * Clears the current value in `value` (if any) and ‘unsets’ the type.
+         *
+         * This releases all resources associated with this [struct`GObject`.Value]. An
+         * unset value is the same as a cleared (zero-filled)
+         * [struct`GObject`.Value] structure set to `G_VALUE_INIT`.
          */
         unset(): void;
     }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@girs/gobject-2.0",
-    "version": "2.84.4-4.0.0-beta.35",
-    "description": "GJS TypeScript type definitions for GObject-2.0, generated from library version 2.84.4",
+    "version": "2.86.0-4.0.0-beta.37",
+    "description": "GJS TypeScript type definitions for GObject-2.0, generated from library version 2.86.0",
     "type": "module",
     "module": "gobject-2.0.js",
     "main": "gobject-2.0.js",
@@ -31,8 +31,8 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "4.0.0-beta.35",
-      "@girs/glib-2.0": "2.84.4-4.0.0-beta.35"    },
+      "@girs/gjs": "4.0.0-beta.37",
+      "@girs/glib-2.0": "2.86.0-4.0.0-beta.37"    },
     "devDependencies": {
       "typescript": "*"
     },
@@ -41,7 +41,7 @@
     "license": "MIT",
     "repository": {
       "type": "git",
-      "url": "https://github.com/gjsify/types.git"
+      "url": "git+https://github.com/gjsify/types.git"
     },
     "bugs": {
       "url": "https://github.com/gjsify/ts-for-gir/issues"