@girs/osmgpsmap-1.0 1.0.0-4.0.0-beta.21 → 1.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/osmgpsmap-1.0)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for OsmGpsMap-1.0, generated from library version 1.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.21.
8
+ GJS TypeScript type definitions for OsmGpsMap-1.0, generated from library version 1.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
@@ -7,11 +7,13 @@
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 Gtk from '@girs/gtk-3.0';
12
14
  import type xlib from '@girs/xlib-2.0';
13
15
  import type Gdk from '@girs/gdk-3.0';
14
- import type cairo from '@girs/cairo-1.0';
16
+ import type cairo from 'cairo';
15
17
  import type GObject from '@girs/gobject-2.0';
16
18
  import type GLib from '@girs/glib-2.0';
17
19
  import type Pango from '@girs/pango-1.0';
@@ -681,7 +683,21 @@ export namespace OsmGpsMap {
681
683
  * @returns the data if found, or %NULL if no such data exists.
682
684
  */
683
685
  get_data(key: string): any | null;
684
- get_property(property_name: string): any;
686
+ /**
687
+ * Gets a property of an object.
688
+ *
689
+ * The value can be:
690
+ * - 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)
691
+ * - a GObject.Value initialized with the expected type of the property
692
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
693
+ *
694
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
695
+ *
696
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
697
+ * @param property_name The name of the property to get
698
+ * @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
699
+ */
700
+ get_property(property_name: string, value: GObject.Value | any): any;
685
701
  /**
686
702
  * This function gets back user data pointers stored via
687
703
  * g_object_set_qdata().
@@ -809,7 +825,12 @@ export namespace OsmGpsMap {
809
825
  * @param data data to associate with that key
810
826
  */
811
827
  set_data(key: string, data?: any | null): void;
812
- set_property(property_name: string, value: any): void;
828
+ /**
829
+ * Sets a property on an object.
830
+ * @param property_name The name of the property to set
831
+ * @param value The value to set the property to
832
+ */
833
+ set_property(property_name: string, value: GObject.Value | any): void;
813
834
  /**
814
835
  * Remove a specified datum from the object's data associations,
815
836
  * without invoking the association's destroy handler.
@@ -959,11 +980,31 @@ export namespace OsmGpsMap {
959
980
  * @param pspec
960
981
  */
961
982
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
983
+ /**
984
+ * 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.
985
+ * @param id Handler ID of the handler to be disconnected
986
+ */
962
987
  disconnect(id: number): void;
988
+ /**
989
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
990
+ * @param properties Object containing the properties to set
991
+ */
963
992
  set(properties: { [key: string]: any }): void;
964
- block_signal_handler(id: number): any;
965
- unblock_signal_handler(id: number): any;
966
- stop_emission_by_name(detailedName: string): any;
993
+ /**
994
+ * Blocks a handler of an instance so it will not be called during any signal emissions
995
+ * @param id Handler ID of the handler to be blocked
996
+ */
997
+ block_signal_handler(id: number): void;
998
+ /**
999
+ * Unblocks a handler so it will be called again during any signal emissions
1000
+ * @param id Handler ID of the handler to be unblocked
1001
+ */
1002
+ unblock_signal_handler(id: number): void;
1003
+ /**
1004
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
1005
+ * @param detailedName Name of the signal to stop emission of
1006
+ */
1007
+ stop_emission_by_name(detailedName: string): void;
967
1008
  }
968
1009
 
969
1010
  namespace MapImage {
@@ -1290,7 +1331,21 @@ export namespace OsmGpsMap {
1290
1331
  * @returns the data if found, or %NULL if no such data exists.
1291
1332
  */
1292
1333
  get_data(key: string): any | null;
1293
- get_property(property_name: string): any;
1334
+ /**
1335
+ * Gets a property of an object.
1336
+ *
1337
+ * The value can be:
1338
+ * - 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)
1339
+ * - a GObject.Value initialized with the expected type of the property
1340
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
1341
+ *
1342
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
1343
+ *
1344
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
1345
+ * @param property_name The name of the property to get
1346
+ * @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
1347
+ */
1348
+ get_property(property_name: string, value: GObject.Value | any): any;
1294
1349
  /**
1295
1350
  * This function gets back user data pointers stored via
1296
1351
  * g_object_set_qdata().
@@ -1418,7 +1473,12 @@ export namespace OsmGpsMap {
1418
1473
  * @param data data to associate with that key
1419
1474
  */
1420
1475
  set_data(key: string, data?: any | null): void;
1421
- set_property(property_name: string, value: any): void;
1476
+ /**
1477
+ * Sets a property on an object.
1478
+ * @param property_name The name of the property to set
1479
+ * @param value The value to set the property to
1480
+ */
1481
+ set_property(property_name: string, value: GObject.Value | any): void;
1422
1482
  /**
1423
1483
  * Remove a specified datum from the object's data associations,
1424
1484
  * without invoking the association's destroy handler.
@@ -1568,11 +1628,31 @@ export namespace OsmGpsMap {
1568
1628
  * @param pspec
1569
1629
  */
1570
1630
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
1631
+ /**
1632
+ * 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.
1633
+ * @param id Handler ID of the handler to be disconnected
1634
+ */
1571
1635
  disconnect(id: number): void;
1636
+ /**
1637
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
1638
+ * @param properties Object containing the properties to set
1639
+ */
1572
1640
  set(properties: { [key: string]: any }): void;
1573
- block_signal_handler(id: number): any;
1574
- unblock_signal_handler(id: number): any;
1575
- stop_emission_by_name(detailedName: string): any;
1641
+ /**
1642
+ * Blocks a handler of an instance so it will not be called during any signal emissions
1643
+ * @param id Handler ID of the handler to be blocked
1644
+ */
1645
+ block_signal_handler(id: number): void;
1646
+ /**
1647
+ * Unblocks a handler so it will be called again during any signal emissions
1648
+ * @param id Handler ID of the handler to be unblocked
1649
+ */
1650
+ unblock_signal_handler(id: number): void;
1651
+ /**
1652
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
1653
+ * @param detailedName Name of the signal to stop emission of
1654
+ */
1655
+ stop_emission_by_name(detailedName: string): void;
1576
1656
  }
1577
1657
 
1578
1658
  namespace MapPolygon {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/osmgpsmap-1.0",
3
- "version": "1.0.0-4.0.0-beta.21",
3
+ "version": "1.0.0-4.0.0-beta.23",
4
4
  "description": "GJS TypeScript type definitions for OsmGpsMap-1.0, generated from library version 1.0.0",
5
5
  "type": "module",
6
6
  "module": "osmgpsmap-1.0.js",
@@ -31,20 +31,20 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/atk-1.0": "^2.55.2-4.0.0-beta.21",
35
- "@girs/cairo-1.0": "^1.0.0-4.0.0-beta.21",
36
- "@girs/freetype2-2.0": "^2.0.0-4.0.0-beta.21",
37
- "@girs/gdk-3.0": "^3.24.48-4.0.0-beta.21",
38
- "@girs/gdkpixbuf-2.0": "^2.0.0-4.0.0-beta.21",
39
- "@girs/gio-2.0": "^2.83.3-4.0.0-beta.21",
40
- "@girs/gjs": "^4.0.0-beta.21",
41
- "@girs/glib-2.0": "^2.83.3-4.0.0-beta.21",
42
- "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.21",
43
- "@girs/gobject-2.0": "^2.83.3-4.0.0-beta.21",
44
- "@girs/gtk-3.0": "^3.24.48-4.0.0-beta.21",
45
- "@girs/harfbuzz-0.0": "^9.0.0-4.0.0-beta.21",
46
- "@girs/pango-1.0": "^1.56.0-4.0.0-beta.21",
47
- "@girs/xlib-2.0": "^2.0.0-4.0.0-beta.21"
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/pango-1.0": "^1.56.4-4.0.0-beta.23",
47
+ "@girs/xlib-2.0": "^2.0.0-4.0.0-beta.23"
48
48
  },
49
49
  "devDependencies": {
50
50
  "typescript": "*"