@girs/xreaderview-1.5 1.5.0-4.0.0-beta.21 → 1.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.
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/xreaderview-1.5)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for XreaderView-1.5, generated from library version 1.5.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.21.
8
+ GJS TypeScript type definitions for XreaderView-1.5, generated from library version 1.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/xreaderview-1.5",
3
- "version": "1.5.0-4.0.0-beta.21",
3
+ "version": "1.5.0-4.0.0-beta.23",
4
4
  "description": "GJS TypeScript type definitions for XreaderView-1.5, generated from library version 1.5.0",
5
5
  "type": "module",
6
6
  "module": "xreaderview-1.5.js",
@@ -31,21 +31,21 @@
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",
48
- "@girs/xreaderdocument-1.5": "^4.2.2-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
+ "@girs/xreaderdocument-1.5": "^4.2.2-4.0.0-beta.23"
49
49
  },
50
50
  "devDependencies": {
51
51
  "typescript": "*"
@@ -7,12 +7,14 @@
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 XreaderDocument from '@girs/xreaderdocument-1.5';
12
14
  import type Gtk from '@girs/gtk-3.0';
13
15
  import type xlib from '@girs/xlib-2.0';
14
16
  import type Gdk from '@girs/gdk-3.0';
15
- import type cairo from '@girs/cairo-1.0';
17
+ import type cairo from 'cairo';
16
18
  import type GObject from '@girs/gobject-2.0';
17
19
  import type GLib from '@girs/glib-2.0';
18
20
  import type Pango from '@girs/pango-1.0';
@@ -1131,7 +1133,21 @@ export namespace XreaderView {
1131
1133
  * @returns the data if found, or %NULL if no such data exists.
1132
1134
  */
1133
1135
  get_data(key: string): any | null;
1134
- get_property(property_name: string): any;
1136
+ /**
1137
+ * Gets a property of an object.
1138
+ *
1139
+ * The value can be:
1140
+ * - 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)
1141
+ * - a GObject.Value initialized with the expected type of the property
1142
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
1143
+ *
1144
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
1145
+ *
1146
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
1147
+ * @param property_name The name of the property to get
1148
+ * @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
1149
+ */
1150
+ get_property(property_name: string, value: GObject.Value | any): any;
1135
1151
  /**
1136
1152
  * This function gets back user data pointers stored via
1137
1153
  * g_object_set_qdata().
@@ -1259,7 +1275,12 @@ export namespace XreaderView {
1259
1275
  * @param data data to associate with that key
1260
1276
  */
1261
1277
  set_data(key: string, data?: any | null): void;
1262
- set_property(property_name: string, value: any): void;
1278
+ /**
1279
+ * Sets a property on an object.
1280
+ * @param property_name The name of the property to set
1281
+ * @param value The value to set the property to
1282
+ */
1283
+ set_property(property_name: string, value: GObject.Value | any): void;
1263
1284
  /**
1264
1285
  * Remove a specified datum from the object's data associations,
1265
1286
  * without invoking the association's destroy handler.
@@ -1409,11 +1430,31 @@ export namespace XreaderView {
1409
1430
  * @param pspec
1410
1431
  */
1411
1432
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
1433
+ /**
1434
+ * 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.
1435
+ * @param id Handler ID of the handler to be disconnected
1436
+ */
1412
1437
  disconnect(id: number): void;
1438
+ /**
1439
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
1440
+ * @param properties Object containing the properties to set
1441
+ */
1413
1442
  set(properties: { [key: string]: any }): void;
1414
- block_signal_handler(id: number): any;
1415
- unblock_signal_handler(id: number): any;
1416
- stop_emission_by_name(detailedName: string): any;
1443
+ /**
1444
+ * Blocks a handler of an instance so it will not be called during any signal emissions
1445
+ * @param id Handler ID of the handler to be blocked
1446
+ */
1447
+ block_signal_handler(id: number): void;
1448
+ /**
1449
+ * Unblocks a handler so it will be called again during any signal emissions
1450
+ * @param id Handler ID of the handler to be unblocked
1451
+ */
1452
+ unblock_signal_handler(id: number): void;
1453
+ /**
1454
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
1455
+ * @param detailedName Name of the signal to stop emission of
1456
+ */
1457
+ stop_emission_by_name(detailedName: string): void;
1417
1458
  }
1418
1459
 
1419
1460
  namespace ViewPresentation {
@@ -1790,7 +1831,21 @@ export namespace XreaderView {
1790
1831
  * @returns the data if found, or %NULL if no such data exists.
1791
1832
  */
1792
1833
  get_data(key: string): any | null;
1793
- get_property(property_name: string): any;
1834
+ /**
1835
+ * Gets a property of an object.
1836
+ *
1837
+ * The value can be:
1838
+ * - 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)
1839
+ * - a GObject.Value initialized with the expected type of the property
1840
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
1841
+ *
1842
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
1843
+ *
1844
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
1845
+ * @param property_name The name of the property to get
1846
+ * @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
1847
+ */
1848
+ get_property(property_name: string, value: GObject.Value | any): any;
1794
1849
  /**
1795
1850
  * This function gets back user data pointers stored via
1796
1851
  * g_object_set_qdata().
@@ -1918,7 +1973,12 @@ export namespace XreaderView {
1918
1973
  * @param data data to associate with that key
1919
1974
  */
1920
1975
  set_data(key: string, data?: any | null): void;
1921
- set_property(property_name: string, value: any): void;
1976
+ /**
1977
+ * Sets a property on an object.
1978
+ * @param property_name The name of the property to set
1979
+ * @param value The value to set the property to
1980
+ */
1981
+ set_property(property_name: string, value: GObject.Value | any): void;
1922
1982
  /**
1923
1983
  * Remove a specified datum from the object's data associations,
1924
1984
  * without invoking the association's destroy handler.
@@ -2068,11 +2128,31 @@ export namespace XreaderView {
2068
2128
  * @param pspec
2069
2129
  */
2070
2130
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
2131
+ /**
2132
+ * 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.
2133
+ * @param id Handler ID of the handler to be disconnected
2134
+ */
2071
2135
  disconnect(id: number): void;
2136
+ /**
2137
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
2138
+ * @param properties Object containing the properties to set
2139
+ */
2072
2140
  set(properties: { [key: string]: any }): void;
2073
- block_signal_handler(id: number): any;
2074
- unblock_signal_handler(id: number): any;
2075
- stop_emission_by_name(detailedName: string): any;
2141
+ /**
2142
+ * Blocks a handler of an instance so it will not be called during any signal emissions
2143
+ * @param id Handler ID of the handler to be blocked
2144
+ */
2145
+ block_signal_handler(id: number): void;
2146
+ /**
2147
+ * Unblocks a handler so it will be called again during any signal emissions
2148
+ * @param id Handler ID of the handler to be unblocked
2149
+ */
2150
+ unblock_signal_handler(id: number): void;
2151
+ /**
2152
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
2153
+ * @param detailedName Name of the signal to stop emission of
2154
+ */
2155
+ stop_emission_by_name(detailedName: string): void;
2076
2156
  }
2077
2157
 
2078
2158
  namespace WebView {
@@ -2240,7 +2320,21 @@ export namespace XreaderView {
2240
2320
  * @returns the data if found, or %NULL if no such data exists.
2241
2321
  */
2242
2322
  get_data(key: string): any | null;
2243
- get_property(property_name: string): any;
2323
+ /**
2324
+ * Gets a property of an object.
2325
+ *
2326
+ * The value can be:
2327
+ * - 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)
2328
+ * - a GObject.Value initialized with the expected type of the property
2329
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
2330
+ *
2331
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
2332
+ *
2333
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
2334
+ * @param property_name The name of the property to get
2335
+ * @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
2336
+ */
2337
+ get_property(property_name: string, value: GObject.Value | any): any;
2244
2338
  /**
2245
2339
  * This function gets back user data pointers stored via
2246
2340
  * g_object_set_qdata().
@@ -2368,7 +2462,12 @@ export namespace XreaderView {
2368
2462
  * @param data data to associate with that key
2369
2463
  */
2370
2464
  set_data(key: string, data?: any | null): void;
2371
- set_property(property_name: string, value: any): void;
2465
+ /**
2466
+ * Sets a property on an object.
2467
+ * @param property_name The name of the property to set
2468
+ * @param value The value to set the property to
2469
+ */
2470
+ set_property(property_name: string, value: GObject.Value | any): void;
2372
2471
  /**
2373
2472
  * Remove a specified datum from the object's data associations,
2374
2473
  * without invoking the association's destroy handler.
@@ -2518,11 +2617,31 @@ export namespace XreaderView {
2518
2617
  * @param pspec
2519
2618
  */
2520
2619
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
2620
+ /**
2621
+ * 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.
2622
+ * @param id Handler ID of the handler to be disconnected
2623
+ */
2521
2624
  disconnect(id: number): void;
2625
+ /**
2626
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
2627
+ * @param properties Object containing the properties to set
2628
+ */
2522
2629
  set(properties: { [key: string]: any }): void;
2523
- block_signal_handler(id: number): any;
2524
- unblock_signal_handler(id: number): any;
2525
- stop_emission_by_name(detailedName: string): any;
2630
+ /**
2631
+ * Blocks a handler of an instance so it will not be called during any signal emissions
2632
+ * @param id Handler ID of the handler to be blocked
2633
+ */
2634
+ block_signal_handler(id: number): void;
2635
+ /**
2636
+ * Unblocks a handler so it will be called again during any signal emissions
2637
+ * @param id Handler ID of the handler to be unblocked
2638
+ */
2639
+ unblock_signal_handler(id: number): void;
2640
+ /**
2641
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
2642
+ * @param detailedName Name of the signal to stop emission of
2643
+ */
2644
+ stop_emission_by_name(detailedName: string): void;
2526
2645
  }
2527
2646
 
2528
2647
  type DocumentModelClass = typeof DocumentModel;