@girs/gepub-0.7 0.7.0-4.0.0-beta.21 → 0.7.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/gepub-0.7.d.ts +93 -13
  3. package/package.json +19 -19
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/gepub-0.7)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Gepub-0.7, generated from library version 0.7.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.21.
8
+ GJS TypeScript type definitions for Gepub-0.7, generated from library version 0.7.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/gepub-0.7.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 libxml2 from '@girs/libxml2-2.0';
12
14
  import type WebKit2 from '@girs/webkit2-4.1';
@@ -19,7 +21,7 @@ import type JavaScriptCore from '@girs/javascriptcore-4.1';
19
21
  import type Gtk from '@girs/gtk-3.0';
20
22
  import type xlib from '@girs/xlib-2.0';
21
23
  import type Gdk from '@girs/gdk-3.0';
22
- import type cairo from '@girs/cairo-1.0';
24
+ import type cairo from 'cairo';
23
25
  import type Pango from '@girs/pango-1.0';
24
26
  import type HarfBuzz from '@girs/harfbuzz-0.0';
25
27
  import type freetype2 from '@girs/freetype2-2.0';
@@ -186,7 +188,7 @@ export namespace Gepub {
186
188
  * If the object is not initialized, or initialization returns with an
187
189
  * error, then all operations on the object except g_object_ref() and
188
190
  * g_object_unref() are considered to be invalid, and have undefined
189
- * behaviour. See the [introduction][ginitable] for more details.
191
+ * behaviour. See the [description][iface`Gio`.Initable#description] for more details.
190
192
  *
191
193
  * Callers should not assume that a class which implements #GInitable can be
192
194
  * initialized multiple times, unless the class explicitly documents itself as
@@ -229,7 +231,7 @@ export namespace Gepub {
229
231
  * If the object is not initialized, or initialization returns with an
230
232
  * error, then all operations on the object except g_object_ref() and
231
233
  * g_object_unref() are considered to be invalid, and have undefined
232
- * behaviour. See the [introduction][ginitable] for more details.
234
+ * behaviour. See the [description][iface`Gio`.Initable#description] for more details.
233
235
  *
234
236
  * Callers should not assume that a class which implements #GInitable can be
235
237
  * initialized multiple times, unless the class explicitly documents itself as
@@ -369,7 +371,21 @@ export namespace Gepub {
369
371
  * @returns the data if found, or %NULL if no such data exists.
370
372
  */
371
373
  get_data(key: string): any | null;
372
- get_property(property_name: string): any;
374
+ /**
375
+ * Gets a property of an object.
376
+ *
377
+ * The value can be:
378
+ * - 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)
379
+ * - a GObject.Value initialized with the expected type of the property
380
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
381
+ *
382
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
383
+ *
384
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
385
+ * @param property_name The name of the property to get
386
+ * @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
387
+ */
388
+ get_property(property_name: string, value: GObject.Value | any): any;
373
389
  /**
374
390
  * This function gets back user data pointers stored via
375
391
  * g_object_set_qdata().
@@ -497,7 +513,12 @@ export namespace Gepub {
497
513
  * @param data data to associate with that key
498
514
  */
499
515
  set_data(key: string, data?: any | null): void;
500
- set_property(property_name: string, value: any): void;
516
+ /**
517
+ * Sets a property on an object.
518
+ * @param property_name The name of the property to set
519
+ * @param value The value to set the property to
520
+ */
521
+ set_property(property_name: string, value: GObject.Value | any): void;
501
522
  /**
502
523
  * Remove a specified datum from the object's data associations,
503
524
  * without invoking the association's destroy handler.
@@ -647,11 +668,31 @@ export namespace Gepub {
647
668
  * @param pspec
648
669
  */
649
670
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
671
+ /**
672
+ * 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.
673
+ * @param id Handler ID of the handler to be disconnected
674
+ */
650
675
  disconnect(id: number): void;
676
+ /**
677
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
678
+ * @param properties Object containing the properties to set
679
+ */
651
680
  set(properties: { [key: string]: any }): void;
652
- block_signal_handler(id: number): any;
653
- unblock_signal_handler(id: number): any;
654
- stop_emission_by_name(detailedName: string): any;
681
+ /**
682
+ * Blocks a handler of an instance so it will not be called during any signal emissions
683
+ * @param id Handler ID of the handler to be blocked
684
+ */
685
+ block_signal_handler(id: number): void;
686
+ /**
687
+ * Unblocks a handler so it will be called again during any signal emissions
688
+ * @param id Handler ID of the handler to be unblocked
689
+ */
690
+ unblock_signal_handler(id: number): void;
691
+ /**
692
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
693
+ * @param detailedName Name of the signal to stop emission of
694
+ */
695
+ stop_emission_by_name(detailedName: string): void;
655
696
  }
656
697
 
657
698
  namespace TextChunk {
@@ -911,7 +952,21 @@ export namespace Gepub {
911
952
  * @returns the data if found, or %NULL if no such data exists.
912
953
  */
913
954
  get_data(key: string): any | null;
914
- get_property(property_name: string): any;
955
+ /**
956
+ * Gets a property of an object.
957
+ *
958
+ * The value can be:
959
+ * - 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)
960
+ * - a GObject.Value initialized with the expected type of the property
961
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
962
+ *
963
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
964
+ *
965
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
966
+ * @param property_name The name of the property to get
967
+ * @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
968
+ */
969
+ get_property(property_name: string, value: GObject.Value | any): any;
915
970
  /**
916
971
  * This function gets back user data pointers stored via
917
972
  * g_object_set_qdata().
@@ -1039,7 +1094,12 @@ export namespace Gepub {
1039
1094
  * @param data data to associate with that key
1040
1095
  */
1041
1096
  set_data(key: string, data?: any | null): void;
1042
- set_property(property_name: string, value: any): void;
1097
+ /**
1098
+ * Sets a property on an object.
1099
+ * @param property_name The name of the property to set
1100
+ * @param value The value to set the property to
1101
+ */
1102
+ set_property(property_name: string, value: GObject.Value | any): void;
1043
1103
  /**
1044
1104
  * Remove a specified datum from the object's data associations,
1045
1105
  * without invoking the association's destroy handler.
@@ -1189,11 +1249,31 @@ export namespace Gepub {
1189
1249
  * @param pspec
1190
1250
  */
1191
1251
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
1252
+ /**
1253
+ * 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.
1254
+ * @param id Handler ID of the handler to be disconnected
1255
+ */
1192
1256
  disconnect(id: number): void;
1257
+ /**
1258
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
1259
+ * @param properties Object containing the properties to set
1260
+ */
1193
1261
  set(properties: { [key: string]: any }): void;
1194
- block_signal_handler(id: number): any;
1195
- unblock_signal_handler(id: number): any;
1196
- stop_emission_by_name(detailedName: string): any;
1262
+ /**
1263
+ * Blocks a handler of an instance so it will not be called during any signal emissions
1264
+ * @param id Handler ID of the handler to be blocked
1265
+ */
1266
+ block_signal_handler(id: number): void;
1267
+ /**
1268
+ * Unblocks a handler so it will be called again during any signal emissions
1269
+ * @param id Handler ID of the handler to be unblocked
1270
+ */
1271
+ unblock_signal_handler(id: number): void;
1272
+ /**
1273
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
1274
+ * @param detailedName Name of the signal to stop emission of
1275
+ */
1276
+ stop_emission_by_name(detailedName: string): void;
1197
1277
  }
1198
1278
 
1199
1279
  type ArchiveClass = typeof Archive;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/gepub-0.7",
3
- "version": "0.7.0-4.0.0-beta.21",
3
+ "version": "0.7.0-4.0.0-beta.23",
4
4
  "description": "GJS TypeScript type definitions for Gepub-0.7, generated from library version 0.7.0",
5
5
  "type": "module",
6
6
  "module": "gepub-0.7.js",
@@ -31,24 +31,24 @@
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/javascriptcore-4.1": "^2.47.3-4.0.0-beta.21",
47
- "@girs/libxml2-2.0": "^2.0.0-4.0.0-beta.21",
48
- "@girs/pango-1.0": "^1.56.0-4.0.0-beta.21",
49
- "@girs/soup-3.0": "^3.6.4-4.0.0-beta.21",
50
- "@girs/webkit2-4.1": "^2.47.3-4.0.0-beta.21",
51
- "@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/javascriptcore-4.1": "^2.48.0-4.0.0-beta.23",
47
+ "@girs/libxml2-2.0": "^2.0.0-4.0.0-beta.23",
48
+ "@girs/pango-1.0": "^1.56.4-4.0.0-beta.23",
49
+ "@girs/soup-3.0": "^3.6.4-4.0.0-beta.23",
50
+ "@girs/webkit2-4.1": "^2.48.0-4.0.0-beta.23",
51
+ "@girs/xlib-2.0": "^2.0.0-4.0.0-beta.23"
52
52
  },
53
53
  "devDependencies": {
54
54
  "typescript": "*"