@girs/devhelp-3.0 3.0.0-4.0.0-beta.20 → 3.0.0-4.0.0-beta.23

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/devhelp-3.0.d.ts +400 -47
  3. package/package.json +18 -18
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/devhelp-3.0)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Devhelp-3.0, generated from library version 3.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.20.
8
+ GJS TypeScript type definitions for Devhelp-3.0, generated from library version 3.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.23.
9
9
 
10
10
 
11
11
  ## Install
package/devhelp-3.0.d.ts CHANGED
@@ -7,22 +7,24 @@
7
7
  * The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
8
8
  */
9
9
 
10
+ import '@girs/gjs';
11
+
10
12
  // Module dependencies
11
13
  import type WebKit2 from '@girs/webkit2-4.1';
12
14
  import type Soup from '@girs/soup-3.0';
13
15
  import type Gio from '@girs/gio-2.0';
14
16
  import type GObject from '@girs/gobject-2.0';
15
17
  import type GLib from '@girs/glib-2.0';
18
+ import type GModule from '@girs/gmodule-2.0';
16
19
  import type JavaScriptCore from '@girs/javascriptcore-4.1';
17
20
  import type Gtk from '@girs/gtk-3.0';
18
21
  import type xlib from '@girs/xlib-2.0';
19
22
  import type Gdk from '@girs/gdk-3.0';
20
- import type cairo from '@girs/cairo-1.0';
23
+ import type cairo from 'cairo';
21
24
  import type Pango from '@girs/pango-1.0';
22
25
  import type HarfBuzz from '@girs/harfbuzz-0.0';
23
26
  import type freetype2 from '@girs/freetype2-2.0';
24
27
  import type GdkPixbuf from '@girs/gdkpixbuf-2.0';
25
- import type GModule from '@girs/gmodule-2.0';
26
28
  import type Atk from '@girs/atk-1.0';
27
29
 
28
30
  export namespace Devhelp {
@@ -303,7 +305,21 @@ export namespace Devhelp {
303
305
  * @returns the data if found, or %NULL if no such data exists.
304
306
  */
305
307
  get_data(key: string): any | null;
306
- get_property(property_name: string): any;
308
+ /**
309
+ * Gets a property of an object.
310
+ *
311
+ * The value can be:
312
+ * - an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
313
+ * - a GObject.Value initialized with the expected type of the property
314
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
315
+ *
316
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
317
+ *
318
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
319
+ * @param property_name The name of the property to get
320
+ * @param value Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
321
+ */
322
+ get_property(property_name: string, value: GObject.Value | any): any;
307
323
  /**
308
324
  * This function gets back user data pointers stored via
309
325
  * g_object_set_qdata().
@@ -431,7 +447,12 @@ export namespace Devhelp {
431
447
  * @param data data to associate with that key
432
448
  */
433
449
  set_data(key: string, data?: any | null): void;
434
- set_property(property_name: string, value: any): void;
450
+ /**
451
+ * Sets a property on an object.
452
+ * @param property_name The name of the property to set
453
+ * @param value The value to set the property to
454
+ */
455
+ set_property(property_name: string, value: GObject.Value | any): void;
435
456
  /**
436
457
  * Remove a specified datum from the object's data associations,
437
458
  * without invoking the association's destroy handler.
@@ -581,11 +602,31 @@ export namespace Devhelp {
581
602
  * @param pspec
582
603
  */
583
604
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
605
+ /**
606
+ * Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
607
+ * @param id Handler ID of the handler to be disconnected
608
+ */
584
609
  disconnect(id: number): void;
610
+ /**
611
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
612
+ * @param properties Object containing the properties to set
613
+ */
585
614
  set(properties: { [key: string]: any }): void;
586
- block_signal_handler(id: number): any;
587
- unblock_signal_handler(id: number): any;
588
- stop_emission_by_name(detailedName: string): any;
615
+ /**
616
+ * Blocks a handler of an instance so it will not be called during any signal emissions
617
+ * @param id Handler ID of the handler to be blocked
618
+ */
619
+ block_signal_handler(id: number): void;
620
+ /**
621
+ * Unblocks a handler so it will be called again during any signal emissions
622
+ * @param id Handler ID of the handler to be unblocked
623
+ */
624
+ unblock_signal_handler(id: number): void;
625
+ /**
626
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
627
+ * @param detailedName Name of the signal to stop emission of
628
+ */
629
+ stop_emission_by_name(detailedName: string): void;
589
630
  }
590
631
 
591
632
  namespace Book {
@@ -1177,7 +1218,21 @@ export namespace Devhelp {
1177
1218
  * @returns the data if found, or %NULL if no such data exists.
1178
1219
  */
1179
1220
  get_data(key: string): any | null;
1180
- get_property(property_name: string): any;
1221
+ /**
1222
+ * Gets a property of an object.
1223
+ *
1224
+ * The value can be:
1225
+ * - an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
1226
+ * - a GObject.Value initialized with the expected type of the property
1227
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
1228
+ *
1229
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
1230
+ *
1231
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
1232
+ * @param property_name The name of the property to get
1233
+ * @param value Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
1234
+ */
1235
+ get_property(property_name: string, value: GObject.Value | any): any;
1181
1236
  /**
1182
1237
  * This function gets back user data pointers stored via
1183
1238
  * g_object_set_qdata().
@@ -1305,7 +1360,12 @@ export namespace Devhelp {
1305
1360
  * @param data data to associate with that key
1306
1361
  */
1307
1362
  set_data(key: string, data?: any | null): void;
1308
- set_property(property_name: string, value: any): void;
1363
+ /**
1364
+ * Sets a property on an object.
1365
+ * @param property_name The name of the property to set
1366
+ * @param value The value to set the property to
1367
+ */
1368
+ set_property(property_name: string, value: GObject.Value | any): void;
1309
1369
  /**
1310
1370
  * Remove a specified datum from the object's data associations,
1311
1371
  * without invoking the association's destroy handler.
@@ -1455,11 +1515,31 @@ export namespace Devhelp {
1455
1515
  * @param pspec
1456
1516
  */
1457
1517
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
1518
+ /**
1519
+ * Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
1520
+ * @param id Handler ID of the handler to be disconnected
1521
+ */
1458
1522
  disconnect(id: number): void;
1523
+ /**
1524
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
1525
+ * @param properties Object containing the properties to set
1526
+ */
1459
1527
  set(properties: { [key: string]: any }): void;
1460
- block_signal_handler(id: number): any;
1461
- unblock_signal_handler(id: number): any;
1462
- stop_emission_by_name(detailedName: string): any;
1528
+ /**
1529
+ * Blocks a handler of an instance so it will not be called during any signal emissions
1530
+ * @param id Handler ID of the handler to be blocked
1531
+ */
1532
+ block_signal_handler(id: number): void;
1533
+ /**
1534
+ * Unblocks a handler so it will be called again during any signal emissions
1535
+ * @param id Handler ID of the handler to be unblocked
1536
+ */
1537
+ unblock_signal_handler(id: number): void;
1538
+ /**
1539
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
1540
+ * @param detailedName Name of the signal to stop emission of
1541
+ */
1542
+ stop_emission_by_name(detailedName: string): void;
1463
1543
  }
1464
1544
 
1465
1545
  namespace Completion {
@@ -2080,7 +2160,21 @@ export namespace Devhelp {
2080
2160
  * @returns the data if found, or %NULL if no such data exists.
2081
2161
  */
2082
2162
  get_data(key: string): any | null;
2083
- get_property(property_name: string): any;
2163
+ /**
2164
+ * Gets a property of an object.
2165
+ *
2166
+ * The value can be:
2167
+ * - an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
2168
+ * - a GObject.Value initialized with the expected type of the property
2169
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
2170
+ *
2171
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
2172
+ *
2173
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
2174
+ * @param property_name The name of the property to get
2175
+ * @param value Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
2176
+ */
2177
+ get_property(property_name: string, value: GObject.Value | any): any;
2084
2178
  /**
2085
2179
  * This function gets back user data pointers stored via
2086
2180
  * g_object_set_qdata().
@@ -2208,7 +2302,12 @@ export namespace Devhelp {
2208
2302
  * @param data data to associate with that key
2209
2303
  */
2210
2304
  set_data(key: string, data?: any | null): void;
2211
- set_property(property_name: string, value: any): void;
2305
+ /**
2306
+ * Sets a property on an object.
2307
+ * @param property_name The name of the property to set
2308
+ * @param value The value to set the property to
2309
+ */
2310
+ set_property(property_name: string, value: GObject.Value | any): void;
2212
2311
  /**
2213
2312
  * Remove a specified datum from the object's data associations,
2214
2313
  * without invoking the association's destroy handler.
@@ -2358,11 +2457,31 @@ export namespace Devhelp {
2358
2457
  * @param pspec
2359
2458
  */
2360
2459
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
2460
+ /**
2461
+ * Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
2462
+ * @param id Handler ID of the handler to be disconnected
2463
+ */
2361
2464
  disconnect(id: number): void;
2465
+ /**
2466
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
2467
+ * @param properties Object containing the properties to set
2468
+ */
2362
2469
  set(properties: { [key: string]: any }): void;
2363
- block_signal_handler(id: number): any;
2364
- unblock_signal_handler(id: number): any;
2365
- stop_emission_by_name(detailedName: string): any;
2470
+ /**
2471
+ * Blocks a handler of an instance so it will not be called during any signal emissions
2472
+ * @param id Handler ID of the handler to be blocked
2473
+ */
2474
+ block_signal_handler(id: number): void;
2475
+ /**
2476
+ * Unblocks a handler so it will be called again during any signal emissions
2477
+ * @param id Handler ID of the handler to be unblocked
2478
+ */
2479
+ unblock_signal_handler(id: number): void;
2480
+ /**
2481
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
2482
+ * @param detailedName Name of the signal to stop emission of
2483
+ */
2484
+ stop_emission_by_name(detailedName: string): void;
2366
2485
  }
2367
2486
 
2368
2487
  namespace Notebook {
@@ -2531,7 +2650,21 @@ export namespace Devhelp {
2531
2650
  * @returns the data if found, or %NULL if no such data exists.
2532
2651
  */
2533
2652
  get_data(key: string): any | null;
2534
- get_property(property_name: string): any;
2653
+ /**
2654
+ * Gets a property of an object.
2655
+ *
2656
+ * The value can be:
2657
+ * - an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
2658
+ * - a GObject.Value initialized with the expected type of the property
2659
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
2660
+ *
2661
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
2662
+ *
2663
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
2664
+ * @param property_name The name of the property to get
2665
+ * @param value Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
2666
+ */
2667
+ get_property(property_name: string, value: GObject.Value | any): any;
2535
2668
  /**
2536
2669
  * This function gets back user data pointers stored via
2537
2670
  * g_object_set_qdata().
@@ -2659,7 +2792,12 @@ export namespace Devhelp {
2659
2792
  * @param data data to associate with that key
2660
2793
  */
2661
2794
  set_data(key: string, data?: any | null): void;
2662
- set_property(property_name: string, value: any): void;
2795
+ /**
2796
+ * Sets a property on an object.
2797
+ * @param property_name The name of the property to set
2798
+ * @param value The value to set the property to
2799
+ */
2800
+ set_property(property_name: string, value: GObject.Value | any): void;
2663
2801
  /**
2664
2802
  * Remove a specified datum from the object's data associations,
2665
2803
  * without invoking the association's destroy handler.
@@ -2809,11 +2947,31 @@ export namespace Devhelp {
2809
2947
  * @param pspec
2810
2948
  */
2811
2949
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
2950
+ /**
2951
+ * Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
2952
+ * @param id Handler ID of the handler to be disconnected
2953
+ */
2812
2954
  disconnect(id: number): void;
2955
+ /**
2956
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
2957
+ * @param properties Object containing the properties to set
2958
+ */
2813
2959
  set(properties: { [key: string]: any }): void;
2814
- block_signal_handler(id: number): any;
2815
- unblock_signal_handler(id: number): any;
2816
- stop_emission_by_name(detailedName: string): any;
2960
+ /**
2961
+ * Blocks a handler of an instance so it will not be called during any signal emissions
2962
+ * @param id Handler ID of the handler to be blocked
2963
+ */
2964
+ block_signal_handler(id: number): void;
2965
+ /**
2966
+ * Unblocks a handler so it will be called again during any signal emissions
2967
+ * @param id Handler ID of the handler to be unblocked
2968
+ */
2969
+ unblock_signal_handler(id: number): void;
2970
+ /**
2971
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
2972
+ * @param detailedName Name of the signal to stop emission of
2973
+ */
2974
+ stop_emission_by_name(detailedName: string): void;
2817
2975
  }
2818
2976
 
2819
2977
  namespace Profile {
@@ -3053,7 +3211,21 @@ export namespace Devhelp {
3053
3211
  * @returns the data if found, or %NULL if no such data exists.
3054
3212
  */
3055
3213
  get_data(key: string): any | null;
3056
- get_property(property_name: string): any;
3214
+ /**
3215
+ * Gets a property of an object.
3216
+ *
3217
+ * The value can be:
3218
+ * - an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
3219
+ * - a GObject.Value initialized with the expected type of the property
3220
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
3221
+ *
3222
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
3223
+ *
3224
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
3225
+ * @param property_name The name of the property to get
3226
+ * @param value Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
3227
+ */
3228
+ get_property(property_name: string, value: GObject.Value | any): any;
3057
3229
  /**
3058
3230
  * This function gets back user data pointers stored via
3059
3231
  * g_object_set_qdata().
@@ -3181,7 +3353,12 @@ export namespace Devhelp {
3181
3353
  * @param data data to associate with that key
3182
3354
  */
3183
3355
  set_data(key: string, data?: any | null): void;
3184
- set_property(property_name: string, value: any): void;
3356
+ /**
3357
+ * Sets a property on an object.
3358
+ * @param property_name The name of the property to set
3359
+ * @param value The value to set the property to
3360
+ */
3361
+ set_property(property_name: string, value: GObject.Value | any): void;
3185
3362
  /**
3186
3363
  * Remove a specified datum from the object's data associations,
3187
3364
  * without invoking the association's destroy handler.
@@ -3331,11 +3508,31 @@ export namespace Devhelp {
3331
3508
  * @param pspec
3332
3509
  */
3333
3510
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
3511
+ /**
3512
+ * Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
3513
+ * @param id Handler ID of the handler to be disconnected
3514
+ */
3334
3515
  disconnect(id: number): void;
3516
+ /**
3517
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
3518
+ * @param properties Object containing the properties to set
3519
+ */
3335
3520
  set(properties: { [key: string]: any }): void;
3336
- block_signal_handler(id: number): any;
3337
- unblock_signal_handler(id: number): any;
3338
- stop_emission_by_name(detailedName: string): any;
3521
+ /**
3522
+ * Blocks a handler of an instance so it will not be called during any signal emissions
3523
+ * @param id Handler ID of the handler to be blocked
3524
+ */
3525
+ block_signal_handler(id: number): void;
3526
+ /**
3527
+ * Unblocks a handler so it will be called again during any signal emissions
3528
+ * @param id Handler ID of the handler to be unblocked
3529
+ */
3530
+ unblock_signal_handler(id: number): void;
3531
+ /**
3532
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
3533
+ * @param detailedName Name of the signal to stop emission of
3534
+ */
3535
+ stop_emission_by_name(detailedName: string): void;
3339
3536
  }
3340
3537
 
3341
3538
  namespace Settings {
@@ -3791,7 +3988,21 @@ export namespace Devhelp {
3791
3988
  * @returns the data if found, or %NULL if no such data exists.
3792
3989
  */
3793
3990
  get_data(key: string): any | null;
3794
- get_property(property_name: string): any;
3991
+ /**
3992
+ * Gets a property of an object.
3993
+ *
3994
+ * The value can be:
3995
+ * - an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
3996
+ * - a GObject.Value initialized with the expected type of the property
3997
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
3998
+ *
3999
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
4000
+ *
4001
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
4002
+ * @param property_name The name of the property to get
4003
+ * @param value Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
4004
+ */
4005
+ get_property(property_name: string, value: GObject.Value | any): any;
3795
4006
  /**
3796
4007
  * This function gets back user data pointers stored via
3797
4008
  * g_object_set_qdata().
@@ -3919,7 +4130,12 @@ export namespace Devhelp {
3919
4130
  * @param data data to associate with that key
3920
4131
  */
3921
4132
  set_data(key: string, data?: any | null): void;
3922
- set_property(property_name: string, value: any): void;
4133
+ /**
4134
+ * Sets a property on an object.
4135
+ * @param property_name The name of the property to set
4136
+ * @param value The value to set the property to
4137
+ */
4138
+ set_property(property_name: string, value: GObject.Value | any): void;
3923
4139
  /**
3924
4140
  * Remove a specified datum from the object's data associations,
3925
4141
  * without invoking the association's destroy handler.
@@ -4069,11 +4285,31 @@ export namespace Devhelp {
4069
4285
  * @param pspec
4070
4286
  */
4071
4287
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
4288
+ /**
4289
+ * Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
4290
+ * @param id Handler ID of the handler to be disconnected
4291
+ */
4072
4292
  disconnect(id: number): void;
4293
+ /**
4294
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
4295
+ * @param properties Object containing the properties to set
4296
+ */
4073
4297
  set(properties: { [key: string]: any }): void;
4074
- block_signal_handler(id: number): any;
4075
- unblock_signal_handler(id: number): any;
4076
- stop_emission_by_name(detailedName: string): any;
4298
+ /**
4299
+ * Blocks a handler of an instance so it will not be called during any signal emissions
4300
+ * @param id Handler ID of the handler to be blocked
4301
+ */
4302
+ block_signal_handler(id: number): void;
4303
+ /**
4304
+ * Unblocks a handler so it will be called again during any signal emissions
4305
+ * @param id Handler ID of the handler to be unblocked
4306
+ */
4307
+ unblock_signal_handler(id: number): void;
4308
+ /**
4309
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
4310
+ * @param detailedName Name of the signal to stop emission of
4311
+ */
4312
+ stop_emission_by_name(detailedName: string): void;
4077
4313
  }
4078
4314
 
4079
4315
  namespace Tab {
@@ -4255,7 +4491,21 @@ export namespace Devhelp {
4255
4491
  * @returns the data if found, or %NULL if no such data exists.
4256
4492
  */
4257
4493
  get_data(key: string): any | null;
4258
- get_property(property_name: string): any;
4494
+ /**
4495
+ * Gets a property of an object.
4496
+ *
4497
+ * The value can be:
4498
+ * - an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
4499
+ * - a GObject.Value initialized with the expected type of the property
4500
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
4501
+ *
4502
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
4503
+ *
4504
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
4505
+ * @param property_name The name of the property to get
4506
+ * @param value Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
4507
+ */
4508
+ get_property(property_name: string, value: GObject.Value | any): any;
4259
4509
  /**
4260
4510
  * This function gets back user data pointers stored via
4261
4511
  * g_object_set_qdata().
@@ -4383,7 +4633,12 @@ export namespace Devhelp {
4383
4633
  * @param data data to associate with that key
4384
4634
  */
4385
4635
  set_data(key: string, data?: any | null): void;
4386
- set_property(property_name: string, value: any): void;
4636
+ /**
4637
+ * Sets a property on an object.
4638
+ * @param property_name The name of the property to set
4639
+ * @param value The value to set the property to
4640
+ */
4641
+ set_property(property_name: string, value: GObject.Value | any): void;
4387
4642
  /**
4388
4643
  * Remove a specified datum from the object's data associations,
4389
4644
  * without invoking the association's destroy handler.
@@ -4533,11 +4788,31 @@ export namespace Devhelp {
4533
4788
  * @param pspec
4534
4789
  */
4535
4790
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
4791
+ /**
4792
+ * Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
4793
+ * @param id Handler ID of the handler to be disconnected
4794
+ */
4536
4795
  disconnect(id: number): void;
4796
+ /**
4797
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
4798
+ * @param properties Object containing the properties to set
4799
+ */
4537
4800
  set(properties: { [key: string]: any }): void;
4538
- block_signal_handler(id: number): any;
4539
- unblock_signal_handler(id: number): any;
4540
- stop_emission_by_name(detailedName: string): any;
4801
+ /**
4802
+ * Blocks a handler of an instance so it will not be called during any signal emissions
4803
+ * @param id Handler ID of the handler to be blocked
4804
+ */
4805
+ block_signal_handler(id: number): void;
4806
+ /**
4807
+ * Unblocks a handler so it will be called again during any signal emissions
4808
+ * @param id Handler ID of the handler to be unblocked
4809
+ */
4810
+ unblock_signal_handler(id: number): void;
4811
+ /**
4812
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
4813
+ * @param detailedName Name of the signal to stop emission of
4814
+ */
4815
+ stop_emission_by_name(detailedName: string): void;
4541
4816
  }
4542
4817
 
4543
4818
  namespace TabLabel {
@@ -4713,7 +4988,21 @@ export namespace Devhelp {
4713
4988
  * @returns the data if found, or %NULL if no such data exists.
4714
4989
  */
4715
4990
  get_data(key: string): any | null;
4716
- get_property(property_name: string): any;
4991
+ /**
4992
+ * Gets a property of an object.
4993
+ *
4994
+ * The value can be:
4995
+ * - an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
4996
+ * - a GObject.Value initialized with the expected type of the property
4997
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
4998
+ *
4999
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
5000
+ *
5001
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
5002
+ * @param property_name The name of the property to get
5003
+ * @param value Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
5004
+ */
5005
+ get_property(property_name: string, value: GObject.Value | any): any;
4717
5006
  /**
4718
5007
  * This function gets back user data pointers stored via
4719
5008
  * g_object_set_qdata().
@@ -4841,7 +5130,12 @@ export namespace Devhelp {
4841
5130
  * @param data data to associate with that key
4842
5131
  */
4843
5132
  set_data(key: string, data?: any | null): void;
4844
- set_property(property_name: string, value: any): void;
5133
+ /**
5134
+ * Sets a property on an object.
5135
+ * @param property_name The name of the property to set
5136
+ * @param value The value to set the property to
5137
+ */
5138
+ set_property(property_name: string, value: GObject.Value | any): void;
4845
5139
  /**
4846
5140
  * Remove a specified datum from the object's data associations,
4847
5141
  * without invoking the association's destroy handler.
@@ -4991,11 +5285,31 @@ export namespace Devhelp {
4991
5285
  * @param pspec
4992
5286
  */
4993
5287
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
5288
+ /**
5289
+ * Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
5290
+ * @param id Handler ID of the handler to be disconnected
5291
+ */
4994
5292
  disconnect(id: number): void;
5293
+ /**
5294
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
5295
+ * @param properties Object containing the properties to set
5296
+ */
4995
5297
  set(properties: { [key: string]: any }): void;
4996
- block_signal_handler(id: number): any;
4997
- unblock_signal_handler(id: number): any;
4998
- stop_emission_by_name(detailedName: string): any;
5298
+ /**
5299
+ * Blocks a handler of an instance so it will not be called during any signal emissions
5300
+ * @param id Handler ID of the handler to be blocked
5301
+ */
5302
+ block_signal_handler(id: number): void;
5303
+ /**
5304
+ * Unblocks a handler so it will be called again during any signal emissions
5305
+ * @param id Handler ID of the handler to be unblocked
5306
+ */
5307
+ unblock_signal_handler(id: number): void;
5308
+ /**
5309
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
5310
+ * @param detailedName Name of the signal to stop emission of
5311
+ */
5312
+ stop_emission_by_name(detailedName: string): void;
4999
5313
  }
5000
5314
 
5001
5315
  namespace WebView {
@@ -5212,7 +5526,21 @@ export namespace Devhelp {
5212
5526
  * @returns the data if found, or %NULL if no such data exists.
5213
5527
  */
5214
5528
  get_data(key: string): any | null;
5215
- get_property(property_name: string): any;
5529
+ /**
5530
+ * Gets a property of an object.
5531
+ *
5532
+ * The value can be:
5533
+ * - an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
5534
+ * - a GObject.Value initialized with the expected type of the property
5535
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
5536
+ *
5537
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
5538
+ *
5539
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
5540
+ * @param property_name The name of the property to get
5541
+ * @param value Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
5542
+ */
5543
+ get_property(property_name: string, value: GObject.Value | any): any;
5216
5544
  /**
5217
5545
  * This function gets back user data pointers stored via
5218
5546
  * g_object_set_qdata().
@@ -5340,7 +5668,12 @@ export namespace Devhelp {
5340
5668
  * @param data data to associate with that key
5341
5669
  */
5342
5670
  set_data(key: string, data?: any | null): void;
5343
- set_property(property_name: string, value: any): void;
5671
+ /**
5672
+ * Sets a property on an object.
5673
+ * @param property_name The name of the property to set
5674
+ * @param value The value to set the property to
5675
+ */
5676
+ set_property(property_name: string, value: GObject.Value | any): void;
5344
5677
  /**
5345
5678
  * Remove a specified datum from the object's data associations,
5346
5679
  * without invoking the association's destroy handler.
@@ -5490,11 +5823,31 @@ export namespace Devhelp {
5490
5823
  * @param pspec
5491
5824
  */
5492
5825
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
5826
+ /**
5827
+ * Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
5828
+ * @param id Handler ID of the handler to be disconnected
5829
+ */
5493
5830
  disconnect(id: number): void;
5831
+ /**
5832
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
5833
+ * @param properties Object containing the properties to set
5834
+ */
5494
5835
  set(properties: { [key: string]: any }): void;
5495
- block_signal_handler(id: number): any;
5496
- unblock_signal_handler(id: number): any;
5497
- stop_emission_by_name(detailedName: string): any;
5836
+ /**
5837
+ * Blocks a handler of an instance so it will not be called during any signal emissions
5838
+ * @param id Handler ID of the handler to be blocked
5839
+ */
5840
+ block_signal_handler(id: number): void;
5841
+ /**
5842
+ * Unblocks a handler so it will be called again during any signal emissions
5843
+ * @param id Handler ID of the handler to be unblocked
5844
+ */
5845
+ unblock_signal_handler(id: number): void;
5846
+ /**
5847
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
5848
+ * @param detailedName Name of the signal to stop emission of
5849
+ */
5850
+ stop_emission_by_name(detailedName: string): void;
5498
5851
  }
5499
5852
 
5500
5853
  type AssistantViewClass = typeof AssistantView;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/devhelp-3.0",
3
- "version": "3.0.0-4.0.0-beta.20",
3
+ "version": "3.0.0-4.0.0-beta.23",
4
4
  "description": "GJS TypeScript type definitions for Devhelp-3.0, generated from library version 3.0.0",
5
5
  "type": "module",
6
6
  "module": "devhelp-3.0.js",
@@ -31,23 +31,23 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/atk-1.0": "^2.54.0-4.0.0-beta.20",
35
- "@girs/cairo-1.0": "^1.0.0-4.0.0-beta.20",
36
- "@girs/freetype2-2.0": "^2.0.0-4.0.0-beta.20",
37
- "@girs/gdk-3.0": "^3.24.48-4.0.0-beta.20",
38
- "@girs/gdkpixbuf-2.0": "^2.0.0-4.0.0-beta.20",
39
- "@girs/gio-2.0": "^2.82.4-4.0.0-beta.20",
40
- "@girs/gjs": "^4.0.0-beta.20",
41
- "@girs/glib-2.0": "^2.82.4-4.0.0-beta.20",
42
- "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.20",
43
- "@girs/gobject-2.0": "^2.82.4-4.0.0-beta.20",
44
- "@girs/gtk-3.0": "^3.24.48-4.0.0-beta.20",
45
- "@girs/harfbuzz-0.0": "^9.0.0-4.0.0-beta.20",
46
- "@girs/javascriptcore-4.1": "^2.46.0-4.0.0-beta.20",
47
- "@girs/pango-1.0": "^1.54.0-4.0.0-beta.20",
48
- "@girs/soup-3.0": "^3.6.0-4.0.0-beta.20",
49
- "@girs/webkit2-4.1": "^2.46.0-4.0.0-beta.20",
50
- "@girs/xlib-2.0": "^2.0.0-4.0.0-beta.20"
34
+ "@girs/atk-1.0": "^2.56.0-4.0.0-beta.23",
35
+ "@girs/cairo-1.0": "^1.0.0-4.0.0-beta.23",
36
+ "@girs/freetype2-2.0": "^2.0.0-4.0.0-beta.23",
37
+ "@girs/gdk-3.0": "^3.24.50-4.0.0-beta.23",
38
+ "@girs/gdkpixbuf-2.0": "^2.0.0-4.0.0-beta.23",
39
+ "@girs/gio-2.0": "^2.84.0-4.0.0-beta.23",
40
+ "@girs/gjs": "^4.0.0-beta.23",
41
+ "@girs/glib-2.0": "^2.84.0-4.0.0-beta.23",
42
+ "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.23",
43
+ "@girs/gobject-2.0": "^2.84.0-4.0.0-beta.23",
44
+ "@girs/gtk-3.0": "^3.24.50-4.0.0-beta.23",
45
+ "@girs/harfbuzz-0.0": "^9.0.0-4.0.0-beta.23",
46
+ "@girs/javascriptcore-4.1": "^2.48.0-4.0.0-beta.23",
47
+ "@girs/pango-1.0": "^1.56.4-4.0.0-beta.23",
48
+ "@girs/soup-3.0": "^3.6.4-4.0.0-beta.23",
49
+ "@girs/webkit2-4.1": "^2.48.0-4.0.0-beta.23",
50
+ "@girs/xlib-2.0": "^2.0.0-4.0.0-beta.23"
51
51
  },
52
52
  "devDependencies": {
53
53
  "typescript": "*"