@girs/gpaste-2 2.0.0-4.0.0-beta.21 → 2.0.0-4.0.0-beta.24

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/gpaste-2.d.ts +310 -114
  3. package/package.json +6 -6
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/gpaste-2)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for GPaste-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 GPaste-2, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.24.
9
9
 
10
10
 
11
11
  ## Install
package/gpaste-2.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 Gio from '@girs/gio-2.0';
12
14
  import type GObject from '@girs/gobject-2.0';
@@ -331,30 +333,23 @@ export namespace GPaste {
331
333
  IGNORE_AUTOREPEAT,
332
334
  }
333
335
  namespace Client {
334
- // Signal callback interfaces
335
-
336
- interface DeleteHistory {
337
- (history: string): void;
338
- }
339
-
340
- interface EmptyHistory {
341
- (history: string): void;
342
- }
343
-
344
- interface ShowHistory {
345
- (): void;
346
- }
347
-
348
- interface SwitchHistory {
349
- (history: string): void;
350
- }
351
-
352
- interface Tracking {
353
- (object: boolean): void;
354
- }
355
-
356
- interface Update {
357
- (action: UpdateAction, target: UpdateTarget, index: number): void;
336
+ // Signal signatures
337
+ interface SignalSignatures extends Gio.DBusProxy.SignalSignatures {
338
+ 'delete-history': (arg0: string) => void;
339
+ 'empty-history': (arg0: string) => void;
340
+ 'show-history': () => void;
341
+ 'switch-history': (arg0: string) => void;
342
+ tracking: (arg0: boolean) => void;
343
+ update: (arg0: UpdateAction, arg1: UpdateTarget, arg2: number) => void;
344
+ 'notify::g-bus-type': (pspec: GObject.ParamSpec) => void;
345
+ 'notify::g-connection': (pspec: GObject.ParamSpec) => void;
346
+ 'notify::g-default-timeout': (pspec: GObject.ParamSpec) => void;
347
+ 'notify::g-flags': (pspec: GObject.ParamSpec) => void;
348
+ 'notify::g-interface-info': (pspec: GObject.ParamSpec) => void;
349
+ 'notify::g-interface-name': (pspec: GObject.ParamSpec) => void;
350
+ 'notify::g-name': (pspec: GObject.ParamSpec) => void;
351
+ 'notify::g-name-owner': (pspec: GObject.ParamSpec) => void;
352
+ 'notify::g-object-path': (pspec: GObject.ParamSpec) => void;
358
353
  }
359
354
 
360
355
  // Constructor properties interface
@@ -369,6 +364,15 @@ export namespace GPaste {
369
364
  class Client extends Gio.DBusProxy implements Gio.AsyncInitable<Client>, Gio.DBusInterface, Gio.Initable {
370
365
  static $gtype: GObject.GType<Client>;
371
366
 
367
+ /**
368
+ * Compile-time signal type information.
369
+ *
370
+ * This instance property is generated only for TypeScript type checking.
371
+ * It is not defined at runtime and should not be accessed in JS code.
372
+ * @internal
373
+ */
374
+ $signals: Client.SignalSignatures;
375
+
372
376
  // Constructors
373
377
 
374
378
  constructor(properties?: Partial<Client.ConstructorProps>, ...args: any[]);
@@ -384,33 +388,21 @@ export namespace GPaste {
384
388
 
385
389
  // Signals
386
390
 
387
- connect(id: string, callback: (...args: any[]) => any): number;
388
- connect_after(id: string, callback: (...args: any[]) => any): number;
389
- emit(id: string, ...args: any[]): void;
390
- connect(signal: 'delete-history', callback: (_source: this, history: string) => void): number;
391
- connect_after(signal: 'delete-history', callback: (_source: this, history: string) => void): number;
392
- emit(signal: 'delete-history', history: string): void;
393
- connect(signal: 'empty-history', callback: (_source: this, history: string) => void): number;
394
- connect_after(signal: 'empty-history', callback: (_source: this, history: string) => void): number;
395
- emit(signal: 'empty-history', history: string): void;
396
- connect(signal: 'show-history', callback: (_source: this) => void): number;
397
- connect_after(signal: 'show-history', callback: (_source: this) => void): number;
398
- emit(signal: 'show-history'): void;
399
- connect(signal: 'switch-history', callback: (_source: this, history: string) => void): number;
400
- connect_after(signal: 'switch-history', callback: (_source: this, history: string) => void): number;
401
- emit(signal: 'switch-history', history: string): void;
402
- connect(signal: 'tracking', callback: (_source: this, object: boolean) => void): number;
403
- connect_after(signal: 'tracking', callback: (_source: this, object: boolean) => void): number;
404
- emit(signal: 'tracking', object: boolean): void;
405
- connect(
406
- signal: 'update',
407
- callback: (_source: this, action: UpdateAction, target: UpdateTarget, index: number) => void,
391
+ connect<K extends keyof Client.SignalSignatures>(
392
+ signal: K,
393
+ callback: GObject.SignalCallback<this, Client.SignalSignatures[K]>,
408
394
  ): number;
409
- connect_after(
410
- signal: 'update',
411
- callback: (_source: this, action: UpdateAction, target: UpdateTarget, index: number) => void,
395
+ connect(signal: string, callback: (...args: any[]) => any): number;
396
+ connect_after<K extends keyof Client.SignalSignatures>(
397
+ signal: K,
398
+ callback: GObject.SignalCallback<this, Client.SignalSignatures[K]>,
412
399
  ): number;
413
- emit(signal: 'update', action: UpdateAction, target: UpdateTarget, index: number): void;
400
+ connect_after(signal: string, callback: (...args: any[]) => any): number;
401
+ emit<K extends keyof Client.SignalSignatures>(
402
+ signal: K,
403
+ ...args: GObject.GjsParameters<Client.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
404
+ ): void;
405
+ emit(signal: string, ...args: any[]): void;
414
406
 
415
407
  // Static methods
416
408
 
@@ -1586,7 +1578,7 @@ export namespace GPaste {
1586
1578
  * If the object is not initialized, or initialization returns with an
1587
1579
  * error, then all operations on the object except g_object_ref() and
1588
1580
  * g_object_unref() are considered to be invalid, and have undefined
1589
- * behaviour. See the [introduction][ginitable] for more details.
1581
+ * behaviour. See the [description][iface`Gio`.Initable#description] for more details.
1590
1582
  *
1591
1583
  * Callers should not assume that a class which implements #GInitable can be
1592
1584
  * initialized multiple times, unless the class explicitly documents itself as
@@ -1629,7 +1621,7 @@ export namespace GPaste {
1629
1621
  * If the object is not initialized, or initialization returns with an
1630
1622
  * error, then all operations on the object except g_object_ref() and
1631
1623
  * g_object_unref() are considered to be invalid, and have undefined
1632
- * behaviour. See the [introduction][ginitable] for more details.
1624
+ * behaviour. See the [description][iface`Gio`.Initable#description] for more details.
1633
1625
  *
1634
1626
  * Callers should not assume that a class which implements #GInitable can be
1635
1627
  * initialized multiple times, unless the class explicitly documents itself as
@@ -1769,7 +1761,21 @@ export namespace GPaste {
1769
1761
  * @returns the data if found, or %NULL if no such data exists.
1770
1762
  */
1771
1763
  get_data(key: string): any | null;
1772
- get_property(property_name: string): any;
1764
+ /**
1765
+ * Gets a property of an object.
1766
+ *
1767
+ * The value can be:
1768
+ * - 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)
1769
+ * - a GObject.Value initialized with the expected type of the property
1770
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
1771
+ *
1772
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
1773
+ *
1774
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
1775
+ * @param property_name The name of the property to get
1776
+ * @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
1777
+ */
1778
+ get_property(property_name: string, value: GObject.Value | any): any;
1773
1779
  /**
1774
1780
  * This function gets back user data pointers stored via
1775
1781
  * g_object_set_qdata().
@@ -1897,7 +1903,12 @@ export namespace GPaste {
1897
1903
  * @param data data to associate with that key
1898
1904
  */
1899
1905
  set_data(key: string, data?: any | null): void;
1900
- set_property(property_name: string, value: any): void;
1906
+ /**
1907
+ * Sets a property on an object.
1908
+ * @param property_name The name of the property to set
1909
+ * @param value The value to set the property to
1910
+ */
1911
+ set_property(property_name: string, value: GObject.Value | any): void;
1901
1912
  /**
1902
1913
  * Remove a specified datum from the object's data associations,
1903
1914
  * without invoking the association's destroy handler.
@@ -2047,14 +2058,37 @@ export namespace GPaste {
2047
2058
  * @param pspec
2048
2059
  */
2049
2060
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
2061
+ /**
2062
+ * 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.
2063
+ * @param id Handler ID of the handler to be disconnected
2064
+ */
2050
2065
  disconnect(id: number): void;
2066
+ /**
2067
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
2068
+ * @param properties Object containing the properties to set
2069
+ */
2051
2070
  set(properties: { [key: string]: any }): void;
2052
- block_signal_handler(id: number): any;
2053
- unblock_signal_handler(id: number): any;
2054
- stop_emission_by_name(detailedName: string): any;
2071
+ /**
2072
+ * Blocks a handler of an instance so it will not be called during any signal emissions
2073
+ * @param id Handler ID of the handler to be blocked
2074
+ */
2075
+ block_signal_handler(id: number): void;
2076
+ /**
2077
+ * Unblocks a handler so it will be called again during any signal emissions
2078
+ * @param id Handler ID of the handler to be unblocked
2079
+ */
2080
+ unblock_signal_handler(id: number): void;
2081
+ /**
2082
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
2083
+ * @param detailedName Name of the signal to stop emission of
2084
+ */
2085
+ stop_emission_by_name(detailedName: string): void;
2055
2086
  }
2056
2087
 
2057
2088
  namespace ClientItem {
2089
+ // Signal signatures
2090
+ interface SignalSignatures extends GObject.Object.SignalSignatures {}
2091
+
2058
2092
  // Constructor properties interface
2059
2093
 
2060
2094
  interface ConstructorProps extends GObject.Object.ConstructorProps {}
@@ -2063,6 +2097,15 @@ export namespace GPaste {
2063
2097
  class ClientItem extends GObject.Object {
2064
2098
  static $gtype: GObject.GType<ClientItem>;
2065
2099
 
2100
+ /**
2101
+ * Compile-time signal type information.
2102
+ *
2103
+ * This instance property is generated only for TypeScript type checking.
2104
+ * It is not defined at runtime and should not be accessed in JS code.
2105
+ * @internal
2106
+ */
2107
+ $signals: ClientItem.SignalSignatures;
2108
+
2066
2109
  // Constructors
2067
2110
 
2068
2111
  constructor(properties?: Partial<ClientItem.ConstructorProps>, ...args: any[]);
@@ -2071,6 +2114,24 @@ export namespace GPaste {
2071
2114
 
2072
2115
  static ['new'](uuid: string, value: string): ClientItem;
2073
2116
 
2117
+ // Signals
2118
+
2119
+ connect<K extends keyof ClientItem.SignalSignatures>(
2120
+ signal: K,
2121
+ callback: GObject.SignalCallback<this, ClientItem.SignalSignatures[K]>,
2122
+ ): number;
2123
+ connect(signal: string, callback: (...args: any[]) => any): number;
2124
+ connect_after<K extends keyof ClientItem.SignalSignatures>(
2125
+ signal: K,
2126
+ callback: GObject.SignalCallback<this, ClientItem.SignalSignatures[K]>,
2127
+ ): number;
2128
+ connect_after(signal: string, callback: (...args: any[]) => any): number;
2129
+ emit<K extends keyof ClientItem.SignalSignatures>(
2130
+ signal: K,
2131
+ ...args: GObject.GjsParameters<ClientItem.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
2132
+ ): void;
2133
+ emit(signal: string, ...args: any[]): void;
2134
+
2074
2135
  // Methods
2075
2136
 
2076
2137
  /**
@@ -2084,10 +2145,18 @@ export namespace GPaste {
2084
2145
  }
2085
2146
 
2086
2147
  namespace GnomeShellClient {
2087
- // Signal callback interfaces
2088
-
2089
- interface AcceleratorActivated {
2090
- (id: number): void;
2148
+ // Signal signatures
2149
+ interface SignalSignatures extends Gio.DBusProxy.SignalSignatures {
2150
+ 'accelerator-activated': (arg0: number) => void;
2151
+ 'notify::g-bus-type': (pspec: GObject.ParamSpec) => void;
2152
+ 'notify::g-connection': (pspec: GObject.ParamSpec) => void;
2153
+ 'notify::g-default-timeout': (pspec: GObject.ParamSpec) => void;
2154
+ 'notify::g-flags': (pspec: GObject.ParamSpec) => void;
2155
+ 'notify::g-interface-info': (pspec: GObject.ParamSpec) => void;
2156
+ 'notify::g-interface-name': (pspec: GObject.ParamSpec) => void;
2157
+ 'notify::g-name': (pspec: GObject.ParamSpec) => void;
2158
+ 'notify::g-name-owner': (pspec: GObject.ParamSpec) => void;
2159
+ 'notify::g-object-path': (pspec: GObject.ParamSpec) => void;
2091
2160
  }
2092
2161
 
2093
2162
  // Constructor properties interface
@@ -2105,6 +2174,15 @@ export namespace GPaste {
2105
2174
  {
2106
2175
  static $gtype: GObject.GType<GnomeShellClient>;
2107
2176
 
2177
+ /**
2178
+ * Compile-time signal type information.
2179
+ *
2180
+ * This instance property is generated only for TypeScript type checking.
2181
+ * It is not defined at runtime and should not be accessed in JS code.
2182
+ * @internal
2183
+ */
2184
+ $signals: GnomeShellClient.SignalSignatures;
2185
+
2108
2186
  // Constructors
2109
2187
 
2110
2188
  constructor(properties?: Partial<GnomeShellClient.ConstructorProps>, ...args: any[]);
@@ -2120,12 +2198,21 @@ export namespace GPaste {
2120
2198
 
2121
2199
  // Signals
2122
2200
 
2123
- connect(id: string, callback: (...args: any[]) => any): number;
2124
- connect_after(id: string, callback: (...args: any[]) => any): number;
2125
- emit(id: string, ...args: any[]): void;
2126
- connect(signal: 'accelerator-activated', callback: (_source: this, id: number) => void): number;
2127
- connect_after(signal: 'accelerator-activated', callback: (_source: this, id: number) => void): number;
2128
- emit(signal: 'accelerator-activated', id: number): void;
2201
+ connect<K extends keyof GnomeShellClient.SignalSignatures>(
2202
+ signal: K,
2203
+ callback: GObject.SignalCallback<this, GnomeShellClient.SignalSignatures[K]>,
2204
+ ): number;
2205
+ connect(signal: string, callback: (...args: any[]) => any): number;
2206
+ connect_after<K extends keyof GnomeShellClient.SignalSignatures>(
2207
+ signal: K,
2208
+ callback: GObject.SignalCallback<this, GnomeShellClient.SignalSignatures[K]>,
2209
+ ): number;
2210
+ connect_after(signal: string, callback: (...args: any[]) => any): number;
2211
+ emit<K extends keyof GnomeShellClient.SignalSignatures>(
2212
+ signal: K,
2213
+ ...args: GObject.GjsParameters<GnomeShellClient.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
2214
+ ): void;
2215
+ emit(signal: string, ...args: any[]): void;
2129
2216
 
2130
2217
  // Static methods
2131
2218
 
@@ -2488,7 +2575,7 @@ export namespace GPaste {
2488
2575
  * If the object is not initialized, or initialization returns with an
2489
2576
  * error, then all operations on the object except g_object_ref() and
2490
2577
  * g_object_unref() are considered to be invalid, and have undefined
2491
- * behaviour. See the [introduction][ginitable] for more details.
2578
+ * behaviour. See the [description][iface`Gio`.Initable#description] for more details.
2492
2579
  *
2493
2580
  * Callers should not assume that a class which implements #GInitable can be
2494
2581
  * initialized multiple times, unless the class explicitly documents itself as
@@ -2531,7 +2618,7 @@ export namespace GPaste {
2531
2618
  * If the object is not initialized, or initialization returns with an
2532
2619
  * error, then all operations on the object except g_object_ref() and
2533
2620
  * g_object_unref() are considered to be invalid, and have undefined
2534
- * behaviour. See the [introduction][ginitable] for more details.
2621
+ * behaviour. See the [description][iface`Gio`.Initable#description] for more details.
2535
2622
  *
2536
2623
  * Callers should not assume that a class which implements #GInitable can be
2537
2624
  * initialized multiple times, unless the class explicitly documents itself as
@@ -2671,7 +2758,21 @@ export namespace GPaste {
2671
2758
  * @returns the data if found, or %NULL if no such data exists.
2672
2759
  */
2673
2760
  get_data(key: string): any | null;
2674
- get_property(property_name: string): any;
2761
+ /**
2762
+ * Gets a property of an object.
2763
+ *
2764
+ * The value can be:
2765
+ * - 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)
2766
+ * - a GObject.Value initialized with the expected type of the property
2767
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
2768
+ *
2769
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
2770
+ *
2771
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
2772
+ * @param property_name The name of the property to get
2773
+ * @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
2774
+ */
2775
+ get_property(property_name: string, value: GObject.Value | any): any;
2675
2776
  /**
2676
2777
  * This function gets back user data pointers stored via
2677
2778
  * g_object_set_qdata().
@@ -2799,7 +2900,12 @@ export namespace GPaste {
2799
2900
  * @param data data to associate with that key
2800
2901
  */
2801
2902
  set_data(key: string, data?: any | null): void;
2802
- set_property(property_name: string, value: any): void;
2903
+ /**
2904
+ * Sets a property on an object.
2905
+ * @param property_name The name of the property to set
2906
+ * @param value The value to set the property to
2907
+ */
2908
+ set_property(property_name: string, value: GObject.Value | any): void;
2803
2909
  /**
2804
2910
  * Remove a specified datum from the object's data associations,
2805
2911
  * without invoking the association's destroy handler.
@@ -2949,18 +3055,46 @@ export namespace GPaste {
2949
3055
  * @param pspec
2950
3056
  */
2951
3057
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
3058
+ /**
3059
+ * 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.
3060
+ * @param id Handler ID of the handler to be disconnected
3061
+ */
2952
3062
  disconnect(id: number): void;
3063
+ /**
3064
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
3065
+ * @param properties Object containing the properties to set
3066
+ */
2953
3067
  set(properties: { [key: string]: any }): void;
2954
- block_signal_handler(id: number): any;
2955
- unblock_signal_handler(id: number): any;
2956
- stop_emission_by_name(detailedName: string): any;
3068
+ /**
3069
+ * Blocks a handler of an instance so it will not be called during any signal emissions
3070
+ * @param id Handler ID of the handler to be blocked
3071
+ */
3072
+ block_signal_handler(id: number): void;
3073
+ /**
3074
+ * Unblocks a handler so it will be called again during any signal emissions
3075
+ * @param id Handler ID of the handler to be unblocked
3076
+ */
3077
+ unblock_signal_handler(id: number): void;
3078
+ /**
3079
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
3080
+ * @param detailedName Name of the signal to stop emission of
3081
+ */
3082
+ stop_emission_by_name(detailedName: string): void;
2957
3083
  }
2958
3084
 
2959
3085
  namespace ScreensaverClient {
2960
- // Signal callback interfaces
2961
-
2962
- interface ActiveChanged {
2963
- (active: boolean): void;
3086
+ // Signal signatures
3087
+ interface SignalSignatures extends Gio.DBusProxy.SignalSignatures {
3088
+ 'active-changed': (arg0: boolean) => void;
3089
+ 'notify::g-bus-type': (pspec: GObject.ParamSpec) => void;
3090
+ 'notify::g-connection': (pspec: GObject.ParamSpec) => void;
3091
+ 'notify::g-default-timeout': (pspec: GObject.ParamSpec) => void;
3092
+ 'notify::g-flags': (pspec: GObject.ParamSpec) => void;
3093
+ 'notify::g-interface-info': (pspec: GObject.ParamSpec) => void;
3094
+ 'notify::g-interface-name': (pspec: GObject.ParamSpec) => void;
3095
+ 'notify::g-name': (pspec: GObject.ParamSpec) => void;
3096
+ 'notify::g-name-owner': (pspec: GObject.ParamSpec) => void;
3097
+ 'notify::g-object-path': (pspec: GObject.ParamSpec) => void;
2964
3098
  }
2965
3099
 
2966
3100
  // Constructor properties interface
@@ -2978,6 +3112,15 @@ export namespace GPaste {
2978
3112
  {
2979
3113
  static $gtype: GObject.GType<ScreensaverClient>;
2980
3114
 
3115
+ /**
3116
+ * Compile-time signal type information.
3117
+ *
3118
+ * This instance property is generated only for TypeScript type checking.
3119
+ * It is not defined at runtime and should not be accessed in JS code.
3120
+ * @internal
3121
+ */
3122
+ $signals: ScreensaverClient.SignalSignatures;
3123
+
2981
3124
  // Constructors
2982
3125
 
2983
3126
  constructor(properties?: Partial<ScreensaverClient.ConstructorProps>, ...args: any[]);
@@ -2993,12 +3136,21 @@ export namespace GPaste {
2993
3136
 
2994
3137
  // Signals
2995
3138
 
2996
- connect(id: string, callback: (...args: any[]) => any): number;
2997
- connect_after(id: string, callback: (...args: any[]) => any): number;
2998
- emit(id: string, ...args: any[]): void;
2999
- connect(signal: 'active-changed', callback: (_source: this, active: boolean) => void): number;
3000
- connect_after(signal: 'active-changed', callback: (_source: this, active: boolean) => void): number;
3001
- emit(signal: 'active-changed', active: boolean): void;
3139
+ connect<K extends keyof ScreensaverClient.SignalSignatures>(
3140
+ signal: K,
3141
+ callback: GObject.SignalCallback<this, ScreensaverClient.SignalSignatures[K]>,
3142
+ ): number;
3143
+ connect(signal: string, callback: (...args: any[]) => any): number;
3144
+ connect_after<K extends keyof ScreensaverClient.SignalSignatures>(
3145
+ signal: K,
3146
+ callback: GObject.SignalCallback<this, ScreensaverClient.SignalSignatures[K]>,
3147
+ ): number;
3148
+ connect_after(signal: string, callback: (...args: any[]) => any): number;
3149
+ emit<K extends keyof ScreensaverClient.SignalSignatures>(
3150
+ signal: K,
3151
+ ...args: GObject.GjsParameters<ScreensaverClient.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
3152
+ ): void;
3153
+ emit(signal: string, ...args: any[]): void;
3002
3154
 
3003
3155
  // Static methods
3004
3156
 
@@ -3265,7 +3417,7 @@ export namespace GPaste {
3265
3417
  * If the object is not initialized, or initialization returns with an
3266
3418
  * error, then all operations on the object except g_object_ref() and
3267
3419
  * g_object_unref() are considered to be invalid, and have undefined
3268
- * behaviour. See the [introduction][ginitable] for more details.
3420
+ * behaviour. See the [description][iface`Gio`.Initable#description] for more details.
3269
3421
  *
3270
3422
  * Callers should not assume that a class which implements #GInitable can be
3271
3423
  * initialized multiple times, unless the class explicitly documents itself as
@@ -3308,7 +3460,7 @@ export namespace GPaste {
3308
3460
  * If the object is not initialized, or initialization returns with an
3309
3461
  * error, then all operations on the object except g_object_ref() and
3310
3462
  * g_object_unref() are considered to be invalid, and have undefined
3311
- * behaviour. See the [introduction][ginitable] for more details.
3463
+ * behaviour. See the [description][iface`Gio`.Initable#description] for more details.
3312
3464
  *
3313
3465
  * Callers should not assume that a class which implements #GInitable can be
3314
3466
  * initialized multiple times, unless the class explicitly documents itself as
@@ -3448,7 +3600,21 @@ export namespace GPaste {
3448
3600
  * @returns the data if found, or %NULL if no such data exists.
3449
3601
  */
3450
3602
  get_data(key: string): any | null;
3451
- get_property(property_name: string): any;
3603
+ /**
3604
+ * Gets a property of an object.
3605
+ *
3606
+ * The value can be:
3607
+ * - 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)
3608
+ * - a GObject.Value initialized with the expected type of the property
3609
+ * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
3610
+ *
3611
+ * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
3612
+ *
3613
+ * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
3614
+ * @param property_name The name of the property to get
3615
+ * @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
3616
+ */
3617
+ get_property(property_name: string, value: GObject.Value | any): any;
3452
3618
  /**
3453
3619
  * This function gets back user data pointers stored via
3454
3620
  * g_object_set_qdata().
@@ -3576,7 +3742,12 @@ export namespace GPaste {
3576
3742
  * @param data data to associate with that key
3577
3743
  */
3578
3744
  set_data(key: string, data?: any | null): void;
3579
- set_property(property_name: string, value: any): void;
3745
+ /**
3746
+ * Sets a property on an object.
3747
+ * @param property_name The name of the property to set
3748
+ * @param value The value to set the property to
3749
+ */
3750
+ set_property(property_name: string, value: GObject.Value | any): void;
3580
3751
  /**
3581
3752
  * Remove a specified datum from the object's data associations,
3582
3753
  * without invoking the association's destroy handler.
@@ -3726,26 +3897,39 @@ export namespace GPaste {
3726
3897
  * @param pspec
3727
3898
  */
3728
3899
  vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
3900
+ /**
3901
+ * 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.
3902
+ * @param id Handler ID of the handler to be disconnected
3903
+ */
3729
3904
  disconnect(id: number): void;
3905
+ /**
3906
+ * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
3907
+ * @param properties Object containing the properties to set
3908
+ */
3730
3909
  set(properties: { [key: string]: any }): void;
3731
- block_signal_handler(id: number): any;
3732
- unblock_signal_handler(id: number): any;
3733
- stop_emission_by_name(detailedName: string): any;
3910
+ /**
3911
+ * Blocks a handler of an instance so it will not be called during any signal emissions
3912
+ * @param id Handler ID of the handler to be blocked
3913
+ */
3914
+ block_signal_handler(id: number): void;
3915
+ /**
3916
+ * Unblocks a handler so it will be called again during any signal emissions
3917
+ * @param id Handler ID of the handler to be unblocked
3918
+ */
3919
+ unblock_signal_handler(id: number): void;
3920
+ /**
3921
+ * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
3922
+ * @param detailedName Name of the signal to stop emission of
3923
+ */
3924
+ stop_emission_by_name(detailedName: string): void;
3734
3925
  }
3735
3926
 
3736
3927
  namespace Settings {
3737
- // Signal callback interfaces
3738
-
3739
- interface Changed {
3740
- (key: string): void;
3741
- }
3742
-
3743
- interface Rebind {
3744
- (key: string): void;
3745
- }
3746
-
3747
- interface Track {
3748
- (tracking_state: boolean): void;
3928
+ // Signal signatures
3929
+ interface SignalSignatures extends GObject.Object.SignalSignatures {
3930
+ changed: (arg0: string) => void;
3931
+ rebind: (arg0: string) => void;
3932
+ track: (arg0: boolean) => void;
3749
3933
  }
3750
3934
 
3751
3935
  // Constructor properties interface
@@ -3756,6 +3940,15 @@ export namespace GPaste {
3756
3940
  class Settings extends GObject.Object {
3757
3941
  static $gtype: GObject.GType<Settings>;
3758
3942
 
3943
+ /**
3944
+ * Compile-time signal type information.
3945
+ *
3946
+ * This instance property is generated only for TypeScript type checking.
3947
+ * It is not defined at runtime and should not be accessed in JS code.
3948
+ * @internal
3949
+ */
3950
+ $signals: Settings.SignalSignatures;
3951
+
3759
3952
  // Constructors
3760
3953
 
3761
3954
  constructor(properties?: Partial<Settings.ConstructorProps>, ...args: any[]);
@@ -3766,18 +3959,21 @@ export namespace GPaste {
3766
3959
 
3767
3960
  // Signals
3768
3961
 
3769
- connect(id: string, callback: (...args: any[]) => any): number;
3770
- connect_after(id: string, callback: (...args: any[]) => any): number;
3771
- emit(id: string, ...args: any[]): void;
3772
- connect(signal: 'changed', callback: (_source: this, key: string) => void): number;
3773
- connect_after(signal: 'changed', callback: (_source: this, key: string) => void): number;
3774
- emit(signal: 'changed', key: string): void;
3775
- connect(signal: 'rebind', callback: (_source: this, key: string) => void): number;
3776
- connect_after(signal: 'rebind', callback: (_source: this, key: string) => void): number;
3777
- emit(signal: 'rebind', key: string): void;
3778
- connect(signal: 'track', callback: (_source: this, tracking_state: boolean) => void): number;
3779
- connect_after(signal: 'track', callback: (_source: this, tracking_state: boolean) => void): number;
3780
- emit(signal: 'track', tracking_state: boolean): void;
3962
+ connect<K extends keyof Settings.SignalSignatures>(
3963
+ signal: K,
3964
+ callback: GObject.SignalCallback<this, Settings.SignalSignatures[K]>,
3965
+ ): number;
3966
+ connect(signal: string, callback: (...args: any[]) => any): number;
3967
+ connect_after<K extends keyof Settings.SignalSignatures>(
3968
+ signal: K,
3969
+ callback: GObject.SignalCallback<this, Settings.SignalSignatures[K]>,
3970
+ ): number;
3971
+ connect_after(signal: string, callback: (...args: any[]) => any): number;
3972
+ emit<K extends keyof Settings.SignalSignatures>(
3973
+ signal: K,
3974
+ ...args: GObject.GjsParameters<Settings.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
3975
+ ): void;
3976
+ emit(signal: string, ...args: any[]): void;
3781
3977
 
3782
3978
  // Methods
3783
3979
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/gpaste-2",
3
- "version": "2.0.0-4.0.0-beta.21",
3
+ "version": "2.0.0-4.0.0-beta.24",
4
4
  "description": "GJS TypeScript type definitions for GPaste-2, generated from library version 2.0.0",
5
5
  "type": "module",
6
6
  "module": "gpaste-2.js",
@@ -31,11 +31,11 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gio-2.0": "^2.83.3-4.0.0-beta.21",
35
- "@girs/gjs": "^4.0.0-beta.21",
36
- "@girs/glib-2.0": "^2.83.3-4.0.0-beta.21",
37
- "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.21",
38
- "@girs/gobject-2.0": "^2.83.3-4.0.0-beta.21"
34
+ "@girs/gio-2.0": "^2.84.2-4.0.0-beta.24",
35
+ "@girs/gjs": "^4.0.0-beta.24",
36
+ "@girs/glib-2.0": "^2.84.2-4.0.0-beta.24",
37
+ "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.24",
38
+ "@girs/gobject-2.0": "^2.84.2-4.0.0-beta.24"
39
39
  },
40
40
  "devDependencies": {
41
41
  "typescript": "*"