@girs/tracker-3.0 3.9.0-4.0.0-beta.21 → 3.9.1-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/tracker-3.0)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Tracker-3.0, generated from library version 3.9.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.21.
8
+ GJS TypeScript type definitions for Tracker-3.0, generated from library version 3.9.1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.23.
9
9
 
10
10
 
11
11
  ## Install
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@girs/tracker-3.0",
3
- "version": "3.9.0-4.0.0-beta.21",
4
- "description": "GJS TypeScript type definitions for Tracker-3.0, generated from library version 3.9.0",
3
+ "version": "3.9.1-4.0.0-beta.23",
4
+ "description": "GJS TypeScript type definitions for Tracker-3.0, generated from library version 3.9.1",
5
5
  "type": "module",
6
6
  "module": "tracker-3.0.js",
7
7
  "main": "tracker-3.0.js",
@@ -31,11 +31,11 @@
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"
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
39
  },
40
40
  "devDependencies": {
41
41
  "typescript": "*"
package/tracker-3.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';
@@ -869,7 +871,7 @@ export namespace Tracker {
869
871
  * If the object is not initialized, or initialization returns with an
870
872
  * error, then all operations on the object except g_object_ref() and
871
873
  * g_object_unref() are considered to be invalid, and have undefined
872
- * behaviour. See the [introduction][ginitable] for more details.
874
+ * behaviour. See the [description][iface`Gio`.Initable#description] for more details.
873
875
  *
874
876
  * Callers should not assume that a class which implements #GInitable can be
875
877
  * initialized multiple times, unless the class explicitly documents itself as
@@ -912,7 +914,7 @@ export namespace Tracker {
912
914
  * If the object is not initialized, or initialization returns with an
913
915
  * error, then all operations on the object except g_object_ref() and
914
916
  * g_object_unref() are considered to be invalid, and have undefined
915
- * behaviour. See the [introduction][ginitable] for more details.
917
+ * behaviour. See the [description][iface`Gio`.Initable#description] for more details.
916
918
  *
917
919
  * Callers should not assume that a class which implements #GInitable can be
918
920
  * initialized multiple times, unless the class explicitly documents itself as
@@ -1052,7 +1054,21 @@ export namespace Tracker {
1052
1054
  * @returns the data if found, or %NULL if no such data exists.
1053
1055
  */
1054
1056
  get_data(key: string): any | null;
1055
- get_property(property_name: string): any;
1057
+ /**
1058
+ * Gets a property of an object.
1059
+ *
1060
+ * The value can be:
1061
+ * - 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)
1062
+ * - a GObject.Value initialized with the expected type of the property
1063
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
1064
+ *
1065
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
1066
+ *
1067
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
1068
+ * @param property_name The name of the property to get
1069
+ * @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
1070
+ */
1071
+ get_property(property_name: string, value: GObject.Value | any): any;
1056
1072
  /**
1057
1073
  * This function gets back user data pointers stored via
1058
1074
  * g_object_set_qdata().
@@ -1180,7 +1196,12 @@ export namespace Tracker {
1180
1196
  * @param data data to associate with that key
1181
1197
  */
1182
1198
  set_data(key: string, data?: any | null): void;
1183
- set_property(property_name: string, value: any): void;
1199
+ /**
1200
+ * Sets a property on an object.
1201
+ * @param property_name The name of the property to set
1202
+ * @param value The value to set the property to
1203
+ */
1204
+ set_property(property_name: string, value: GObject.Value | any): void;
1184
1205
  /**
1185
1206
  * Remove a specified datum from the object's data associations,
1186
1207
  * without invoking the association's destroy handler.
@@ -1330,11 +1351,31 @@ export namespace Tracker {
1330
1351
  * @param pspec
1331
1352
  */
1332
1353
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
1354
+ /**
1355
+ * 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.
1356
+ * @param id Handler ID of the handler to be disconnected
1357
+ */
1333
1358
  disconnect(id: number): void;
1359
+ /**
1360
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
1361
+ * @param properties Object containing the properties to set
1362
+ */
1334
1363
  set(properties: { [key: string]: any }): void;
1335
- block_signal_handler(id: number): any;
1336
- unblock_signal_handler(id: number): any;
1337
- stop_emission_by_name(detailedName: string): any;
1364
+ /**
1365
+ * Blocks a handler of an instance so it will not be called during any signal emissions
1366
+ * @param id Handler ID of the handler to be blocked
1367
+ */
1368
+ block_signal_handler(id: number): void;
1369
+ /**
1370
+ * Unblocks a handler so it will be called again during any signal emissions
1371
+ * @param id Handler ID of the handler to be unblocked
1372
+ */
1373
+ unblock_signal_handler(id: number): void;
1374
+ /**
1375
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
1376
+ * @param detailedName Name of the signal to stop emission of
1377
+ */
1378
+ stop_emission_by_name(detailedName: string): void;
1338
1379
  }
1339
1380
 
1340
1381
  namespace EndpointHttp {
@@ -1465,7 +1506,7 @@ export namespace Tracker {
1465
1506
  * If the object is not initialized, or initialization returns with an
1466
1507
  * error, then all operations on the object except g_object_ref() and
1467
1508
  * g_object_unref() are considered to be invalid, and have undefined
1468
- * behaviour. See the [introduction][ginitable] for more details.
1509
+ * behaviour. See the [description][iface`Gio`.Initable#description] for more details.
1469
1510
  *
1470
1511
  * Callers should not assume that a class which implements #GInitable can be
1471
1512
  * initialized multiple times, unless the class explicitly documents itself as
@@ -1508,7 +1549,7 @@ export namespace Tracker {
1508
1549
  * If the object is not initialized, or initialization returns with an
1509
1550
  * error, then all operations on the object except g_object_ref() and
1510
1551
  * g_object_unref() are considered to be invalid, and have undefined
1511
- * behaviour. See the [introduction][ginitable] for more details.
1552
+ * behaviour. See the [description][iface`Gio`.Initable#description] for more details.
1512
1553
  *
1513
1554
  * Callers should not assume that a class which implements #GInitable can be
1514
1555
  * initialized multiple times, unless the class explicitly documents itself as
@@ -1648,7 +1689,21 @@ export namespace Tracker {
1648
1689
  * @returns the data if found, or %NULL if no such data exists.
1649
1690
  */
1650
1691
  get_data(key: string): any | null;
1651
- get_property(property_name: string): any;
1692
+ /**
1693
+ * Gets a property of an object.
1694
+ *
1695
+ * The value can be:
1696
+ * - 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)
1697
+ * - a GObject.Value initialized with the expected type of the property
1698
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
1699
+ *
1700
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
1701
+ *
1702
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
1703
+ * @param property_name The name of the property to get
1704
+ * @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
1705
+ */
1706
+ get_property(property_name: string, value: GObject.Value | any): any;
1652
1707
  /**
1653
1708
  * This function gets back user data pointers stored via
1654
1709
  * g_object_set_qdata().
@@ -1776,7 +1831,12 @@ export namespace Tracker {
1776
1831
  * @param data data to associate with that key
1777
1832
  */
1778
1833
  set_data(key: string, data?: any | null): void;
1779
- set_property(property_name: string, value: any): void;
1834
+ /**
1835
+ * Sets a property on an object.
1836
+ * @param property_name The name of the property to set
1837
+ * @param value The value to set the property to
1838
+ */
1839
+ set_property(property_name: string, value: GObject.Value | any): void;
1780
1840
  /**
1781
1841
  * Remove a specified datum from the object's data associations,
1782
1842
  * without invoking the association's destroy handler.
@@ -1926,11 +1986,31 @@ export namespace Tracker {
1926
1986
  * @param pspec
1927
1987
  */
1928
1988
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
1989
+ /**
1990
+ * 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.
1991
+ * @param id Handler ID of the handler to be disconnected
1992
+ */
1929
1993
  disconnect(id: number): void;
1994
+ /**
1995
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
1996
+ * @param properties Object containing the properties to set
1997
+ */
1930
1998
  set(properties: { [key: string]: any }): void;
1931
- block_signal_handler(id: number): any;
1932
- unblock_signal_handler(id: number): any;
1933
- stop_emission_by_name(detailedName: string): any;
1999
+ /**
2000
+ * Blocks a handler of an instance so it will not be called during any signal emissions
2001
+ * @param id Handler ID of the handler to be blocked
2002
+ */
2003
+ block_signal_handler(id: number): void;
2004
+ /**
2005
+ * Unblocks a handler so it will be called again during any signal emissions
2006
+ * @param id Handler ID of the handler to be unblocked
2007
+ */
2008
+ unblock_signal_handler(id: number): void;
2009
+ /**
2010
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
2011
+ * @param detailedName Name of the signal to stop emission of
2012
+ */
2013
+ stop_emission_by_name(detailedName: string): void;
1934
2014
  }
1935
2015
 
1936
2016
  namespace NamespaceManager {