@girs/gobject-2.0 2.86.0-4.0.0-beta.38 → 2.86.4-4.0.0-beta.40

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +1 -1
  2. package/gobject-2.0.d.ts +128 -229
  3. package/package.json +4 -4
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/gobject-2.0)
6
6
 
7
7
 
8
- 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.38.
8
+ GJS TypeScript type definitions for GObject-2.0, generated from library version 2.86.4 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.40.
9
9
 
10
10
  ## Install
11
11
 
package/gobject-2.0.d.ts CHANGED
@@ -449,15 +449,29 @@ export namespace GObject {
449
449
  */
450
450
  const VALUE_COLLECT_FORMAT_MAX_LENGTH: number;
451
451
  /**
452
- * For string values, indicates that the string contained is canonical and will
453
- * exist for the duration of the process. See g_value_set_interned_string().
452
+ * Flag to indicate that a string in a [struct`GObject`.Value] is canonical and
453
+ * will exist for the duration of the process.
454
+ *
455
+ * See [method`GObject`.Value.set_interned_string].
456
+ *
457
+ * This flag should be checked by implementations of
458
+ * [callback`GObject`.TypeValueFreeFunc], [callback`GObject`.TypeValueCollectFunc]
459
+ * and [callback`GObject`.TypeValueLCopyFunc].
454
460
  */
455
461
  const VALUE_INTERNED_STRING: number;
456
462
  /**
457
- * If passed to G_VALUE_COLLECT(), allocated data won't be copied
458
- * but used verbatim. This does not affect ref-counted types like
459
- * objects. This does not affect usage of g_value_copy(), the data will
463
+ * Flag to indicate that allocated data in a [struct`GObject`.Value] shouldn’t be
464
+ * copied.
465
+ *
466
+ * If passed to [func`GObject`.VALUE_COLLECT], allocated data won’t be copied
467
+ * but used verbatim. This does not affect ref-counted types like objects.
468
+ *
469
+ * This does not affect usage of [method`GObject`.Value.copy]: the data will
460
470
  * be copied if it is not ref-counted.
471
+ *
472
+ * This flag should be checked by implementations of
473
+ * [callback`GObject`.TypeValueFreeFunc], [callback`GObject`.TypeValueCollectFunc]
474
+ * and [callback`GObject`.TypeValueLCopyFunc].
461
475
  */
462
476
  const VALUE_NOCOPY_CONTENTS: number;
463
477
  /**
@@ -951,9 +965,9 @@ export namespace GObject {
951
965
  * ```
952
966
  *
953
967
  * @param g_enum_type the type identifier of the type being completed
954
- * @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.
968
+ * @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.
955
969
  */
956
- function enum_complete_type_info(g_enum_type: GType, const_values: EnumValue): TypeInfo;
970
+ function enum_complete_type_info(g_enum_type: GType, const_values: EnumValue[]): TypeInfo;
957
971
  /**
958
972
  * Returns the #GEnumValue for a value.
959
973
  * @param enum_class a #GEnumClass
@@ -1001,9 +1015,9 @@ export namespace GObject {
1001
1015
  * function of a #GTypePlugin implementation, see the example for
1002
1016
  * g_enum_complete_type_info() above.
1003
1017
  * @param g_flags_type the type identifier of the type being completed
1004
- * @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.
1018
+ * @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.
1005
1019
  */
1006
- function flags_complete_type_info(g_flags_type: GType, const_values: FlagsValue): TypeInfo;
1020
+ function flags_complete_type_info(g_flags_type: GType, const_values: FlagsValue[]): TypeInfo;
1007
1021
  /**
1008
1022
  * Returns the first #GFlagsValue which is set in `value`.
1009
1023
  * @param flags_class a #GFlagsClass
@@ -2492,21 +2506,23 @@ export namespace GObject {
2492
2506
  function type_set_qdata(type: GType, quark: GLib.Quark, data?: any | null): void;
2493
2507
  function type_test_flags(type: GType, flags: number): boolean;
2494
2508
  /**
2495
- * Returns whether a #GValue of type `src_type` can be copied into
2496
- * a #GValue of type `dest_type`.
2497
- * @param src_type source type to be copied.
2498
- * @param dest_type destination type for copying.
2499
- * @returns %TRUE if g_value_copy() is possible with @src_type and @dest_type.
2509
+ * Checks whether a [method`GObject`.Value.copy] is able to copy values of type
2510
+ * `src_type` into values of type `dest_type`.
2511
+ * @param src_type source type to be copied
2512
+ * @param dest_type destination type for copying
2513
+ * @returns true if the copy is possible; false otherwise
2500
2514
  */
2501
2515
  function value_type_compatible(src_type: GType, dest_type: GType): boolean;
2502
2516
  /**
2503
- * Check whether g_value_transform() is able to transform values
2504
- * of type `src_type` into values of type `dest_type`. Note that for
2505
- * the types to be transformable, they must be compatible or a
2506
- * transformation function must be registered.
2507
- * @param src_type Source type.
2508
- * @param dest_type Target type.
2509
- * @returns %TRUE if the transformation is possible, %FALSE otherwise.
2517
+ * Checks whether [method`GObject`.Value.transform] is able to transform values
2518
+ * of type `src_type` into values of type `dest_type`.
2519
+ *
2520
+ * Note that for the types to be transformable, they must be compatible or a
2521
+ * transformation function must be registered using
2522
+ * [func`GObject`.Value.register_transform_func].
2523
+ * @param src_type source type
2524
+ * @param dest_type target type
2525
+ * @returns true if the transformation is possible; false otherwise
2510
2526
  */
2511
2527
  function value_type_transformable(src_type: GType, dest_type: GType): boolean;
2512
2528
  function variant_get_gtype(): GType;
@@ -2655,12 +2671,9 @@ export namespace GObject {
2655
2671
  type VariantBuilder = object | null;
2656
2672
  type VariantDict = object | null;
2657
2673
  type VariantType = object | null;
2658
- /**
2659
- * Flags to be passed to g_object_bind_property() or
2660
- * g_object_bind_property_full().
2661
- *
2662
- * This enumeration can be extended at later date.
2663
- */
2674
+ export namespace BindingFlags {
2675
+ export const $gtype: GType<BindingFlags>;
2676
+ }
2664
2677
 
2665
2678
  /**
2666
2679
  * Flags to be passed to g_object_bind_property() or
@@ -2668,10 +2681,6 @@ export namespace GObject {
2668
2681
  *
2669
2682
  * This enumeration can be extended at later date.
2670
2683
  */
2671
- export namespace BindingFlags {
2672
- export const $gtype: GType<BindingFlags>;
2673
- }
2674
-
2675
2684
  enum BindingFlags {
2676
2685
  /**
2677
2686
  * The default binding; if the source property
@@ -2699,19 +2708,11 @@ export namespace GObject {
2699
2708
  */
2700
2709
  INVERT_BOOLEAN,
2701
2710
  }
2702
- /**
2703
- * The connection flags are used to specify the behaviour of a signal's
2704
- * connection.
2705
- */
2706
2711
 
2707
2712
  /**
2708
2713
  * The connection flags are used to specify the behaviour of a signal's
2709
2714
  * connection.
2710
2715
  */
2711
- export namespace ConnectFlags {
2712
- export const $gtype: GType<ConnectFlags>;
2713
- }
2714
-
2715
2716
  enum ConnectFlags {
2716
2717
  /**
2717
2718
  * Default behaviour (no special flags). Since: 2.74
@@ -2742,12 +2743,6 @@ export namespace GObject {
2742
2743
  HUP,
2743
2744
  NVAL,
2744
2745
  }
2745
- /**
2746
- * Through the #GParamFlags flag values, certain aspects of parameters
2747
- * can be configured.
2748
- *
2749
- * See also: %G_PARAM_STATIC_STRINGS
2750
- */
2751
2746
 
2752
2747
  /**
2753
2748
  * Through the #GParamFlags flag values, certain aspects of parameters
@@ -2755,10 +2750,6 @@ export namespace GObject {
2755
2750
  *
2756
2751
  * See also: %G_PARAM_STATIC_STRINGS
2757
2752
  */
2758
- export namespace ParamFlags {
2759
- export const $gtype: GType<ParamFlags>;
2760
- }
2761
-
2762
2753
  enum ParamFlags {
2763
2754
  /**
2764
2755
  * the parameter is readable
@@ -2827,17 +2818,10 @@ export namespace GObject {
2827
2818
  */
2828
2819
  DEPRECATED,
2829
2820
  }
2830
- /**
2831
- * The signal flags are used to specify a signal's behaviour.
2832
- */
2833
2821
 
2834
2822
  /**
2835
2823
  * The signal flags are used to specify a signal's behaviour.
2836
2824
  */
2837
- export namespace SignalFlags {
2838
- export const $gtype: GType<SignalFlags>;
2839
- }
2840
-
2841
2825
  enum SignalFlags {
2842
2826
  /**
2843
2827
  * Invoke the object method handler in the first emission stage.
@@ -2896,21 +2880,12 @@ export namespace GObject {
2896
2880
  */
2897
2881
  ACCUMULATOR_FIRST_RUN,
2898
2882
  }
2899
- /**
2900
- * The match types specify what g_signal_handlers_block_matched(),
2901
- * g_signal_handlers_unblock_matched() and g_signal_handlers_disconnect_matched()
2902
- * match signals by.
2903
- */
2904
2883
 
2905
2884
  /**
2906
2885
  * The match types specify what g_signal_handlers_block_matched(),
2907
2886
  * g_signal_handlers_unblock_matched() and g_signal_handlers_disconnect_matched()
2908
2887
  * match signals by.
2909
2888
  */
2910
- export namespace SignalMatchType {
2911
- export const $gtype: GType<SignalMatchType>;
2912
- }
2913
-
2914
2889
  enum SignalMatchType {
2915
2890
  /**
2916
2891
  * The signal id must be equal.
@@ -2937,13 +2912,6 @@ export namespace GObject {
2937
2912
  */
2938
2913
  UNBLOCKED,
2939
2914
  }
2940
- /**
2941
- * These flags used to be passed to g_type_init_with_debug_flags() which
2942
- * is now deprecated.
2943
- *
2944
- * If you need to enable debugging features, use the `GOBJECT_DEBUG`
2945
- * environment variable.
2946
- */
2947
2915
 
2948
2916
  /**
2949
2917
  * These flags used to be passed to g_type_init_with_debug_flags() which
@@ -2952,10 +2920,6 @@ export namespace GObject {
2952
2920
  * If you need to enable debugging features, use the `GOBJECT_DEBUG`
2953
2921
  * environment variable.
2954
2922
  */
2955
- export namespace TypeDebugFlags {
2956
- export const $gtype: GType<TypeDebugFlags>;
2957
- }
2958
-
2959
2923
  enum TypeDebugFlags {
2960
2924
  /**
2961
2925
  * Print no messages
@@ -2978,17 +2942,10 @@ export namespace GObject {
2978
2942
  */
2979
2943
  MASK,
2980
2944
  }
2981
- /**
2982
- * Bit masks used to check or determine characteristics of a type.
2983
- */
2984
2945
 
2985
2946
  /**
2986
2947
  * Bit masks used to check or determine characteristics of a type.
2987
2948
  */
2988
- export namespace TypeFlags {
2989
- export const $gtype: GType<TypeFlags>;
2990
- }
2991
-
2992
2949
  enum TypeFlags {
2993
2950
  /**
2994
2951
  * No special flags. Since: 2.74
@@ -3017,19 +2974,11 @@ export namespace GObject {
3017
2974
  */
3018
2975
  DEPRECATED,
3019
2976
  }
3020
- /**
3021
- * Bit masks used to check or determine specific characteristics of a
3022
- * fundamental type.
3023
- */
3024
2977
 
3025
2978
  /**
3026
2979
  * Bit masks used to check or determine specific characteristics of a
3027
2980
  * fundamental type.
3028
2981
  */
3029
- export namespace TypeFundamentalFlags {
3030
- export const $gtype: GType<TypeFundamentalFlags>;
3031
- }
3032
-
3033
2982
  enum TypeFundamentalFlags {
3034
2983
  /**
3035
2984
  * Indicates a classed type
@@ -3048,6 +2997,7 @@ export namespace GObject {
3048
2997
  */
3049
2998
  DEEP_DERIVABLE,
3050
2999
  }
3000
+
3051
3001
  namespace Binding {
3052
3002
  // Signal signatures
3053
3003
  interface SignalSignatures extends Object.SignalSignatures {
@@ -4860,10 +4810,10 @@ export namespace GObject {
4860
4810
  * Since 2.56 if `module` is %NULL this will call g_type_register_static()
4861
4811
  * instead. This can be used when making a static build of the module.
4862
4812
  * @param name name for the type
4863
- * @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.
4813
+ * @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.
4864
4814
  * @returns the new or existing type ID
4865
4815
  */
4866
- register_enum(name: string, const_static_values: EnumValue): GType;
4816
+ register_enum(name: string, const_static_values: EnumValue[]): GType;
4867
4817
  /**
4868
4818
  * Looks up or registers a flags type that is implemented with a particular
4869
4819
  * type plugin. If a type with name `type_name` was previously registered,
@@ -4876,10 +4826,10 @@ export namespace GObject {
4876
4826
  * Since 2.56 if `module` is %NULL this will call g_type_register_static()
4877
4827
  * instead. This can be used when making a static build of the module.
4878
4828
  * @param name name for the type
4879
- * @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.
4829
+ * @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.
4880
4830
  * @returns the new or existing type ID
4881
4831
  */
4882
- register_flags(name: string, const_static_values: FlagsValue): GType;
4832
+ register_flags(name: string, const_static_values: FlagsValue[]): GType;
4883
4833
  /**
4884
4834
  * Looks up or registers a type that is implemented with a particular
4885
4835
  * type plugin. If a type with name `type_name` was previously registered,
@@ -5396,10 +5346,6 @@ export namespace GObject {
5396
5346
 
5397
5347
  callback: any;
5398
5348
 
5399
- // Constructors
5400
-
5401
- _init(...args: any[]): void;
5402
-
5403
5349
  // Static methods
5404
5350
 
5405
5351
  /**
@@ -5836,10 +5782,6 @@ export namespace GObject {
5836
5782
 
5837
5783
  data: any;
5838
5784
  notify: ClosureNotify;
5839
-
5840
- // Constructors
5841
-
5842
- _init(...args: any[]): void;
5843
5785
  }
5844
5786
 
5845
5787
  /**
@@ -5855,10 +5797,6 @@ export namespace GObject {
5855
5797
  maximum: number;
5856
5798
  n_values: number;
5857
5799
  values: EnumValue;
5858
-
5859
- // Constructors
5860
-
5861
- _init(...args: any[]): void;
5862
5800
  }
5863
5801
 
5864
5802
  /**
@@ -5883,7 +5821,6 @@ export namespace GObject {
5883
5821
  value_nick: string;
5884
5822
  }>,
5885
5823
  );
5886
- _init(...args: any[]): void;
5887
5824
  }
5888
5825
 
5889
5826
  /**
@@ -5898,10 +5835,6 @@ export namespace GObject {
5898
5835
  mask: number;
5899
5836
  n_values: number;
5900
5837
  values: FlagsValue;
5901
-
5902
- // Constructors
5903
-
5904
- _init(...args: any[]): void;
5905
5838
  }
5906
5839
 
5907
5840
  /**
@@ -5926,7 +5859,6 @@ export namespace GObject {
5926
5859
  value_nick: string;
5927
5860
  }>,
5928
5861
  );
5929
- _init(...args: any[]): void;
5930
5862
  }
5931
5863
 
5932
5864
  type InitiallyUnownedClass = typeof InitiallyUnowned;
@@ -5942,10 +5874,6 @@ export namespace GObject {
5942
5874
  interface_init: InterfaceInitFunc;
5943
5875
  interface_finalize: InterfaceFinalizeFunc;
5944
5876
  interface_data: any;
5945
-
5946
- // Constructors
5947
-
5948
- _init(...args: any[]): void;
5949
5877
  }
5950
5878
 
5951
5879
  type ObjectClass = typeof Object;
@@ -5959,10 +5887,6 @@ export namespace GObject {
5959
5887
  // Fields
5960
5888
 
5961
5889
  pspec: ParamSpec;
5962
-
5963
- // Constructors
5964
-
5965
- _init(...args: any[]): void;
5966
5890
  }
5967
5891
 
5968
5892
  type ParamSpecClass = typeof ParamSpec;
@@ -5976,10 +5900,6 @@ export namespace GObject {
5976
5900
  abstract class ParamSpecPool {
5977
5901
  static $gtype: GType<ParamSpecPool>;
5978
5902
 
5979
- // Constructors
5980
-
5981
- _init(...args: any[]): void;
5982
-
5983
5903
  // Methods
5984
5904
 
5985
5905
  /**
@@ -6039,10 +5959,6 @@ export namespace GObject {
6039
5959
  instance_size: number;
6040
5960
  n_preallocs: number;
6041
5961
  value_type: GType;
6042
-
6043
- // Constructors
6044
-
6045
- _init(...args: any[]): void;
6046
5962
  }
6047
5963
 
6048
5964
  /**
@@ -6055,10 +5971,6 @@ export namespace GObject {
6055
5971
  // Fields
6056
5972
 
6057
5973
  name: string;
6058
-
6059
- // Constructors
6060
-
6061
- _init(...args: any[]): void;
6062
5974
  }
6063
5975
 
6064
5976
  /**
@@ -6073,10 +5985,6 @@ export namespace GObject {
6073
5985
  signal_id: number;
6074
5986
  detail: GLib.Quark;
6075
5987
  run_type: SignalFlags;
6076
-
6077
- // Constructors
6078
-
6079
- _init(...args: any[]): void;
6080
5988
  }
6081
5989
 
6082
5990
  /**
@@ -6096,10 +6004,6 @@ export namespace GObject {
6096
6004
  return_type: GType;
6097
6005
  n_params: number;
6098
6006
  param_types: GType[];
6099
-
6100
- // Constructors
6101
-
6102
- _init(...args: any[]): void;
6103
6007
  }
6104
6008
 
6105
6009
  /**
@@ -6108,10 +6012,6 @@ export namespace GObject {
6108
6012
  class TypeClass {
6109
6013
  static $gtype: GType<TypeClass>;
6110
6014
 
6111
- // Constructors
6112
-
6113
- _init(...args: any[]): void;
6114
-
6115
6015
  // Static methods
6116
6016
 
6117
6017
  static adjust_private_offset(g_class: any | null, private_size_or_offset: number): void;
@@ -6257,10 +6157,6 @@ export namespace GObject {
6257
6157
  // Fields
6258
6158
 
6259
6159
  type_flags: TypeFundamentalFlags;
6260
-
6261
- // Constructors
6262
-
6263
- _init(...args: any[]): void;
6264
6160
  }
6265
6161
 
6266
6162
  /**
@@ -6288,10 +6184,6 @@ export namespace GObject {
6288
6184
  instance_size: number;
6289
6185
  n_preallocs: number;
6290
6186
  instance_init: InstanceInitFunc;
6291
-
6292
- // Constructors
6293
-
6294
- _init(...args: any[]): void;
6295
6187
  }
6296
6188
 
6297
6189
  /**
@@ -6300,10 +6192,6 @@ export namespace GObject {
6300
6192
  class TypeInstance {
6301
6193
  static $gtype: GType<TypeInstance>;
6302
6194
 
6303
- // Constructors
6304
-
6305
- _init(...args: any[]): void;
6306
-
6307
6195
  // Methods
6308
6196
 
6309
6197
  get_private(private_type: GType): any | null;
@@ -6315,10 +6203,6 @@ export namespace GObject {
6315
6203
  class TypeInterface {
6316
6204
  static $gtype: GType<TypeInterface>;
6317
6205
 
6318
- // Constructors
6319
-
6320
- _init(...args: any[]): void;
6321
-
6322
6206
  // Static methods
6323
6207
 
6324
6208
  /**
@@ -6390,10 +6274,6 @@ export namespace GObject {
6390
6274
  unuse_plugin: TypePluginUnuse;
6391
6275
  complete_type_info: TypePluginCompleteTypeInfo;
6392
6276
  complete_interface_info: TypePluginCompleteInterfaceInfo;
6393
-
6394
- // Constructors
6395
-
6396
- _init(...args: any[]): void;
6397
6277
  }
6398
6278
 
6399
6279
  /**
@@ -6410,10 +6290,6 @@ export namespace GObject {
6410
6290
  type_name: string;
6411
6291
  class_size: number;
6412
6292
  instance_size: number;
6413
-
6414
- // Constructors
6415
-
6416
- _init(...args: any[]): void;
6417
6293
  }
6418
6294
 
6419
6295
  /**
@@ -6442,47 +6318,50 @@ export namespace GObject {
6442
6318
  collect_value: TypeValueCollectFunc;
6443
6319
  lcopy_format: string;
6444
6320
  lcopy_value: TypeValueLCopyFunc;
6445
-
6446
- // Constructors
6447
-
6448
- _init(...args: any[]): void;
6449
6321
  }
6450
6322
 
6451
6323
  /**
6452
6324
  * An opaque structure used to hold different types of values.
6453
6325
  *
6326
+ * Before it can be used, a `GValue` has to be initialized to a specific type by
6327
+ * calling [method`GObject`.Value.init] on it.
6328
+ *
6329
+ * Many types which are stored within a `GValue` need to allocate data on the
6330
+ * heap, so [method`GObject`.Value.unset] must always be called on a `GValue` to
6331
+ * free any such data once you’re finished with the `GValue`, even if the
6332
+ * `GValue` itself is stored on the stack.
6333
+ *
6454
6334
  * The data within the structure has protected scope: it is accessible only
6455
- * to functions within a #GTypeValueTable structure, or implementations of
6456
- * the g_value_*() API. That is, code portions which implement new fundamental
6457
- * types.
6335
+ * to functions within a [struct`GObject`.TypeValueTable] structure, or
6336
+ * implementations of the `g_value_*()` API. That is, code which implements new
6337
+ * fundamental types.
6458
6338
  *
6459
- * #GValue users cannot make any assumptions about how data is stored
6339
+ * `GValue` users cannot make any assumptions about how data is stored
6460
6340
  * within the 2 element `data` union, and the `g_type` member should
6461
- * only be accessed through the G_VALUE_TYPE() macro.
6341
+ * only be accessed through the [func`GObject`.VALUE_TYPE] macro and related
6342
+ * macros.
6462
6343
  */
6463
6344
  class Value {
6464
6345
  static $gtype: GType<Value>;
6465
6346
 
6466
- // Constructors
6467
-
6468
- _init(...args: any[]): void;
6469
-
6470
6347
  // Static methods
6471
6348
 
6472
6349
  /**
6473
- * Returns whether a #GValue of type `src_type` can be copied into
6474
- * a #GValue of type `dest_type`.
6475
- * @param src_type source type to be copied.
6476
- * @param dest_type destination type for copying.
6350
+ * Checks whether a [method`GObject`.Value.copy] is able to copy values of type
6351
+ * `src_type` into values of type `dest_type`.
6352
+ * @param src_type source type to be copied
6353
+ * @param dest_type destination type for copying
6477
6354
  */
6478
6355
  static type_compatible(src_type: GType, dest_type: GType): boolean;
6479
6356
  /**
6480
- * Check whether g_value_transform() is able to transform values
6481
- * of type `src_type` into values of type `dest_type`. Note that for
6482
- * the types to be transformable, they must be compatible or a
6483
- * transformation function must be registered.
6484
- * @param src_type Source type.
6485
- * @param dest_type Target type.
6357
+ * Checks whether [method`GObject`.Value.transform] is able to transform values
6358
+ * of type `src_type` into values of type `dest_type`.
6359
+ *
6360
+ * Note that for the types to be transformable, they must be compatible or a
6361
+ * transformation function must be registered using
6362
+ * [func`GObject`.Value.register_transform_func].
6363
+ * @param src_type source type
6364
+ * @param dest_type target type
6486
6365
  */
6487
6366
  static type_transformable(src_type: GType, dest_type: GType): boolean;
6488
6367
 
@@ -6490,7 +6369,7 @@ export namespace GObject {
6490
6369
 
6491
6370
  /**
6492
6371
  * Copies the value of `src_value` into `dest_value`.
6493
- * @param dest_value An initialized #GValue structure of the same type as @src_value.
6372
+ * @param dest_value an initialized [struct@GObject.Value] structure of the same type as @src_value
6494
6373
  */
6495
6374
  copy(dest_value: Value | any): void;
6496
6375
  /**
@@ -6513,8 +6392,9 @@ export namespace GObject {
6513
6392
  dup_variant(): GLib.Variant | null;
6514
6393
  /**
6515
6394
  * Determines if `value` will fit inside the size of a pointer value.
6395
+ *
6516
6396
  * This is an internal function introduced mainly for C marshallers.
6517
- * @returns %TRUE if @value will fit inside a pointer value.
6397
+ * @returns true if @value will fit inside a pointer value; false otherwise
6518
6398
  */
6519
6399
  fits_pointer(): boolean;
6520
6400
  /**
@@ -6626,33 +6506,51 @@ export namespace GObject {
6626
6506
  */
6627
6507
  get_variant(): GLib.Variant | null;
6628
6508
  /**
6629
- * Initializes `value` with the default value of `type`.
6630
- * @param g_type Type the #GValue should hold values of.
6631
- * @returns the #GValue structure that has been passed in
6509
+ * Initializes `value` to store values of the given `type,` and sets its value
6510
+ * to the default for `type`.
6511
+ *
6512
+ * This must be called before any other methods on a [struct`GObject`.Value], so
6513
+ * the value knows what type it’s meant to store.
6514
+ *
6515
+ * ```c
6516
+ * GValue value = G_VALUE_INIT;
6517
+ *
6518
+ * g_value_init (&value, SOME_G_TYPE);
6519
+ * …
6520
+ * g_value_unset (&value);
6521
+ * ```
6522
+ * @param g_type type the [struct@GObject.Value] should hold values of
6523
+ * @returns the [struct@GObject.Value] structure that has been passed in
6632
6524
  */
6633
6525
  init(g_type: GType): unknown;
6634
6526
  /**
6635
- * Initializes and sets `value` from an instantiatable type via the
6636
- * value_table's collect_value() function.
6527
+ * Initializes and sets `value` from an instantiatable type.
6528
+ *
6529
+ * This calls the [callback`GObject`.TypeValueCollectFunc] function for the type
6530
+ * the [struct`GObject`.Value] contains.
6637
6531
  *
6638
6532
  * Note: The `value` will be initialised with the exact type of
6639
- * `instance`. If you wish to set the `value'`s type to a different GType
6640
- * (such as a parent class GType), you need to manually call
6641
- * g_value_init() and g_value_set_instance().
6533
+ * `instance`. If you wish to set the `value’`s type to a different
6534
+ * [type`GObject`.Type] (such as a parent class type), you need to manually call
6535
+ * [method`GObject`.Value.init] and [method`GObject`.Value.set_instance].
6642
6536
  * @param instance the instance
6643
6537
  */
6644
6538
  init_from_instance(instance: TypeInstance): void;
6645
6539
  /**
6646
- * Returns the value contents as pointer. This function asserts that
6647
- * g_value_fits_pointer() returned %TRUE for the passed in value.
6540
+ * Returns the value contents as a pointer.
6541
+ *
6542
+ * This function asserts that [method`GObject`.Value.fits_pointer] returned true
6543
+ * for the passed in value.
6544
+ *
6648
6545
  * This is an internal function introduced mainly for C marshallers.
6649
- * @returns the value contents as pointer
6546
+ * @returns the value contents as a pointer
6650
6547
  */
6651
6548
  peek_pointer(): any | null;
6652
6549
  /**
6653
6550
  * Clears the current value in `value` and resets it to the default value
6654
- * (as if the value had just been initialized).
6655
- * @returns the #GValue structure that has been passed in
6551
+ * (as if the value had just been initialized using
6552
+ * [method`GObject`.Value.init]).
6553
+ * @returns the [struct@GObject.Value] structure that has been passed in
6656
6554
  */
6657
6555
  reset(): unknown;
6658
6556
  /**
@@ -6662,7 +6560,7 @@ export namespace GObject {
6662
6560
  set_boolean(v_boolean: boolean): void;
6663
6561
  /**
6664
6562
  * Set the contents of a %G_TYPE_BOXED derived #GValue to `v_boxed`.
6665
- * @param v_boxed boxed value to be set
6563
+ * @param v_boxed caller-owned boxed object to be duplicated for the #GValue
6666
6564
  */
6667
6565
  set_boxed(v_boxed?: any | null): void;
6668
6566
  /**
@@ -6701,8 +6599,10 @@ export namespace GObject {
6701
6599
  */
6702
6600
  set_gtype(v_gtype: GType): void;
6703
6601
  /**
6704
- * Sets `value` from an instantiatable type via the
6705
- * value_table's collect_value() function.
6602
+ * Sets `value` from an instantiatable type.
6603
+ *
6604
+ * This calls the [callback`GObject`.TypeValueCollectFunc] function for the type
6605
+ * the [struct`GObject`.Value] contains.
6706
6606
  * @param instance the instance
6707
6607
  */
6708
6608
  set_instance(instance?: any | null): void;
@@ -6855,21 +6755,27 @@ export namespace GObject {
6855
6755
  take_variant(variant?: GLib.Variant | null): void;
6856
6756
  /**
6857
6757
  * Tries to cast the contents of `src_value` into a type appropriate
6858
- * to store in `dest_value,` e.g. to transform a %G_TYPE_INT value
6859
- * into a %G_TYPE_FLOAT value. Performing transformations between
6860
- * value types might incur precision lossage. Especially
6861
- * transformations into strings might reveal seemingly arbitrary
6862
- * results and shouldn't be relied upon for production code (such
6863
- * as rcfile value or object property serialization).
6864
- * @param dest_value Target value.
6865
- * @returns Whether a transformation rule was found and could be applied. Upon failing transformations, @dest_value is left untouched.
6758
+ * to store in `dest_value`.
6759
+ *
6760
+ * If a transformation is not possible, `dest_value` is not modified.
6761
+ *
6762
+ * For example, this could transform a `G_TYPE_INT` value into a `G_TYPE_FLOAT`
6763
+ * value.
6764
+ *
6765
+ * Performing transformations between value types might incur precision loss.
6766
+ * Especially transformations into strings might reveal seemingly arbitrary
6767
+ * results and the format of particular transformations to strings is not
6768
+ * guaranteed over time.
6769
+ * @param dest_value target value
6770
+ * @returns true on success; false otherwise
6866
6771
  */
6867
6772
  transform(dest_value: Value | any): boolean;
6868
6773
  /**
6869
- * Clears the current value in `value` (if any) and "unsets" the type,
6870
- * this releases all resources associated with this GValue. An unset
6871
- * value is the same as an uninitialized (zero-filled) #GValue
6872
- * structure.
6774
+ * Clears the current value in `value` (if any) and unsets the type.
6775
+ *
6776
+ * This releases all resources associated with this [struct`GObject`.Value]. An
6777
+ * unset value is the same as a cleared (zero-filled)
6778
+ * [struct`GObject`.Value] structure set to `G_VALUE_INIT`.
6873
6779
  */
6874
6780
  unset(): void;
6875
6781
  }
@@ -6909,7 +6815,6 @@ export namespace GObject {
6909
6815
  // Constructors
6910
6816
 
6911
6817
  constructor(n_prealloced: number);
6912
- _init(...args: any[]): void;
6913
6818
 
6914
6819
  static ['new'](n_prealloced: number): ValueArray;
6915
6820
 
@@ -7005,10 +6910,6 @@ export namespace GObject {
7005
6910
  */
7006
6911
  class WeakRef {
7007
6912
  static $gtype: GType<WeakRef>;
7008
-
7009
- // Constructors
7010
-
7011
- _init(...args: any[]): void;
7012
6913
  }
7013
6914
 
7014
6915
  /**
@@ -7036,7 +6937,6 @@ export namespace GObject {
7036
6937
  v_pointer: any;
7037
6938
  }>,
7038
6939
  );
7039
- _init(...args: any[]): void;
7040
6940
  }
7041
6941
 
7042
6942
  class _Value__data__union {
@@ -7069,7 +6969,6 @@ export namespace GObject {
7069
6969
  v_pointer: any;
7070
6970
  }>,
7071
6971
  );
7072
- _init(...args: any[]): void;
7073
6972
  }
7074
6973
 
7075
6974
  namespace TypePlugin {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@girs/gobject-2.0",
3
- "version": "2.86.0-4.0.0-beta.38",
4
- "description": "GJS TypeScript type definitions for GObject-2.0, generated from library version 2.86.0",
3
+ "version": "2.86.4-4.0.0-beta.40",
4
+ "description": "GJS TypeScript type definitions for GObject-2.0, generated from library version 2.86.4",
5
5
  "type": "module",
6
6
  "module": "gobject-2.0.js",
7
7
  "main": "gobject-2.0.js",
@@ -31,8 +31,8 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gjs": "4.0.0-beta.38",
35
- "@girs/glib-2.0": "2.86.0-4.0.0-beta.38" },
34
+ "@girs/gjs": "4.0.0-beta.40",
35
+ "@girs/glib-2.0": "2.86.4-4.0.0-beta.40" },
36
36
  "devDependencies": {
37
37
  "typescript": "*"
38
38
  },