@girs/cally-14 4.3.0 → 4.5.0

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 +36 -41
  2. package/cally-14.d.ts +64 -0
  3. package/package.json +19 -19
package/README.md CHANGED
@@ -4,82 +4,77 @@
4
4
  ![version](https://img.shields.io/npm/v/@girs/cally-14)
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/cally-14)
6
6
 
7
+ GJS TypeScript type definitions for Cally-14 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.5.0.
7
8
 
8
- GJS TypeScript type definitions for Cally-14 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.0.
9
+ This package contains type declarations only. It ships no runtime code, so it adds
10
+ nothing to your program and works with any bundler or none at all.
9
11
 
10
12
  ## Install
11
13
 
12
- Install the type definitions with npm:
13
14
  ```bash
14
15
  npm install @girs/cally-14
15
16
  ```
16
17
 
17
- ## Usage
18
+ Any package manager works. The package has no dependencies beyond other `@girs/*`
19
+ type packages.
20
+
21
+ ## What it exports
22
+
23
+ | Import | What you get |
24
+ |---|---|
25
+ | `@girs/cally-14` | the namespace as a default export, plus the ambient and global declarations |
26
+ | `@girs/cally-14/ambient` | only the `gi://` module declarations |
27
+ | `@girs/cally-14/import` | only the `imports.gi` declarations |
28
+ | `@girs/cally-14/cally-14` | the namespace, without the side-effecting declarations |
29
+
30
+ ## Three ways to import
31
+
32
+ Which one you use depends on how you write imports elsewhere, not on your toolchain.
33
+
34
+ ### As a module
18
35
 
19
- Import it like any other module:
20
36
  ```ts
21
37
  import Cally from '@girs/cally-14';
22
38
  ```
23
39
 
24
- ### Ambient Modules
40
+ ### As `gi://`
25
41
 
26
- [Ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) let you write the same import you would in plain JavaScript.
27
- For this you need to include `@girs/cally-14` or `@girs/cally-14/ambient` in your `tsconfig` or entry point Typescript file:
42
+ GJS resolves `gi://` at runtime. To give it types, reference the package once, either
43
+ from your entry point or from `tsconfig.json`:
28
44
 
29
- `index.ts`:
30
45
  ```ts
31
- import '@girs/cally-14'
46
+ import '@girs/cally-14';
32
47
  ```
33
48
 
34
- `tsconfig.json`:
35
49
  ```json
36
- {
37
- "compilerOptions": {
38
- ...
39
- },
40
- "include": ["@girs/cally-14"],
41
- ...
42
- }
50
+ { "include": ["@girs/cally-14"] }
43
51
  ```
44
52
 
45
- The ambient module now resolves with types:
53
+ Then the runtime spelling type-checks:
46
54
 
47
55
  ```ts
48
56
  import Cally from 'gi://Cally?version=14';
49
57
  ```
50
58
 
51
- ### Global import
52
-
53
- GJS's global `imports.gi` works too, with types.
54
- For this you need to include `@girs/cally-14` or `@girs/cally-14/import` in your `tsconfig` or entry point Typescript file:
59
+ Referencing `@girs/cally-14/ambient` instead pulls in these declarations
60
+ alone. See [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules).
55
61
 
56
- `index.ts`:
57
- ```ts
58
- import '@girs/cally-14'
59
- ```
60
-
61
- `tsconfig.json`:
62
- ```json
63
- {
64
- "compilerOptions": {
65
- ...
66
- },
67
- "include": ["@girs/cally-14"],
68
- ...
69
- }
70
- ```
62
+ ### As `imports.gi`
71
63
 
72
- That form carries types as well:
64
+ GJS's global object works the same way, via `@girs/cally-14/import`:
73
65
 
74
66
  ```ts
75
67
  const Cally = imports.gi.Cally;
76
68
  ```
77
69
 
78
- ### Bundle
70
+ ## Building
79
71
 
80
- Most projects want a bundler. [esbuild](https://esbuild.github.io/) is the smallest thing that works; the [examples directory](https://github.com/gjsify/ts-for-gir/tree/main/examples) has setups for several others.
72
+ The declarations need no build step. If you bundle, every bundler works, since there is
73
+ no runtime code to resolve. The [examples](https://github.com/gjsify/ts-for-gir/tree/main/examples)
74
+ show working setups for several.
81
75
 
82
76
  ## Other packages
83
77
 
84
- All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
78
+ Every pre-generated package is at [gjsify/types](https://github.com/gjsify/types).
79
+
85
80
 
package/cally-14.d.ts CHANGED
@@ -386,6 +386,7 @@ export namespace Cally {
386
386
  * `component`, on a scale from 0 (fully transparent) to 1.0
387
387
  * (fully opaque).
388
388
  * @returns An alpha value from 0 to 1.0, inclusive.
389
+ * @since 1.12
389
390
  */
390
391
  get_alpha(): number;
391
392
 
@@ -418,6 +419,7 @@ export namespace Cally {
418
419
  * If the position can not be obtained (e.g. a non-embedded plug or missing
419
420
  * support), x and y are set to -1.
420
421
  * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
422
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
421
423
  */
422
424
  get_position(coord_type: Atk.CoordType): [number, number];
423
425
 
@@ -426,6 +428,7 @@ export namespace Cally {
426
428
  *
427
429
  * If the size can not be obtained (e.g. a non-embedded plug or missing
428
430
  * support), width and height are set to -1.
431
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
429
432
  */
430
433
  get_size(): [number, number];
431
434
 
@@ -450,6 +453,7 @@ export namespace Cally {
450
453
  * functions to be executed when this object receives focus events
451
454
  * (in or out).
452
455
  * @param handler_id the handler id of the focus handler to be removed from `component`
456
+ * @deprecated since 2.9.4: If you need to track when an object gains or lose the focus, use the {@link Atk.Object.SignalSignatures.state_change | Atk.Object::state-change} "focused" notification instead.
453
457
  */
454
458
  remove_focus_handler(handler_id: number): void;
455
459
 
@@ -461,6 +465,7 @@ export namespace Cally {
461
465
  * object shows up on the screen, given its current position within the parents.
462
466
  * @param type specify where the object should be made visible.
463
467
  * @returns whether scrolling was successful.
468
+ * @since 2.30
464
469
  */
465
470
  scroll_to(type: Atk.ScrollType): boolean;
466
471
 
@@ -471,6 +476,7 @@ export namespace Cally {
471
476
  * @param x x-position where to scroll to
472
477
  * @param y y-position where to scroll to
473
478
  * @returns whether scrolling was successful.
479
+ * @since 2.30
474
480
  */
475
481
  scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
476
482
 
@@ -528,6 +534,7 @@ export namespace Cally {
528
534
  * Returns the alpha value (i.e. the opacity) for this
529
535
  * `component`, on a scale from 0 (fully transparent) to 1.0
530
536
  * (fully opaque).
537
+ * @since 1.12
531
538
  * @virtual
532
539
  */
533
540
  vfunc_get_alpha(): number;
@@ -562,6 +569,7 @@ export namespace Cally {
562
569
  * If the position can not be obtained (e.g. a non-embedded plug or missing
563
570
  * support), x and y are set to -1.
564
571
  * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
572
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
565
573
  * @virtual
566
574
  */
567
575
  vfunc_get_position(coord_type: Atk.CoordType): [number, number];
@@ -571,6 +579,7 @@ export namespace Cally {
571
579
  *
572
580
  * If the size can not be obtained (e.g. a non-embedded plug or missing
573
581
  * support), width and height are set to -1.
582
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
574
583
  * @virtual
575
584
  */
576
585
  vfunc_get_size(): [number, number];
@@ -596,6 +605,7 @@ export namespace Cally {
596
605
  * functions to be executed when this object receives focus events
597
606
  * (in or out).
598
607
  * @param handler_id the handler id of the focus handler to be removed from `component`
608
+ * @deprecated since 2.9.4: If you need to track when an object gains or lose the focus, use the {@link Atk.Object.SignalSignatures.state_change | Atk.Object::state-change} "focused" notification instead.
599
609
  * @virtual
600
610
  */
601
611
  vfunc_remove_focus_handler(handler_id: number): void;
@@ -607,6 +617,7 @@ export namespace Cally {
607
617
  * `component` in its parent, this only makes the parents scroll so that the
608
618
  * object shows up on the screen, given its current position within the parents.
609
619
  * @param type specify where the object should be made visible.
620
+ * @since 2.30
610
621
  * @virtual
611
622
  */
612
623
  vfunc_scroll_to(type: Atk.ScrollType): boolean;
@@ -617,6 +628,7 @@ export namespace Cally {
617
628
  * @param coords specify whether coordinates are relative to the screen or to the parent object.
618
629
  * @param x x-position where to scroll to
619
630
  * @param y y-position where to scroll to
631
+ * @since 2.30
620
632
  * @virtual
621
633
  */
622
634
  vfunc_scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
@@ -948,6 +960,7 @@ export namespace Cally {
948
960
  * `component`, on a scale from 0 (fully transparent) to 1.0
949
961
  * (fully opaque).
950
962
  * @returns An alpha value from 0 to 1.0, inclusive.
963
+ * @since 1.12
951
964
  */
952
965
  get_alpha(): number;
953
966
 
@@ -980,6 +993,7 @@ export namespace Cally {
980
993
  * If the position can not be obtained (e.g. a non-embedded plug or missing
981
994
  * support), x and y are set to -1.
982
995
  * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
996
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
983
997
  */
984
998
  get_position(coord_type: Atk.CoordType): [number, number];
985
999
 
@@ -988,6 +1002,7 @@ export namespace Cally {
988
1002
  *
989
1003
  * If the size can not be obtained (e.g. a non-embedded plug or missing
990
1004
  * support), width and height are set to -1.
1005
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
991
1006
  */
992
1007
  get_size(): [number, number];
993
1008
 
@@ -1012,6 +1027,7 @@ export namespace Cally {
1012
1027
  * functions to be executed when this object receives focus events
1013
1028
  * (in or out).
1014
1029
  * @param handler_id the handler id of the focus handler to be removed from `component`
1030
+ * @deprecated since 2.9.4: If you need to track when an object gains or lose the focus, use the {@link Atk.Object.SignalSignatures.state_change | Atk.Object::state-change} "focused" notification instead.
1015
1031
  */
1016
1032
  remove_focus_handler(handler_id: number): void;
1017
1033
 
@@ -1023,6 +1039,7 @@ export namespace Cally {
1023
1039
  * object shows up on the screen, given its current position within the parents.
1024
1040
  * @param type specify where the object should be made visible.
1025
1041
  * @returns whether scrolling was successful.
1042
+ * @since 2.30
1026
1043
  */
1027
1044
  scroll_to(type: Atk.ScrollType): boolean;
1028
1045
 
@@ -1033,6 +1050,7 @@ export namespace Cally {
1033
1050
  * @param x x-position where to scroll to
1034
1051
  * @param y y-position where to scroll to
1035
1052
  * @returns whether scrolling was successful.
1053
+ * @since 2.30
1036
1054
  */
1037
1055
  scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
1038
1056
 
@@ -1090,6 +1108,7 @@ export namespace Cally {
1090
1108
  * Returns the alpha value (i.e. the opacity) for this
1091
1109
  * `component`, on a scale from 0 (fully transparent) to 1.0
1092
1110
  * (fully opaque).
1111
+ * @since 1.12
1093
1112
  * @virtual
1094
1113
  */
1095
1114
  vfunc_get_alpha(): number;
@@ -1124,6 +1143,7 @@ export namespace Cally {
1124
1143
  * If the position can not be obtained (e.g. a non-embedded plug or missing
1125
1144
  * support), x and y are set to -1.
1126
1145
  * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
1146
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
1127
1147
  * @virtual
1128
1148
  */
1129
1149
  vfunc_get_position(coord_type: Atk.CoordType): [number, number];
@@ -1133,6 +1153,7 @@ export namespace Cally {
1133
1153
  *
1134
1154
  * If the size can not be obtained (e.g. a non-embedded plug or missing
1135
1155
  * support), width and height are set to -1.
1156
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
1136
1157
  * @virtual
1137
1158
  */
1138
1159
  vfunc_get_size(): [number, number];
@@ -1158,6 +1179,7 @@ export namespace Cally {
1158
1179
  * functions to be executed when this object receives focus events
1159
1180
  * (in or out).
1160
1181
  * @param handler_id the handler id of the focus handler to be removed from `component`
1182
+ * @deprecated since 2.9.4: If you need to track when an object gains or lose the focus, use the {@link Atk.Object.SignalSignatures.state_change | Atk.Object::state-change} "focused" notification instead.
1161
1183
  * @virtual
1162
1184
  */
1163
1185
  vfunc_remove_focus_handler(handler_id: number): void;
@@ -1169,6 +1191,7 @@ export namespace Cally {
1169
1191
  * `component` in its parent, this only makes the parents scroll so that the
1170
1192
  * object shows up on the screen, given its current position within the parents.
1171
1193
  * @param type specify where the object should be made visible.
1194
+ * @since 2.30
1172
1195
  * @virtual
1173
1196
  */
1174
1197
  vfunc_scroll_to(type: Atk.ScrollType): boolean;
@@ -1179,6 +1202,7 @@ export namespace Cally {
1179
1202
  * @param coords specify whether coordinates are relative to the screen or to the parent object.
1180
1203
  * @param x x-position where to scroll to
1181
1204
  * @param y y-position where to scroll to
1205
+ * @since 2.30
1182
1206
  * @virtual
1183
1207
  */
1184
1208
  vfunc_scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
@@ -1586,6 +1610,7 @@ export namespace Cally {
1586
1610
  * `component`, on a scale from 0 (fully transparent) to 1.0
1587
1611
  * (fully opaque).
1588
1612
  * @returns An alpha value from 0 to 1.0, inclusive.
1613
+ * @since 1.12
1589
1614
  */
1590
1615
  get_alpha(): number;
1591
1616
 
@@ -1618,6 +1643,7 @@ export namespace Cally {
1618
1643
  * If the position can not be obtained (e.g. a non-embedded plug or missing
1619
1644
  * support), x and y are set to -1.
1620
1645
  * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
1646
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
1621
1647
  */
1622
1648
  get_position(coord_type: Atk.CoordType): [number, number];
1623
1649
 
@@ -1626,6 +1652,7 @@ export namespace Cally {
1626
1652
  *
1627
1653
  * If the size can not be obtained (e.g. a non-embedded plug or missing
1628
1654
  * support), width and height are set to -1.
1655
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
1629
1656
  */
1630
1657
  get_size(): [number, number];
1631
1658
 
@@ -1650,6 +1677,7 @@ export namespace Cally {
1650
1677
  * functions to be executed when this object receives focus events
1651
1678
  * (in or out).
1652
1679
  * @param handler_id the handler id of the focus handler to be removed from `component`
1680
+ * @deprecated since 2.9.4: If you need to track when an object gains or lose the focus, use the {@link Atk.Object.SignalSignatures.state_change | Atk.Object::state-change} "focused" notification instead.
1653
1681
  */
1654
1682
  remove_focus_handler(handler_id: number): void;
1655
1683
 
@@ -1661,6 +1689,7 @@ export namespace Cally {
1661
1689
  * object shows up on the screen, given its current position within the parents.
1662
1690
  * @param type specify where the object should be made visible.
1663
1691
  * @returns whether scrolling was successful.
1692
+ * @since 2.30
1664
1693
  */
1665
1694
  scroll_to(type: Atk.ScrollType): boolean;
1666
1695
 
@@ -1671,6 +1700,7 @@ export namespace Cally {
1671
1700
  * @param x x-position where to scroll to
1672
1701
  * @param y y-position where to scroll to
1673
1702
  * @returns whether scrolling was successful.
1703
+ * @since 2.30
1674
1704
  */
1675
1705
  scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
1676
1706
 
@@ -1728,6 +1758,7 @@ export namespace Cally {
1728
1758
  * Returns the alpha value (i.e. the opacity) for this
1729
1759
  * `component`, on a scale from 0 (fully transparent) to 1.0
1730
1760
  * (fully opaque).
1761
+ * @since 1.12
1731
1762
  * @virtual
1732
1763
  */
1733
1764
  vfunc_get_alpha(): number;
@@ -1762,6 +1793,7 @@ export namespace Cally {
1762
1793
  * If the position can not be obtained (e.g. a non-embedded plug or missing
1763
1794
  * support), x and y are set to -1.
1764
1795
  * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
1796
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
1765
1797
  * @virtual
1766
1798
  */
1767
1799
  vfunc_get_position(coord_type: Atk.CoordType): [number, number];
@@ -1771,6 +1803,7 @@ export namespace Cally {
1771
1803
  *
1772
1804
  * If the size can not be obtained (e.g. a non-embedded plug or missing
1773
1805
  * support), width and height are set to -1.
1806
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
1774
1807
  * @virtual
1775
1808
  */
1776
1809
  vfunc_get_size(): [number, number];
@@ -1796,6 +1829,7 @@ export namespace Cally {
1796
1829
  * functions to be executed when this object receives focus events
1797
1830
  * (in or out).
1798
1831
  * @param handler_id the handler id of the focus handler to be removed from `component`
1832
+ * @deprecated since 2.9.4: If you need to track when an object gains or lose the focus, use the {@link Atk.Object.SignalSignatures.state_change | Atk.Object::state-change} "focused" notification instead.
1799
1833
  * @virtual
1800
1834
  */
1801
1835
  vfunc_remove_focus_handler(handler_id: number): void;
@@ -1807,6 +1841,7 @@ export namespace Cally {
1807
1841
  * `component` in its parent, this only makes the parents scroll so that the
1808
1842
  * object shows up on the screen, given its current position within the parents.
1809
1843
  * @param type specify where the object should be made visible.
1844
+ * @since 2.30
1810
1845
  * @virtual
1811
1846
  */
1812
1847
  vfunc_scroll_to(type: Atk.ScrollType): boolean;
@@ -1817,6 +1852,7 @@ export namespace Cally {
1817
1852
  * @param coords specify whether coordinates are relative to the screen or to the parent object.
1818
1853
  * @param x x-position where to scroll to
1819
1854
  * @param y y-position where to scroll to
1855
+ * @since 2.30
1820
1856
  * @virtual
1821
1857
  */
1822
1858
  vfunc_scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
@@ -2146,6 +2182,7 @@ export namespace Cally {
2146
2182
  * `component`, on a scale from 0 (fully transparent) to 1.0
2147
2183
  * (fully opaque).
2148
2184
  * @returns An alpha value from 0 to 1.0, inclusive.
2185
+ * @since 1.12
2149
2186
  */
2150
2187
  get_alpha(): number;
2151
2188
 
@@ -2178,6 +2215,7 @@ export namespace Cally {
2178
2215
  * If the position can not be obtained (e.g. a non-embedded plug or missing
2179
2216
  * support), x and y are set to -1.
2180
2217
  * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
2218
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
2181
2219
  */
2182
2220
  get_position(coord_type: Atk.CoordType): [number, number];
2183
2221
 
@@ -2186,6 +2224,7 @@ export namespace Cally {
2186
2224
  *
2187
2225
  * If the size can not be obtained (e.g. a non-embedded plug or missing
2188
2226
  * support), width and height are set to -1.
2227
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
2189
2228
  */
2190
2229
  get_size(): [number, number];
2191
2230
 
@@ -2210,6 +2249,7 @@ export namespace Cally {
2210
2249
  * functions to be executed when this object receives focus events
2211
2250
  * (in or out).
2212
2251
  * @param handler_id the handler id of the focus handler to be removed from `component`
2252
+ * @deprecated since 2.9.4: If you need to track when an object gains or lose the focus, use the {@link Atk.Object.SignalSignatures.state_change | Atk.Object::state-change} "focused" notification instead.
2213
2253
  */
2214
2254
  remove_focus_handler(handler_id: number): void;
2215
2255
 
@@ -2221,6 +2261,7 @@ export namespace Cally {
2221
2261
  * object shows up on the screen, given its current position within the parents.
2222
2262
  * @param type specify where the object should be made visible.
2223
2263
  * @returns whether scrolling was successful.
2264
+ * @since 2.30
2224
2265
  */
2225
2266
  scroll_to(type: Atk.ScrollType): boolean;
2226
2267
 
@@ -2231,6 +2272,7 @@ export namespace Cally {
2231
2272
  * @param x x-position where to scroll to
2232
2273
  * @param y y-position where to scroll to
2233
2274
  * @returns whether scrolling was successful.
2275
+ * @since 2.30
2234
2276
  */
2235
2277
  scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
2236
2278
 
@@ -2288,6 +2330,7 @@ export namespace Cally {
2288
2330
  * Returns the alpha value (i.e. the opacity) for this
2289
2331
  * `component`, on a scale from 0 (fully transparent) to 1.0
2290
2332
  * (fully opaque).
2333
+ * @since 1.12
2291
2334
  * @virtual
2292
2335
  */
2293
2336
  vfunc_get_alpha(): number;
@@ -2322,6 +2365,7 @@ export namespace Cally {
2322
2365
  * If the position can not be obtained (e.g. a non-embedded plug or missing
2323
2366
  * support), x and y are set to -1.
2324
2367
  * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
2368
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
2325
2369
  * @virtual
2326
2370
  */
2327
2371
  vfunc_get_position(coord_type: Atk.CoordType): [number, number];
@@ -2331,6 +2375,7 @@ export namespace Cally {
2331
2375
  *
2332
2376
  * If the size can not be obtained (e.g. a non-embedded plug or missing
2333
2377
  * support), width and height are set to -1.
2378
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
2334
2379
  * @virtual
2335
2380
  */
2336
2381
  vfunc_get_size(): [number, number];
@@ -2356,6 +2401,7 @@ export namespace Cally {
2356
2401
  * functions to be executed when this object receives focus events
2357
2402
  * (in or out).
2358
2403
  * @param handler_id the handler id of the focus handler to be removed from `component`
2404
+ * @deprecated since 2.9.4: If you need to track when an object gains or lose the focus, use the {@link Atk.Object.SignalSignatures.state_change | Atk.Object::state-change} "focused" notification instead.
2359
2405
  * @virtual
2360
2406
  */
2361
2407
  vfunc_remove_focus_handler(handler_id: number): void;
@@ -2367,6 +2413,7 @@ export namespace Cally {
2367
2413
  * `component` in its parent, this only makes the parents scroll so that the
2368
2414
  * object shows up on the screen, given its current position within the parents.
2369
2415
  * @param type specify where the object should be made visible.
2416
+ * @since 2.30
2370
2417
  * @virtual
2371
2418
  */
2372
2419
  vfunc_scroll_to(type: Atk.ScrollType): boolean;
@@ -2377,6 +2424,7 @@ export namespace Cally {
2377
2424
  * @param coords specify whether coordinates are relative to the screen or to the parent object.
2378
2425
  * @param x x-position where to scroll to
2379
2426
  * @param y y-position where to scroll to
2427
+ * @since 2.30
2380
2428
  * @virtual
2381
2429
  */
2382
2430
  vfunc_scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
@@ -2543,6 +2591,7 @@ export namespace Cally {
2543
2591
  * @param x_clip_type Specify the horizontal clip type.
2544
2592
  * @param y_clip_type Specify the vertical clip type.
2545
2593
  * @returns Array of AtkTextRange. The last element of the array returned by this function will be NULL.
2594
+ * @since 1.3
2546
2595
  */
2547
2596
  get_bounded_ranges(rect: Atk.TextRectangle, coord_type: Atk.CoordType, x_clip_type: Atk.TextClipType, y_clip_type: Atk.TextClipType): Atk.TextRange[];
2548
2597
 
@@ -2610,6 +2659,7 @@ export namespace Cally {
2610
2659
  * @param start_offset The offset of the first text character for which boundary information is required.
2611
2660
  * @param end_offset The offset of the text character after the last character for which boundary information is required.
2612
2661
  * @param coord_type Specify whether coordinates are relative to the screen or widget window.
2662
+ * @since 1.3
2613
2663
  */
2614
2664
  get_range_extents(start_offset: number, end_offset: number, coord_type: Atk.CoordType): Atk.TextRectangle;
2615
2665
 
@@ -2667,6 +2717,7 @@ export namespace Cally {
2667
2717
  * @param offset position
2668
2718
  * @param granularity An {@link Atk.TextGranularity}
2669
2719
  * @returns a newly allocated string containing the text at the `offset` bounded by the specified `granularity`. Use `g_free()` to free the returned string. Returns `null` if the offset is invalid or no implementation is available.
2720
+ * @since 2.10
2670
2721
  */
2671
2722
  get_string_at_offset(offset: number, granularity: Atk.TextGranularity): [string | null, number, number];
2672
2723
 
@@ -2683,6 +2734,7 @@ export namespace Cally {
2683
2734
  * @param offset position
2684
2735
  * @param boundary_type An {@link Atk.TextBoundary}
2685
2736
  * @returns a newly allocated string containing the text after `offset` bounded by the specified `boundary_type`. Use `g_free()` to free the returned string.
2737
+ * @deprecated since 2.9.3: Please use `atk_text_get_string_at_offset()` instead.
2686
2738
  */
2687
2739
  get_text_after_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
2688
2740
 
@@ -2714,6 +2766,7 @@ export namespace Cally {
2714
2766
  * @param offset position
2715
2767
  * @param boundary_type An {@link Atk.TextBoundary}
2716
2768
  * @returns a newly allocated string containing the text at `offset` bounded by the specified `boundary_type`. Use `g_free()` to free the returned string.
2769
+ * @deprecated This method is deprecated since ATK version 2.9.4. Please use `atk_text_get_string_at_offset()` instead.
2717
2770
  */
2718
2771
  get_text_at_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
2719
2772
 
@@ -2722,6 +2775,7 @@ export namespace Cally {
2722
2775
  * @param offset position
2723
2776
  * @param boundary_type An {@link Atk.TextBoundary}
2724
2777
  * @returns a newly allocated string containing the text before `offset` bounded by the specified `boundary_type`. Use `g_free()` to free the returned string.
2778
+ * @deprecated since 2.9.3: Please use `atk_text_get_string_at_offset()` instead.
2725
2779
  */
2726
2780
  get_text_before_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
2727
2781
 
@@ -2738,6 +2792,7 @@ export namespace Cally {
2738
2792
  * @param end_offset end offset in the `text`, or -1 for the end of the text.
2739
2793
  * @param type specify where the object should be made visible.
2740
2794
  * @returns whether scrolling was successful.
2795
+ * @since 2.32
2741
2796
  */
2742
2797
  scroll_substring_to(start_offset: number, end_offset: number, type: Atk.ScrollType): boolean;
2743
2798
 
@@ -2750,6 +2805,7 @@ export namespace Cally {
2750
2805
  * @param x x-position where to scroll to
2751
2806
  * @param y y-position where to scroll to
2752
2807
  * @returns whether scrolling was successful.
2808
+ * @since 2.32
2753
2809
  */
2754
2810
  scroll_substring_to_point(start_offset: number, end_offset: number, coords: Atk.CoordType, x: number, y: number): boolean;
2755
2811
 
@@ -2799,6 +2855,7 @@ export namespace Cally {
2799
2855
  * @param coord_type Specify whether coordinates are relative to the screen or widget window.
2800
2856
  * @param x_clip_type Specify the horizontal clip type.
2801
2857
  * @param y_clip_type Specify the vertical clip type.
2858
+ * @since 1.3
2802
2859
  * @virtual
2803
2860
  */
2804
2861
  vfunc_get_bounded_ranges(rect: Atk.TextRectangle, coord_type: Atk.CoordType, x_clip_type: Atk.TextClipType, y_clip_type: Atk.TextClipType): Atk.TextRange[];
@@ -2868,6 +2925,7 @@ export namespace Cally {
2868
2925
  * @param start_offset The offset of the first text character for which boundary information is required.
2869
2926
  * @param end_offset The offset of the text character after the last character for which boundary information is required.
2870
2927
  * @param coord_type Specify whether coordinates are relative to the screen or widget window.
2928
+ * @since 1.3
2871
2929
  * @virtual
2872
2930
  */
2873
2931
  vfunc_get_range_extents(start_offset: number, end_offset: number, coord_type: Atk.CoordType): Atk.TextRectangle;
@@ -2925,6 +2983,7 @@ export namespace Cally {
2925
2983
  * of the following paragraph after the offset.
2926
2984
  * @param offset position
2927
2985
  * @param granularity An {@link Atk.TextGranularity}
2986
+ * @since 2.10
2928
2987
  * @virtual
2929
2988
  */
2930
2989
  vfunc_get_string_at_offset(offset: number, granularity: Atk.TextGranularity): [string | null, number, number];
@@ -2941,6 +3000,7 @@ export namespace Cally {
2941
3000
  * Gets the specified text.
2942
3001
  * @param offset position
2943
3002
  * @param boundary_type An {@link Atk.TextBoundary}
3003
+ * @deprecated since 2.9.3: Please use `atk_text_get_string_at_offset()` instead.
2944
3004
  * @virtual
2945
3005
  */
2946
3006
  vfunc_get_text_after_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
@@ -2972,6 +3032,7 @@ export namespace Cally {
2972
3032
  * start after the offset.
2973
3033
  * @param offset position
2974
3034
  * @param boundary_type An {@link Atk.TextBoundary}
3035
+ * @deprecated This method is deprecated since ATK version 2.9.4. Please use `atk_text_get_string_at_offset()` instead.
2975
3036
  * @virtual
2976
3037
  */
2977
3038
  vfunc_get_text_at_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
@@ -2980,6 +3041,7 @@ export namespace Cally {
2980
3041
  * Gets the specified text.
2981
3042
  * @param offset position
2982
3043
  * @param boundary_type An {@link Atk.TextBoundary}
3044
+ * @deprecated since 2.9.3: Please use `atk_text_get_string_at_offset()` instead.
2983
3045
  * @virtual
2984
3046
  */
2985
3047
  vfunc_get_text_before_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
@@ -2996,6 +3058,7 @@ export namespace Cally {
2996
3058
  * @param start_offset start offset in the `text`
2997
3059
  * @param end_offset end offset in the `text`, or -1 for the end of the text.
2998
3060
  * @param type specify where the object should be made visible.
3061
+ * @since 2.32
2999
3062
  * @virtual
3000
3063
  */
3001
3064
  vfunc_scroll_substring_to(start_offset: number, end_offset: number, type: Atk.ScrollType): boolean;
@@ -3008,6 +3071,7 @@ export namespace Cally {
3008
3071
  * @param coords specify whether coordinates are relative to the screen or to the parent object.
3009
3072
  * @param x x-position where to scroll to
3010
3073
  * @param y y-position where to scroll to
3074
+ * @since 2.32
3011
3075
  * @virtual
3012
3076
  */
3013
3077
  vfunc_scroll_substring_to_point(start_offset: number, end_offset: number, coords: Atk.CoordType, x: number, y: number): boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/cally-14",
3
- "version": "4.3.0",
3
+ "version": "4.5.0",
4
4
  "description": "GJS TypeScript type definitions for Cally-14",
5
5
  "type": "module",
6
6
  "module": "cally-14.js",
@@ -31,24 +31,24 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gjs": "^4.3.0",
35
- "@girs/mtk-14": "^4.3.0",
36
- "@girs/graphene-1.0": "^4.3.0",
37
- "@girs/gobject-2.0": "^4.3.0",
38
- "@girs/glib-2.0": "^4.3.0",
39
- "@girs/coglpango-14": "^4.3.0",
40
- "@girs/pangocairo-1.0": "^4.3.0",
41
- "@girs/cairo-1.0": "^4.3.0",
42
- "@girs/pango-1.0": "^4.3.0",
43
- "@girs/harfbuzz-0.0": "^4.3.0",
44
- "@girs/freetype2-2.0": "^4.3.0",
45
- "@girs/gio-2.0": "^4.3.0",
46
- "@girs/gmodule-2.0": "^4.3.0",
47
- "@girs/cogl-14": "^4.3.0",
48
- "@girs/xlib-2.0": "^4.3.0",
49
- "@girs/gl-1.0": "^4.3.0",
50
- "@girs/clutter-14": "^4.3.0",
51
- "@girs/atk-1.0": "^4.3.0" },
34
+ "@girs/gjs": "^4.5.0",
35
+ "@girs/mtk-14": "^4.5.0",
36
+ "@girs/graphene-1.0": "^4.5.0",
37
+ "@girs/gobject-2.0": "^4.5.0",
38
+ "@girs/glib-2.0": "^4.5.0",
39
+ "@girs/coglpango-14": "^4.5.0",
40
+ "@girs/pangocairo-1.0": "^4.5.0",
41
+ "@girs/cairo-1.0": "^4.5.0",
42
+ "@girs/pango-1.0": "^4.5.0",
43
+ "@girs/harfbuzz-0.0": "^4.5.0",
44
+ "@girs/freetype2-2.0": "^4.5.0",
45
+ "@girs/gio-2.0": "^4.5.0",
46
+ "@girs/gmodule-2.0": "^4.5.0",
47
+ "@girs/cogl-14": "^4.5.0",
48
+ "@girs/xlib-2.0": "^4.5.0",
49
+ "@girs/gl-1.0": "^4.5.0",
50
+ "@girs/clutter-14": "^4.5.0",
51
+ "@girs/atk-1.0": "^4.5.0" },
52
52
  "devDependencies": {
53
53
  "typescript": "*"
54
54
  },