@girs/gepub-0.5 0.5.0-4.0.0-beta.21 → 0.5.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.5.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.5)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Gepub-0.5, generated from library version 0.5.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.5, generated from library version 0.5.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.5.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.0';
@@ -19,7 +21,7 @@ import type JavaScriptCore from '@girs/javascriptcore-4.0';
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';
@@ -123,7 +125,7 @@ export namespace Gepub {
123
125
  * If the object is not initialized, or initialization returns with an
124
126
  * error, then all operations on the object except g_object_ref() and
125
127
  * g_object_unref() are considered to be invalid, and have undefined
126
- * behaviour. See the [introduction][ginitable] for more details.
128
+ * behaviour. See the [description][iface`Gio`.Initable#description] for more details.
127
129
  *
128
130
  * Callers should not assume that a class which implements #GInitable can be
129
131
  * initialized multiple times, unless the class explicitly documents itself as
@@ -166,7 +168,7 @@ export namespace Gepub {
166
168
  * If the object is not initialized, or initialization returns with an
167
169
  * error, then all operations on the object except g_object_ref() and
168
170
  * g_object_unref() are considered to be invalid, and have undefined
169
- * behaviour. See the [introduction][ginitable] for more details.
171
+ * behaviour. See the [description][iface`Gio`.Initable#description] for more details.
170
172
  *
171
173
  * Callers should not assume that a class which implements #GInitable can be
172
174
  * initialized multiple times, unless the class explicitly documents itself as
@@ -306,7 +308,21 @@ export namespace Gepub {
306
308
  * @returns the data if found, or %NULL if no such data exists.
307
309
  */
308
310
  get_data(key: string): any | null;
309
- get_property(property_name: string): any;
311
+ /**
312
+ * Gets a property of an object.
313
+ *
314
+ * The value can be:
315
+ * - 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)
316
+ * - a GObject.Value initialized with the expected type of the property
317
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
318
+ *
319
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
320
+ *
321
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
322
+ * @param property_name The name of the property to get
323
+ * @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
324
+ */
325
+ get_property(property_name: string, value: GObject.Value | any): any;
310
326
  /**
311
327
  * This function gets back user data pointers stored via
312
328
  * g_object_set_qdata().
@@ -434,7 +450,12 @@ export namespace Gepub {
434
450
  * @param data data to associate with that key
435
451
  */
436
452
  set_data(key: string, data?: any | null): void;
437
- set_property(property_name: string, value: any): void;
453
+ /**
454
+ * Sets a property on an object.
455
+ * @param property_name The name of the property to set
456
+ * @param value The value to set the property to
457
+ */
458
+ set_property(property_name: string, value: GObject.Value | any): void;
438
459
  /**
439
460
  * Remove a specified datum from the object's data associations,
440
461
  * without invoking the association's destroy handler.
@@ -584,11 +605,31 @@ export namespace Gepub {
584
605
  * @param pspec
585
606
  */
586
607
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
608
+ /**
609
+ * 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.
610
+ * @param id Handler ID of the handler to be disconnected
611
+ */
587
612
  disconnect(id: number): void;
613
+ /**
614
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
615
+ * @param properties Object containing the properties to set
616
+ */
588
617
  set(properties: { [key: string]: any }): void;
589
- block_signal_handler(id: number): any;
590
- unblock_signal_handler(id: number): any;
591
- stop_emission_by_name(detailedName: string): any;
618
+ /**
619
+ * Blocks a handler of an instance so it will not be called during any signal emissions
620
+ * @param id Handler ID of the handler to be blocked
621
+ */
622
+ block_signal_handler(id: number): void;
623
+ /**
624
+ * Unblocks a handler so it will be called again during any signal emissions
625
+ * @param id Handler ID of the handler to be unblocked
626
+ */
627
+ unblock_signal_handler(id: number): void;
628
+ /**
629
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
630
+ * @param detailedName Name of the signal to stop emission of
631
+ */
632
+ stop_emission_by_name(detailedName: string): void;
592
633
  }
593
634
 
594
635
  namespace Widget {
@@ -745,7 +786,21 @@ export namespace Gepub {
745
786
  * @returns the data if found, or %NULL if no such data exists.
746
787
  */
747
788
  get_data(key: string): any | null;
748
- get_property(property_name: string): any;
789
+ /**
790
+ * Gets a property of an object.
791
+ *
792
+ * The value can be:
793
+ * - 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)
794
+ * - a GObject.Value initialized with the expected type of the property
795
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
796
+ *
797
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
798
+ *
799
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
800
+ * @param property_name The name of the property to get
801
+ * @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
802
+ */
803
+ get_property(property_name: string, value: GObject.Value | any): any;
749
804
  /**
750
805
  * This function gets back user data pointers stored via
751
806
  * g_object_set_qdata().
@@ -873,7 +928,12 @@ export namespace Gepub {
873
928
  * @param data data to associate with that key
874
929
  */
875
930
  set_data(key: string, data?: any | null): void;
876
- set_property(property_name: string, value: any): void;
931
+ /**
932
+ * Sets a property on an object.
933
+ * @param property_name The name of the property to set
934
+ * @param value The value to set the property to
935
+ */
936
+ set_property(property_name: string, value: GObject.Value | any): void;
877
937
  /**
878
938
  * Remove a specified datum from the object's data associations,
879
939
  * without invoking the association's destroy handler.
@@ -1023,11 +1083,31 @@ export namespace Gepub {
1023
1083
  * @param pspec
1024
1084
  */
1025
1085
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
1086
+ /**
1087
+ * 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.
1088
+ * @param id Handler ID of the handler to be disconnected
1089
+ */
1026
1090
  disconnect(id: number): void;
1091
+ /**
1092
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
1093
+ * @param properties Object containing the properties to set
1094
+ */
1027
1095
  set(properties: { [key: string]: any }): void;
1028
- block_signal_handler(id: number): any;
1029
- unblock_signal_handler(id: number): any;
1030
- stop_emission_by_name(detailedName: string): any;
1096
+ /**
1097
+ * Blocks a handler of an instance so it will not be called during any signal emissions
1098
+ * @param id Handler ID of the handler to be blocked
1099
+ */
1100
+ block_signal_handler(id: number): void;
1101
+ /**
1102
+ * Unblocks a handler so it will be called again during any signal emissions
1103
+ * @param id Handler ID of the handler to be unblocked
1104
+ */
1105
+ unblock_signal_handler(id: number): void;
1106
+ /**
1107
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
1108
+ * @param detailedName Name of the signal to stop emission of
1109
+ */
1110
+ stop_emission_by_name(detailedName: string): void;
1031
1111
  }
1032
1112
 
1033
1113
  type DocClass = typeof Doc;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/gepub-0.5",
3
- "version": "0.5.0-4.0.0-beta.21",
3
+ "version": "0.5.0-4.0.0-beta.23",
4
4
  "description": "GJS TypeScript type definitions for Gepub-0.5, generated from library version 0.5.0",
5
5
  "type": "module",
6
6
  "module": "gepub-0.5.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.0": "^2.46.5-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-2.4": "^2.74.3-4.0.0-beta.21",
50
- "@girs/webkit2-4.0": "^2.46.5-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.0": "^2.46.5-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-2.4": "^2.74.3-4.0.0-beta.23",
50
+ "@girs/webkit2-4.0": "^2.46.5-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": "*"