@girs/cally-15 4.2.0 → 4.4.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 +8 -8
  2. package/cally-15.d.ts +64 -0
  3. package/package.json +19 -19
package/README.md CHANGED
@@ -5,25 +5,25 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/cally-15)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Cally-15 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
8
+ GJS TypeScript type definitions for Cally-15 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.0.
9
9
 
10
10
  ## Install
11
11
 
12
- To use this type definitions, install them with NPM:
12
+ Install the type definitions with npm:
13
13
  ```bash
14
14
  npm install @girs/cally-15
15
15
  ```
16
16
 
17
17
  ## Usage
18
18
 
19
- You can import this package into your project like this:
19
+ Import it like any other module:
20
20
  ```ts
21
21
  import Cally from '@girs/cally-15';
22
22
  ```
23
23
 
24
24
  ### Ambient Modules
25
25
 
26
- You can also use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) to import this module like you would do this in JavaScript.
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
27
  For this you need to include `@girs/cally-15` or `@girs/cally-15/ambient` in your `tsconfig` or entry point Typescript file:
28
28
 
29
29
  `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/cally-15'
42
42
  }
43
43
  ```
44
44
 
45
- Now you can import the ambient module with TypeScript support:
45
+ The ambient module now resolves with types:
46
46
 
47
47
  ```ts
48
48
  import Cally from 'gi://Cally?version=15';
@@ -50,7 +50,7 @@ import Cally from 'gi://Cally?version=15';
50
50
 
51
51
  ### Global import
52
52
 
53
- You can also import the module with Typescript support using the global `imports.gi` object of GJS.
53
+ GJS's global `imports.gi` works too, with types.
54
54
  For this you need to include `@girs/cally-15` or `@girs/cally-15/import` in your `tsconfig` or entry point Typescript file:
55
55
 
56
56
  `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/cally-15'
69
69
  }
70
70
  ```
71
71
 
72
- Now you have also type support for this, too:
72
+ That form carries types as well:
73
73
 
74
74
  ```ts
75
75
  const Cally = imports.gi.Cally;
@@ -77,7 +77,7 @@ const Cally = imports.gi.Cally;
77
77
 
78
78
  ### Bundle
79
79
 
80
- Depending on your project configuration, it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). You can find examples using different bundlers [here](https://github.com/gjsify/ts-for-gir/tree/main/examples).
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.
81
81
 
82
82
  ## Other packages
83
83
 
package/cally-15.d.ts CHANGED
@@ -137,6 +137,7 @@ export namespace Cally {
137
137
  * `component`, on a scale from 0 (fully transparent) to 1.0
138
138
  * (fully opaque).
139
139
  * @returns An alpha value from 0 to 1.0, inclusive.
140
+ * @since 1.12
140
141
  */
141
142
  get_alpha(): number;
142
143
 
@@ -169,6 +170,7 @@ export namespace Cally {
169
170
  * If the position can not be obtained (e.g. a non-embedded plug or missing
170
171
  * support), x and y are set to -1.
171
172
  * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
173
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
172
174
  */
173
175
  get_position(coord_type: Atk.CoordType): [number, number];
174
176
 
@@ -177,6 +179,7 @@ export namespace Cally {
177
179
  *
178
180
  * If the size can not be obtained (e.g. a non-embedded plug or missing
179
181
  * support), width and height are set to -1.
182
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
180
183
  */
181
184
  get_size(): [number, number];
182
185
 
@@ -201,6 +204,7 @@ export namespace Cally {
201
204
  * functions to be executed when this object receives focus events
202
205
  * (in or out).
203
206
  * @param handler_id the handler id of the focus handler to be removed from `component`
207
+ * @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.
204
208
  */
205
209
  remove_focus_handler(handler_id: number): void;
206
210
 
@@ -212,6 +216,7 @@ export namespace Cally {
212
216
  * object shows up on the screen, given its current position within the parents.
213
217
  * @param type specify where the object should be made visible.
214
218
  * @returns whether scrolling was successful.
219
+ * @since 2.30
215
220
  */
216
221
  scroll_to(type: Atk.ScrollType): boolean;
217
222
 
@@ -222,6 +227,7 @@ export namespace Cally {
222
227
  * @param x x-position where to scroll to
223
228
  * @param y y-position where to scroll to
224
229
  * @returns whether scrolling was successful.
230
+ * @since 2.30
225
231
  */
226
232
  scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
227
233
 
@@ -279,6 +285,7 @@ export namespace Cally {
279
285
  * Returns the alpha value (i.e. the opacity) for this
280
286
  * `component`, on a scale from 0 (fully transparent) to 1.0
281
287
  * (fully opaque).
288
+ * @since 1.12
282
289
  * @virtual
283
290
  */
284
291
  vfunc_get_alpha(): number;
@@ -313,6 +320,7 @@ export namespace Cally {
313
320
  * If the position can not be obtained (e.g. a non-embedded plug or missing
314
321
  * support), x and y are set to -1.
315
322
  * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
323
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
316
324
  * @virtual
317
325
  */
318
326
  vfunc_get_position(coord_type: Atk.CoordType): [number, number];
@@ -322,6 +330,7 @@ export namespace Cally {
322
330
  *
323
331
  * If the size can not be obtained (e.g. a non-embedded plug or missing
324
332
  * support), width and height are set to -1.
333
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
325
334
  * @virtual
326
335
  */
327
336
  vfunc_get_size(): [number, number];
@@ -347,6 +356,7 @@ export namespace Cally {
347
356
  * functions to be executed when this object receives focus events
348
357
  * (in or out).
349
358
  * @param handler_id the handler id of the focus handler to be removed from `component`
359
+ * @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.
350
360
  * @virtual
351
361
  */
352
362
  vfunc_remove_focus_handler(handler_id: number): void;
@@ -358,6 +368,7 @@ export namespace Cally {
358
368
  * `component` in its parent, this only makes the parents scroll so that the
359
369
  * object shows up on the screen, given its current position within the parents.
360
370
  * @param type specify where the object should be made visible.
371
+ * @since 2.30
361
372
  * @virtual
362
373
  */
363
374
  vfunc_scroll_to(type: Atk.ScrollType): boolean;
@@ -368,6 +379,7 @@ export namespace Cally {
368
379
  * @param coords specify whether coordinates are relative to the screen or to the parent object.
369
380
  * @param x x-position where to scroll to
370
381
  * @param y y-position where to scroll to
382
+ * @since 2.30
371
383
  * @virtual
372
384
  */
373
385
  vfunc_scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
@@ -490,6 +502,7 @@ export namespace Cally {
490
502
  * `component`, on a scale from 0 (fully transparent) to 1.0
491
503
  * (fully opaque).
492
504
  * @returns An alpha value from 0 to 1.0, inclusive.
505
+ * @since 1.12
493
506
  */
494
507
  get_alpha(): number;
495
508
 
@@ -522,6 +535,7 @@ export namespace Cally {
522
535
  * If the position can not be obtained (e.g. a non-embedded plug or missing
523
536
  * support), x and y are set to -1.
524
537
  * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
538
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
525
539
  */
526
540
  get_position(coord_type: Atk.CoordType): [number, number];
527
541
 
@@ -530,6 +544,7 @@ export namespace Cally {
530
544
  *
531
545
  * If the size can not be obtained (e.g. a non-embedded plug or missing
532
546
  * support), width and height are set to -1.
547
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
533
548
  */
534
549
  get_size(): [number, number];
535
550
 
@@ -554,6 +569,7 @@ export namespace Cally {
554
569
  * functions to be executed when this object receives focus events
555
570
  * (in or out).
556
571
  * @param handler_id the handler id of the focus handler to be removed from `component`
572
+ * @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.
557
573
  */
558
574
  remove_focus_handler(handler_id: number): void;
559
575
 
@@ -565,6 +581,7 @@ export namespace Cally {
565
581
  * object shows up on the screen, given its current position within the parents.
566
582
  * @param type specify where the object should be made visible.
567
583
  * @returns whether scrolling was successful.
584
+ * @since 2.30
568
585
  */
569
586
  scroll_to(type: Atk.ScrollType): boolean;
570
587
 
@@ -575,6 +592,7 @@ export namespace Cally {
575
592
  * @param x x-position where to scroll to
576
593
  * @param y y-position where to scroll to
577
594
  * @returns whether scrolling was successful.
595
+ * @since 2.30
578
596
  */
579
597
  scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
580
598
 
@@ -632,6 +650,7 @@ export namespace Cally {
632
650
  * Returns the alpha value (i.e. the opacity) for this
633
651
  * `component`, on a scale from 0 (fully transparent) to 1.0
634
652
  * (fully opaque).
653
+ * @since 1.12
635
654
  * @virtual
636
655
  */
637
656
  vfunc_get_alpha(): number;
@@ -666,6 +685,7 @@ export namespace Cally {
666
685
  * If the position can not be obtained (e.g. a non-embedded plug or missing
667
686
  * support), x and y are set to -1.
668
687
  * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
688
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
669
689
  * @virtual
670
690
  */
671
691
  vfunc_get_position(coord_type: Atk.CoordType): [number, number];
@@ -675,6 +695,7 @@ export namespace Cally {
675
695
  *
676
696
  * If the size can not be obtained (e.g. a non-embedded plug or missing
677
697
  * support), width and height are set to -1.
698
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
678
699
  * @virtual
679
700
  */
680
701
  vfunc_get_size(): [number, number];
@@ -700,6 +721,7 @@ export namespace Cally {
700
721
  * functions to be executed when this object receives focus events
701
722
  * (in or out).
702
723
  * @param handler_id the handler id of the focus handler to be removed from `component`
724
+ * @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.
703
725
  * @virtual
704
726
  */
705
727
  vfunc_remove_focus_handler(handler_id: number): void;
@@ -711,6 +733,7 @@ export namespace Cally {
711
733
  * `component` in its parent, this only makes the parents scroll so that the
712
734
  * object shows up on the screen, given its current position within the parents.
713
735
  * @param type specify where the object should be made visible.
736
+ * @since 2.30
714
737
  * @virtual
715
738
  */
716
739
  vfunc_scroll_to(type: Atk.ScrollType): boolean;
@@ -721,6 +744,7 @@ export namespace Cally {
721
744
  * @param coords specify whether coordinates are relative to the screen or to the parent object.
722
745
  * @param x x-position where to scroll to
723
746
  * @param y y-position where to scroll to
747
+ * @since 2.30
724
748
  * @virtual
725
749
  */
726
750
  vfunc_scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
@@ -919,6 +943,7 @@ export namespace Cally {
919
943
  * `component`, on a scale from 0 (fully transparent) to 1.0
920
944
  * (fully opaque).
921
945
  * @returns An alpha value from 0 to 1.0, inclusive.
946
+ * @since 1.12
922
947
  */
923
948
  get_alpha(): number;
924
949
 
@@ -951,6 +976,7 @@ export namespace Cally {
951
976
  * If the position can not be obtained (e.g. a non-embedded plug or missing
952
977
  * support), x and y are set to -1.
953
978
  * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
979
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
954
980
  */
955
981
  get_position(coord_type: Atk.CoordType): [number, number];
956
982
 
@@ -959,6 +985,7 @@ export namespace Cally {
959
985
  *
960
986
  * If the size can not be obtained (e.g. a non-embedded plug or missing
961
987
  * support), width and height are set to -1.
988
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
962
989
  */
963
990
  get_size(): [number, number];
964
991
 
@@ -983,6 +1010,7 @@ export namespace Cally {
983
1010
  * functions to be executed when this object receives focus events
984
1011
  * (in or out).
985
1012
  * @param handler_id the handler id of the focus handler to be removed from `component`
1013
+ * @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.
986
1014
  */
987
1015
  remove_focus_handler(handler_id: number): void;
988
1016
 
@@ -994,6 +1022,7 @@ export namespace Cally {
994
1022
  * object shows up on the screen, given its current position within the parents.
995
1023
  * @param type specify where the object should be made visible.
996
1024
  * @returns whether scrolling was successful.
1025
+ * @since 2.30
997
1026
  */
998
1027
  scroll_to(type: Atk.ScrollType): boolean;
999
1028
 
@@ -1004,6 +1033,7 @@ export namespace Cally {
1004
1033
  * @param x x-position where to scroll to
1005
1034
  * @param y y-position where to scroll to
1006
1035
  * @returns whether scrolling was successful.
1036
+ * @since 2.30
1007
1037
  */
1008
1038
  scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
1009
1039
 
@@ -1061,6 +1091,7 @@ export namespace Cally {
1061
1091
  * Returns the alpha value (i.e. the opacity) for this
1062
1092
  * `component`, on a scale from 0 (fully transparent) to 1.0
1063
1093
  * (fully opaque).
1094
+ * @since 1.12
1064
1095
  * @virtual
1065
1096
  */
1066
1097
  vfunc_get_alpha(): number;
@@ -1095,6 +1126,7 @@ export namespace Cally {
1095
1126
  * If the position can not be obtained (e.g. a non-embedded plug or missing
1096
1127
  * support), x and y are set to -1.
1097
1128
  * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
1129
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
1098
1130
  * @virtual
1099
1131
  */
1100
1132
  vfunc_get_position(coord_type: Atk.CoordType): [number, number];
@@ -1104,6 +1136,7 @@ export namespace Cally {
1104
1136
  *
1105
1137
  * If the size can not be obtained (e.g. a non-embedded plug or missing
1106
1138
  * support), width and height are set to -1.
1139
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
1107
1140
  * @virtual
1108
1141
  */
1109
1142
  vfunc_get_size(): [number, number];
@@ -1129,6 +1162,7 @@ export namespace Cally {
1129
1162
  * functions to be executed when this object receives focus events
1130
1163
  * (in or out).
1131
1164
  * @param handler_id the handler id of the focus handler to be removed from `component`
1165
+ * @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.
1132
1166
  * @virtual
1133
1167
  */
1134
1168
  vfunc_remove_focus_handler(handler_id: number): void;
@@ -1140,6 +1174,7 @@ export namespace Cally {
1140
1174
  * `component` in its parent, this only makes the parents scroll so that the
1141
1175
  * object shows up on the screen, given its current position within the parents.
1142
1176
  * @param type specify where the object should be made visible.
1177
+ * @since 2.30
1143
1178
  * @virtual
1144
1179
  */
1145
1180
  vfunc_scroll_to(type: Atk.ScrollType): boolean;
@@ -1150,6 +1185,7 @@ export namespace Cally {
1150
1185
  * @param coords specify whether coordinates are relative to the screen or to the parent object.
1151
1186
  * @param x x-position where to scroll to
1152
1187
  * @param y y-position where to scroll to
1188
+ * @since 2.30
1153
1189
  * @virtual
1154
1190
  */
1155
1191
  vfunc_scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
@@ -1479,6 +1515,7 @@ export namespace Cally {
1479
1515
  * `component`, on a scale from 0 (fully transparent) to 1.0
1480
1516
  * (fully opaque).
1481
1517
  * @returns An alpha value from 0 to 1.0, inclusive.
1518
+ * @since 1.12
1482
1519
  */
1483
1520
  get_alpha(): number;
1484
1521
 
@@ -1511,6 +1548,7 @@ export namespace Cally {
1511
1548
  * If the position can not be obtained (e.g. a non-embedded plug or missing
1512
1549
  * support), x and y are set to -1.
1513
1550
  * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
1551
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
1514
1552
  */
1515
1553
  get_position(coord_type: Atk.CoordType): [number, number];
1516
1554
 
@@ -1519,6 +1557,7 @@ export namespace Cally {
1519
1557
  *
1520
1558
  * If the size can not be obtained (e.g. a non-embedded plug or missing
1521
1559
  * support), width and height are set to -1.
1560
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
1522
1561
  */
1523
1562
  get_size(): [number, number];
1524
1563
 
@@ -1543,6 +1582,7 @@ export namespace Cally {
1543
1582
  * functions to be executed when this object receives focus events
1544
1583
  * (in or out).
1545
1584
  * @param handler_id the handler id of the focus handler to be removed from `component`
1585
+ * @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.
1546
1586
  */
1547
1587
  remove_focus_handler(handler_id: number): void;
1548
1588
 
@@ -1554,6 +1594,7 @@ export namespace Cally {
1554
1594
  * object shows up on the screen, given its current position within the parents.
1555
1595
  * @param type specify where the object should be made visible.
1556
1596
  * @returns whether scrolling was successful.
1597
+ * @since 2.30
1557
1598
  */
1558
1599
  scroll_to(type: Atk.ScrollType): boolean;
1559
1600
 
@@ -1564,6 +1605,7 @@ export namespace Cally {
1564
1605
  * @param x x-position where to scroll to
1565
1606
  * @param y y-position where to scroll to
1566
1607
  * @returns whether scrolling was successful.
1608
+ * @since 2.30
1567
1609
  */
1568
1610
  scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
1569
1611
 
@@ -1621,6 +1663,7 @@ export namespace Cally {
1621
1663
  * Returns the alpha value (i.e. the opacity) for this
1622
1664
  * `component`, on a scale from 0 (fully transparent) to 1.0
1623
1665
  * (fully opaque).
1666
+ * @since 1.12
1624
1667
  * @virtual
1625
1668
  */
1626
1669
  vfunc_get_alpha(): number;
@@ -1655,6 +1698,7 @@ export namespace Cally {
1655
1698
  * If the position can not be obtained (e.g. a non-embedded plug or missing
1656
1699
  * support), x and y are set to -1.
1657
1700
  * @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
1701
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
1658
1702
  * @virtual
1659
1703
  */
1660
1704
  vfunc_get_position(coord_type: Atk.CoordType): [number, number];
@@ -1664,6 +1708,7 @@ export namespace Cally {
1664
1708
  *
1665
1709
  * If the size can not be obtained (e.g. a non-embedded plug or missing
1666
1710
  * support), width and height are set to -1.
1711
+ * @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
1667
1712
  * @virtual
1668
1713
  */
1669
1714
  vfunc_get_size(): [number, number];
@@ -1689,6 +1734,7 @@ export namespace Cally {
1689
1734
  * functions to be executed when this object receives focus events
1690
1735
  * (in or out).
1691
1736
  * @param handler_id the handler id of the focus handler to be removed from `component`
1737
+ * @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.
1692
1738
  * @virtual
1693
1739
  */
1694
1740
  vfunc_remove_focus_handler(handler_id: number): void;
@@ -1700,6 +1746,7 @@ export namespace Cally {
1700
1746
  * `component` in its parent, this only makes the parents scroll so that the
1701
1747
  * object shows up on the screen, given its current position within the parents.
1702
1748
  * @param type specify where the object should be made visible.
1749
+ * @since 2.30
1703
1750
  * @virtual
1704
1751
  */
1705
1752
  vfunc_scroll_to(type: Atk.ScrollType): boolean;
@@ -1710,6 +1757,7 @@ export namespace Cally {
1710
1757
  * @param coords specify whether coordinates are relative to the screen or to the parent object.
1711
1758
  * @param x x-position where to scroll to
1712
1759
  * @param y y-position where to scroll to
1760
+ * @since 2.30
1713
1761
  * @virtual
1714
1762
  */
1715
1763
  vfunc_scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
@@ -1876,6 +1924,7 @@ export namespace Cally {
1876
1924
  * @param x_clip_type Specify the horizontal clip type.
1877
1925
  * @param y_clip_type Specify the vertical clip type.
1878
1926
  * @returns Array of AtkTextRange. The last element of the array returned by this function will be NULL.
1927
+ * @since 1.3
1879
1928
  */
1880
1929
  get_bounded_ranges(rect: Atk.TextRectangle, coord_type: Atk.CoordType, x_clip_type: Atk.TextClipType, y_clip_type: Atk.TextClipType): Atk.TextRange[];
1881
1930
 
@@ -1943,6 +1992,7 @@ export namespace Cally {
1943
1992
  * @param start_offset The offset of the first text character for which boundary information is required.
1944
1993
  * @param end_offset The offset of the text character after the last character for which boundary information is required.
1945
1994
  * @param coord_type Specify whether coordinates are relative to the screen or widget window.
1995
+ * @since 1.3
1946
1996
  */
1947
1997
  get_range_extents(start_offset: number, end_offset: number, coord_type: Atk.CoordType): Atk.TextRectangle;
1948
1998
 
@@ -2000,6 +2050,7 @@ export namespace Cally {
2000
2050
  * @param offset position
2001
2051
  * @param granularity An {@link Atk.TextGranularity}
2002
2052
  * @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.
2053
+ * @since 2.10
2003
2054
  */
2004
2055
  get_string_at_offset(offset: number, granularity: Atk.TextGranularity): [string | null, number, number];
2005
2056
 
@@ -2016,6 +2067,7 @@ export namespace Cally {
2016
2067
  * @param offset position
2017
2068
  * @param boundary_type An {@link Atk.TextBoundary}
2018
2069
  * @returns a newly allocated string containing the text after `offset` bounded by the specified `boundary_type`. Use `g_free()` to free the returned string.
2070
+ * @deprecated since 2.9.3: Please use `atk_text_get_string_at_offset()` instead.
2019
2071
  */
2020
2072
  get_text_after_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
2021
2073
 
@@ -2047,6 +2099,7 @@ export namespace Cally {
2047
2099
  * @param offset position
2048
2100
  * @param boundary_type An {@link Atk.TextBoundary}
2049
2101
  * @returns a newly allocated string containing the text at `offset` bounded by the specified `boundary_type`. Use `g_free()` to free the returned string.
2102
+ * @deprecated This method is deprecated since ATK version 2.9.4. Please use `atk_text_get_string_at_offset()` instead.
2050
2103
  */
2051
2104
  get_text_at_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
2052
2105
 
@@ -2055,6 +2108,7 @@ export namespace Cally {
2055
2108
  * @param offset position
2056
2109
  * @param boundary_type An {@link Atk.TextBoundary}
2057
2110
  * @returns a newly allocated string containing the text before `offset` bounded by the specified `boundary_type`. Use `g_free()` to free the returned string.
2111
+ * @deprecated since 2.9.3: Please use `atk_text_get_string_at_offset()` instead.
2058
2112
  */
2059
2113
  get_text_before_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
2060
2114
 
@@ -2071,6 +2125,7 @@ export namespace Cally {
2071
2125
  * @param end_offset end offset in the `text`, or -1 for the end of the text.
2072
2126
  * @param type specify where the object should be made visible.
2073
2127
  * @returns whether scrolling was successful.
2128
+ * @since 2.32
2074
2129
  */
2075
2130
  scroll_substring_to(start_offset: number, end_offset: number, type: Atk.ScrollType): boolean;
2076
2131
 
@@ -2083,6 +2138,7 @@ export namespace Cally {
2083
2138
  * @param x x-position where to scroll to
2084
2139
  * @param y y-position where to scroll to
2085
2140
  * @returns whether scrolling was successful.
2141
+ * @since 2.32
2086
2142
  */
2087
2143
  scroll_substring_to_point(start_offset: number, end_offset: number, coords: Atk.CoordType, x: number, y: number): boolean;
2088
2144
 
@@ -2132,6 +2188,7 @@ export namespace Cally {
2132
2188
  * @param coord_type Specify whether coordinates are relative to the screen or widget window.
2133
2189
  * @param x_clip_type Specify the horizontal clip type.
2134
2190
  * @param y_clip_type Specify the vertical clip type.
2191
+ * @since 1.3
2135
2192
  * @virtual
2136
2193
  */
2137
2194
  vfunc_get_bounded_ranges(rect: Atk.TextRectangle, coord_type: Atk.CoordType, x_clip_type: Atk.TextClipType, y_clip_type: Atk.TextClipType): Atk.TextRange[];
@@ -2201,6 +2258,7 @@ export namespace Cally {
2201
2258
  * @param start_offset The offset of the first text character for which boundary information is required.
2202
2259
  * @param end_offset The offset of the text character after the last character for which boundary information is required.
2203
2260
  * @param coord_type Specify whether coordinates are relative to the screen or widget window.
2261
+ * @since 1.3
2204
2262
  * @virtual
2205
2263
  */
2206
2264
  vfunc_get_range_extents(start_offset: number, end_offset: number, coord_type: Atk.CoordType): Atk.TextRectangle;
@@ -2258,6 +2316,7 @@ export namespace Cally {
2258
2316
  * of the following paragraph after the offset.
2259
2317
  * @param offset position
2260
2318
  * @param granularity An {@link Atk.TextGranularity}
2319
+ * @since 2.10
2261
2320
  * @virtual
2262
2321
  */
2263
2322
  vfunc_get_string_at_offset(offset: number, granularity: Atk.TextGranularity): [string | null, number, number];
@@ -2274,6 +2333,7 @@ export namespace Cally {
2274
2333
  * Gets the specified text.
2275
2334
  * @param offset position
2276
2335
  * @param boundary_type An {@link Atk.TextBoundary}
2336
+ * @deprecated since 2.9.3: Please use `atk_text_get_string_at_offset()` instead.
2277
2337
  * @virtual
2278
2338
  */
2279
2339
  vfunc_get_text_after_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
@@ -2305,6 +2365,7 @@ export namespace Cally {
2305
2365
  * start after the offset.
2306
2366
  * @param offset position
2307
2367
  * @param boundary_type An {@link Atk.TextBoundary}
2368
+ * @deprecated This method is deprecated since ATK version 2.9.4. Please use `atk_text_get_string_at_offset()` instead.
2308
2369
  * @virtual
2309
2370
  */
2310
2371
  vfunc_get_text_at_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
@@ -2313,6 +2374,7 @@ export namespace Cally {
2313
2374
  * Gets the specified text.
2314
2375
  * @param offset position
2315
2376
  * @param boundary_type An {@link Atk.TextBoundary}
2377
+ * @deprecated since 2.9.3: Please use `atk_text_get_string_at_offset()` instead.
2316
2378
  * @virtual
2317
2379
  */
2318
2380
  vfunc_get_text_before_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
@@ -2329,6 +2391,7 @@ export namespace Cally {
2329
2391
  * @param start_offset start offset in the `text`
2330
2392
  * @param end_offset end offset in the `text`, or -1 for the end of the text.
2331
2393
  * @param type specify where the object should be made visible.
2394
+ * @since 2.32
2332
2395
  * @virtual
2333
2396
  */
2334
2397
  vfunc_scroll_substring_to(start_offset: number, end_offset: number, type: Atk.ScrollType): boolean;
@@ -2341,6 +2404,7 @@ export namespace Cally {
2341
2404
  * @param coords specify whether coordinates are relative to the screen or to the parent object.
2342
2405
  * @param x x-position where to scroll to
2343
2406
  * @param y y-position where to scroll to
2407
+ * @since 2.32
2344
2408
  * @virtual
2345
2409
  */
2346
2410
  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-15",
3
- "version": "4.2.0",
3
+ "version": "4.4.0",
4
4
  "description": "GJS TypeScript type definitions for Cally-15",
5
5
  "type": "module",
6
6
  "module": "cally-15.js",
@@ -31,24 +31,24 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gjs": "^4.2.0",
35
- "@girs/mtk-15": "^4.2.0",
36
- "@girs/graphene-1.0": "^4.2.0",
37
- "@girs/gobject-2.0": "^4.2.0",
38
- "@girs/glib-2.0": "^4.2.0",
39
- "@girs/coglpango-15": "^4.2.0",
40
- "@girs/pangocairo-1.0": "^4.2.0",
41
- "@girs/cairo-1.0": "^4.2.0",
42
- "@girs/pango-1.0": "^4.2.0",
43
- "@girs/harfbuzz-0.0": "^4.2.0",
44
- "@girs/freetype2-2.0": "^4.2.0",
45
- "@girs/gio-2.0": "^4.2.0",
46
- "@girs/gmodule-2.0": "^4.2.0",
47
- "@girs/cogl-15": "^4.2.0",
48
- "@girs/xlib-2.0": "^4.2.0",
49
- "@girs/gl-1.0": "^4.2.0",
50
- "@girs/clutter-15": "^4.2.0",
51
- "@girs/atk-1.0": "^4.2.0" },
34
+ "@girs/gjs": "^4.4.0",
35
+ "@girs/mtk-15": "^4.4.0",
36
+ "@girs/graphene-1.0": "^4.4.0",
37
+ "@girs/gobject-2.0": "^4.4.0",
38
+ "@girs/glib-2.0": "^4.4.0",
39
+ "@girs/coglpango-15": "^4.4.0",
40
+ "@girs/pangocairo-1.0": "^4.4.0",
41
+ "@girs/cairo-1.0": "^4.4.0",
42
+ "@girs/pango-1.0": "^4.4.0",
43
+ "@girs/harfbuzz-0.0": "^4.4.0",
44
+ "@girs/freetype2-2.0": "^4.4.0",
45
+ "@girs/gio-2.0": "^4.4.0",
46
+ "@girs/gmodule-2.0": "^4.4.0",
47
+ "@girs/cogl-15": "^4.4.0",
48
+ "@girs/xlib-2.0": "^4.4.0",
49
+ "@girs/gl-1.0": "^4.4.0",
50
+ "@girs/clutter-15": "^4.4.0",
51
+ "@girs/atk-1.0": "^4.4.0" },
52
52
  "devDependencies": {
53
53
  "typescript": "*"
54
54
  },