@girs/fprint-2.0 2.0.0-4.0.0-beta.21 → 2.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.
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/fprint-2.0)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for FPrint-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.21.
8
+ GJS TypeScript type definitions for FPrint-2.0, generated from library version 2.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/fprint-2.0.d.ts CHANGED
@@ -7,6 +7,8 @@
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 Gio from '@girs/gio-2.0';
12
14
  import type GObject from '@girs/gobject-2.0';
@@ -1415,7 +1417,21 @@ export namespace FPrint {
1415
1417
  * @returns the data if found, or %NULL if no such data exists.
1416
1418
  */
1417
1419
  get_data(key: string): any | null;
1418
- get_property(property_name: string): any;
1420
+ /**
1421
+ * Gets a property of an object.
1422
+ *
1423
+ * The value can be:
1424
+ * - 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)
1425
+ * - a GObject.Value initialized with the expected type of the property
1426
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
1427
+ *
1428
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
1429
+ *
1430
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
1431
+ * @param property_name The name of the property to get
1432
+ * @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
1433
+ */
1434
+ get_property(property_name: string, value: GObject.Value | any): any;
1419
1435
  /**
1420
1436
  * This function gets back user data pointers stored via
1421
1437
  * g_object_set_qdata().
@@ -1543,7 +1559,12 @@ export namespace FPrint {
1543
1559
  * @param data data to associate with that key
1544
1560
  */
1545
1561
  set_data(key: string, data?: any | null): void;
1546
- set_property(property_name: string, value: any): void;
1562
+ /**
1563
+ * Sets a property on an object.
1564
+ * @param property_name The name of the property to set
1565
+ * @param value The value to set the property to
1566
+ */
1567
+ set_property(property_name: string, value: GObject.Value | any): void;
1547
1568
  /**
1548
1569
  * Remove a specified datum from the object's data associations,
1549
1570
  * without invoking the association's destroy handler.
@@ -1693,11 +1714,31 @@ export namespace FPrint {
1693
1714
  * @param pspec
1694
1715
  */
1695
1716
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
1717
+ /**
1718
+ * 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.
1719
+ * @param id Handler ID of the handler to be disconnected
1720
+ */
1696
1721
  disconnect(id: number): void;
1722
+ /**
1723
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
1724
+ * @param properties Object containing the properties to set
1725
+ */
1697
1726
  set(properties: { [key: string]: any }): void;
1698
- block_signal_handler(id: number): any;
1699
- unblock_signal_handler(id: number): any;
1700
- stop_emission_by_name(detailedName: string): any;
1727
+ /**
1728
+ * Blocks a handler of an instance so it will not be called during any signal emissions
1729
+ * @param id Handler ID of the handler to be blocked
1730
+ */
1731
+ block_signal_handler(id: number): void;
1732
+ /**
1733
+ * Unblocks a handler so it will be called again during any signal emissions
1734
+ * @param id Handler ID of the handler to be unblocked
1735
+ */
1736
+ unblock_signal_handler(id: number): void;
1737
+ /**
1738
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
1739
+ * @param detailedName Name of the signal to stop emission of
1740
+ */
1741
+ stop_emission_by_name(detailedName: string): void;
1701
1742
  }
1702
1743
 
1703
1744
  namespace Image {
@@ -2146,7 +2187,21 @@ export namespace FPrint {
2146
2187
  * @returns the data if found, or %NULL if no such data exists.
2147
2188
  */
2148
2189
  get_data(key: string): any | null;
2149
- get_property(property_name: string): any;
2190
+ /**
2191
+ * Gets a property of an object.
2192
+ *
2193
+ * The value can be:
2194
+ * - 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)
2195
+ * - a GObject.Value initialized with the expected type of the property
2196
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
2197
+ *
2198
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
2199
+ *
2200
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
2201
+ * @param property_name The name of the property to get
2202
+ * @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
2203
+ */
2204
+ get_property(property_name: string, value: GObject.Value | any): any;
2150
2205
  /**
2151
2206
  * This function gets back user data pointers stored via
2152
2207
  * g_object_set_qdata().
@@ -2274,7 +2329,12 @@ export namespace FPrint {
2274
2329
  * @param data data to associate with that key
2275
2330
  */
2276
2331
  set_data(key: string, data?: any | null): void;
2277
- set_property(property_name: string, value: any): void;
2332
+ /**
2333
+ * Sets a property on an object.
2334
+ * @param property_name The name of the property to set
2335
+ * @param value The value to set the property to
2336
+ */
2337
+ set_property(property_name: string, value: GObject.Value | any): void;
2278
2338
  /**
2279
2339
  * Remove a specified datum from the object's data associations,
2280
2340
  * without invoking the association's destroy handler.
@@ -2424,11 +2484,31 @@ export namespace FPrint {
2424
2484
  * @param pspec
2425
2485
  */
2426
2486
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
2487
+ /**
2488
+ * 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.
2489
+ * @param id Handler ID of the handler to be disconnected
2490
+ */
2427
2491
  disconnect(id: number): void;
2492
+ /**
2493
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
2494
+ * @param properties Object containing the properties to set
2495
+ */
2428
2496
  set(properties: { [key: string]: any }): void;
2429
- block_signal_handler(id: number): any;
2430
- unblock_signal_handler(id: number): any;
2431
- stop_emission_by_name(detailedName: string): any;
2497
+ /**
2498
+ * Blocks a handler of an instance so it will not be called during any signal emissions
2499
+ * @param id Handler ID of the handler to be blocked
2500
+ */
2501
+ block_signal_handler(id: number): void;
2502
+ /**
2503
+ * Unblocks a handler so it will be called again during any signal emissions
2504
+ * @param id Handler ID of the handler to be unblocked
2505
+ */
2506
+ unblock_signal_handler(id: number): void;
2507
+ /**
2508
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
2509
+ * @param detailedName Name of the signal to stop emission of
2510
+ */
2511
+ stop_emission_by_name(detailedName: string): void;
2432
2512
  }
2433
2513
 
2434
2514
  namespace Print {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/fprint-2.0",
3
- "version": "2.0.0-4.0.0-beta.21",
3
+ "version": "2.0.0-4.0.0-beta.23",
4
4
  "description": "GJS TypeScript type definitions for FPrint-2.0, generated from library version 2.0.0",
5
5
  "type": "module",
6
6
  "module": "fprint-2.0.js",
@@ -31,13 +31,13 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gio-2.0": "^2.83.3-4.0.0-beta.21",
35
- "@girs/gjs": "^4.0.0-beta.21",
36
- "@girs/glib-2.0": "^2.83.3-4.0.0-beta.21",
37
- "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.21",
38
- "@girs/gobject-2.0": "^2.83.3-4.0.0-beta.21",
39
- "@girs/gusb-1.0": "^0.4.9-4.0.0-beta.21",
40
- "@girs/json-1.0": "^1.10.7-4.0.0-beta.21"
34
+ "@girs/gio-2.0": "^2.84.0-4.0.0-beta.23",
35
+ "@girs/gjs": "^4.0.0-beta.23",
36
+ "@girs/glib-2.0": "^2.84.0-4.0.0-beta.23",
37
+ "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.23",
38
+ "@girs/gobject-2.0": "^2.84.0-4.0.0-beta.23",
39
+ "@girs/gusb-1.0": "^0.4.9-4.0.0-beta.23",
40
+ "@girs/json-1.0": "^1.10.7-4.0.0-beta.23"
41
41
  },
42
42
  "devDependencies": {
43
43
  "typescript": "*"