@girs/gtef-2 2.0.0-4.0.0-beta.21 → 2.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.
Files changed (3) hide show
  1. package/README.md +1 -1
  2. package/gtef-2.d.ts +135 -16
  3. package/package.json +16 -16
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/gtef-2)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Gtef-2, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.21.
8
+ GJS TypeScript type definitions for Gtef-2, generated from library version 2.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
package/gtef-2.d.ts CHANGED
@@ -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 GtkSource from '@girs/gtksource-3.0';
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';
@@ -1597,7 +1599,21 @@ export namespace Gtef {
1597
1599
  * @returns the data if found, or %NULL if no such data exists.
1598
1600
  */
1599
1601
  get_data(key: string): any | null;
1600
- get_property(property_name: string): any;
1602
+ /**
1603
+ * Gets a property of an object.
1604
+ *
1605
+ * The value can be:
1606
+ * - 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)
1607
+ * - a GObject.Value initialized with the expected type of the property
1608
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
1609
+ *
1610
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
1611
+ *
1612
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
1613
+ * @param property_name The name of the property to get
1614
+ * @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
1615
+ */
1616
+ get_property(property_name: string, value: GObject.Value | any): any;
1601
1617
  /**
1602
1618
  * This function gets back user data pointers stored via
1603
1619
  * g_object_set_qdata().
@@ -1725,7 +1741,12 @@ export namespace Gtef {
1725
1741
  * @param data data to associate with that key
1726
1742
  */
1727
1743
  set_data(key: string, data?: any | null): void;
1728
- set_property(property_name: string, value: any): void;
1744
+ /**
1745
+ * Sets a property on an object.
1746
+ * @param property_name The name of the property to set
1747
+ * @param value The value to set the property to
1748
+ */
1749
+ set_property(property_name: string, value: GObject.Value | any): void;
1729
1750
  /**
1730
1751
  * Remove a specified datum from the object's data associations,
1731
1752
  * without invoking the association's destroy handler.
@@ -1875,11 +1896,31 @@ export namespace Gtef {
1875
1896
  * @param pspec
1876
1897
  */
1877
1898
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
1899
+ /**
1900
+ * 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.
1901
+ * @param id Handler ID of the handler to be disconnected
1902
+ */
1878
1903
  disconnect(id: number): void;
1904
+ /**
1905
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
1906
+ * @param properties Object containing the properties to set
1907
+ */
1879
1908
  set(properties: { [key: string]: any }): void;
1880
- block_signal_handler(id: number): any;
1881
- unblock_signal_handler(id: number): any;
1882
- stop_emission_by_name(detailedName: string): any;
1909
+ /**
1910
+ * Blocks a handler of an instance so it will not be called during any signal emissions
1911
+ * @param id Handler ID of the handler to be blocked
1912
+ */
1913
+ block_signal_handler(id: number): void;
1914
+ /**
1915
+ * Unblocks a handler so it will be called again during any signal emissions
1916
+ * @param id Handler ID of the handler to be unblocked
1917
+ */
1918
+ unblock_signal_handler(id: number): void;
1919
+ /**
1920
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
1921
+ * @param detailedName Name of the signal to stop emission of
1922
+ */
1923
+ stop_emission_by_name(detailedName: string): void;
1883
1924
  }
1884
1925
 
1885
1926
  namespace MenuShell {
@@ -2126,7 +2167,21 @@ export namespace Gtef {
2126
2167
  * @returns the data if found, or %NULL if no such data exists.
2127
2168
  */
2128
2169
  get_data(key: string): any | null;
2129
- get_property(property_name: string): any;
2170
+ /**
2171
+ * Gets a property of an object.
2172
+ *
2173
+ * The value can be:
2174
+ * - 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)
2175
+ * - a GObject.Value initialized with the expected type of the property
2176
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
2177
+ *
2178
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
2179
+ *
2180
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
2181
+ * @param property_name The name of the property to get
2182
+ * @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
2183
+ */
2184
+ get_property(property_name: string, value: GObject.Value | any): any;
2130
2185
  /**
2131
2186
  * This function gets back user data pointers stored via
2132
2187
  * g_object_set_qdata().
@@ -2254,7 +2309,12 @@ export namespace Gtef {
2254
2309
  * @param data data to associate with that key
2255
2310
  */
2256
2311
  set_data(key: string, data?: any | null): void;
2257
- set_property(property_name: string, value: any): void;
2312
+ /**
2313
+ * Sets a property on an object.
2314
+ * @param property_name The name of the property to set
2315
+ * @param value The value to set the property to
2316
+ */
2317
+ set_property(property_name: string, value: GObject.Value | any): void;
2258
2318
  /**
2259
2319
  * Remove a specified datum from the object's data associations,
2260
2320
  * without invoking the association's destroy handler.
@@ -2404,11 +2464,31 @@ export namespace Gtef {
2404
2464
  * @param pspec
2405
2465
  */
2406
2466
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
2467
+ /**
2468
+ * 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.
2469
+ * @param id Handler ID of the handler to be disconnected
2470
+ */
2407
2471
  disconnect(id: number): void;
2472
+ /**
2473
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
2474
+ * @param properties Object containing the properties to set
2475
+ */
2408
2476
  set(properties: { [key: string]: any }): void;
2409
- block_signal_handler(id: number): any;
2410
- unblock_signal_handler(id: number): any;
2411
- stop_emission_by_name(detailedName: string): any;
2477
+ /**
2478
+ * Blocks a handler of an instance so it will not be called during any signal emissions
2479
+ * @param id Handler ID of the handler to be blocked
2480
+ */
2481
+ block_signal_handler(id: number): void;
2482
+ /**
2483
+ * Unblocks a handler so it will be called again during any signal emissions
2484
+ * @param id Handler ID of the handler to be unblocked
2485
+ */
2486
+ unblock_signal_handler(id: number): void;
2487
+ /**
2488
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
2489
+ * @param detailedName Name of the signal to stop emission of
2490
+ */
2491
+ stop_emission_by_name(detailedName: string): void;
2412
2492
  }
2413
2493
 
2414
2494
  namespace View {
@@ -2603,7 +2683,21 @@ export namespace Gtef {
2603
2683
  * @returns the data if found, or %NULL if no such data exists.
2604
2684
  */
2605
2685
  get_data(key: string): any | null;
2606
- get_property(property_name: string): any;
2686
+ /**
2687
+ * Gets a property of an object.
2688
+ *
2689
+ * The value can be:
2690
+ * - 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)
2691
+ * - a GObject.Value initialized with the expected type of the property
2692
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
2693
+ *
2694
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
2695
+ *
2696
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
2697
+ * @param property_name The name of the property to get
2698
+ * @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
2699
+ */
2700
+ get_property(property_name: string, value: GObject.Value | any): any;
2607
2701
  /**
2608
2702
  * This function gets back user data pointers stored via
2609
2703
  * g_object_set_qdata().
@@ -2731,7 +2825,12 @@ export namespace Gtef {
2731
2825
  * @param data data to associate with that key
2732
2826
  */
2733
2827
  set_data(key: string, data?: any | null): void;
2734
- set_property(property_name: string, value: any): void;
2828
+ /**
2829
+ * Sets a property on an object.
2830
+ * @param property_name The name of the property to set
2831
+ * @param value The value to set the property to
2832
+ */
2833
+ set_property(property_name: string, value: GObject.Value | any): void;
2735
2834
  /**
2736
2835
  * Remove a specified datum from the object's data associations,
2737
2836
  * without invoking the association's destroy handler.
@@ -2881,11 +2980,31 @@ export namespace Gtef {
2881
2980
  * @param pspec
2882
2981
  */
2883
2982
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
2983
+ /**
2984
+ * 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.
2985
+ * @param id Handler ID of the handler to be disconnected
2986
+ */
2884
2987
  disconnect(id: number): void;
2988
+ /**
2989
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
2990
+ * @param properties Object containing the properties to set
2991
+ */
2885
2992
  set(properties: { [key: string]: any }): void;
2886
- block_signal_handler(id: number): any;
2887
- unblock_signal_handler(id: number): any;
2888
- stop_emission_by_name(detailedName: string): any;
2993
+ /**
2994
+ * Blocks a handler of an instance so it will not be called during any signal emissions
2995
+ * @param id Handler ID of the handler to be blocked
2996
+ */
2997
+ block_signal_handler(id: number): void;
2998
+ /**
2999
+ * Unblocks a handler so it will be called again during any signal emissions
3000
+ * @param id Handler ID of the handler to be unblocked
3001
+ */
3002
+ unblock_signal_handler(id: number): void;
3003
+ /**
3004
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
3005
+ * @param detailedName Name of the signal to stop emission of
3006
+ */
3007
+ stop_emission_by_name(detailedName: string): void;
2889
3008
  }
2890
3009
 
2891
3010
  class ActionInfo {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/gtef-2",
3
- "version": "2.0.0-4.0.0-beta.21",
3
+ "version": "2.0.0-4.0.0-beta.23",
4
4
  "description": "GJS TypeScript type definitions for Gtef-2, generated from library version 2.0.0",
5
5
  "type": "module",
6
6
  "module": "gtef-2.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/gtksource-3.0": "^3.0.0-4.0.0-beta.21",
46
- "@girs/harfbuzz-0.0": "^9.0.0-4.0.0-beta.21",
47
- "@girs/pango-1.0": "^1.56.0-4.0.0-beta.21",
48
- "@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/gtksource-3.0": "^3.0.0-4.0.0-beta.23",
46
+ "@girs/harfbuzz-0.0": "^9.0.0-4.0.0-beta.23",
47
+ "@girs/pango-1.0": "^1.56.4-4.0.0-beta.23",
48
+ "@girs/xlib-2.0": "^2.0.0-4.0.0-beta.23"
49
49
  },
50
50
  "devDependencies": {
51
51
  "typescript": "*"