@girs/cally-7 4.3.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.
- package/README.md +1 -1
- package/cally-7.d.ts +67 -0
- package/package.json +18 -18
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|

|
|
6
6
|
|
|
7
7
|
|
|
8
|
-
GJS TypeScript type definitions for Cally-7 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.
|
|
8
|
+
GJS TypeScript type definitions for Cally-7 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.0.
|
|
9
9
|
|
|
10
10
|
## Install
|
|
11
11
|
|
package/cally-7.d.ts
CHANGED
|
@@ -135,6 +135,7 @@ export namespace Cally {
|
|
|
135
135
|
* @param action_keybinding the action keybinding
|
|
136
136
|
* @param callback the callback of the action
|
|
137
137
|
* @returns added action id, or -1 if failure
|
|
138
|
+
* @since 1.6
|
|
138
139
|
*/
|
|
139
140
|
add_action(action_name: string, action_description: string, action_keybinding: string, callback: ActionCallback): number;
|
|
140
141
|
|
|
@@ -142,6 +143,7 @@ export namespace Cally {
|
|
|
142
143
|
* Removes a action, using the `action_id` returned by `cally_actor_add_action()`
|
|
143
144
|
* @param action_id the action id
|
|
144
145
|
* @returns `true` if the operation was successful, `false` otherwise
|
|
146
|
+
* @since 1.4
|
|
145
147
|
*/
|
|
146
148
|
remove_action(action_id: number): boolean;
|
|
147
149
|
|
|
@@ -150,6 +152,7 @@ export namespace Cally {
|
|
|
150
152
|
* with `cally_actor_add_action()`
|
|
151
153
|
* @param action_name the name of the action to remove
|
|
152
154
|
* @returns `true` if the operation was successful, `false` otherwise
|
|
155
|
+
* @since 1.4
|
|
153
156
|
*/
|
|
154
157
|
remove_action_by_name(action_name: string): boolean;
|
|
155
158
|
|
|
@@ -380,6 +383,7 @@ export namespace Cally {
|
|
|
380
383
|
* `component`, on a scale from 0 (fully transparent) to 1.0
|
|
381
384
|
* (fully opaque).
|
|
382
385
|
* @returns An alpha value from 0 to 1.0, inclusive.
|
|
386
|
+
* @since 1.12
|
|
383
387
|
*/
|
|
384
388
|
get_alpha(): number;
|
|
385
389
|
|
|
@@ -412,6 +416,7 @@ export namespace Cally {
|
|
|
412
416
|
* If the position can not be obtained (e.g. a non-embedded plug or missing
|
|
413
417
|
* support), x and y are set to -1.
|
|
414
418
|
* @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
|
|
419
|
+
* @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
|
|
415
420
|
*/
|
|
416
421
|
get_position(coord_type: Atk.CoordType): [number, number];
|
|
417
422
|
|
|
@@ -420,6 +425,7 @@ export namespace Cally {
|
|
|
420
425
|
*
|
|
421
426
|
* If the size can not be obtained (e.g. a non-embedded plug or missing
|
|
422
427
|
* support), width and height are set to -1.
|
|
428
|
+
* @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
|
|
423
429
|
*/
|
|
424
430
|
get_size(): [number, number];
|
|
425
431
|
|
|
@@ -444,6 +450,7 @@ export namespace Cally {
|
|
|
444
450
|
* functions to be executed when this object receives focus events
|
|
445
451
|
* (in or out).
|
|
446
452
|
* @param handler_id the handler id of the focus handler to be removed from `component`
|
|
453
|
+
* @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.
|
|
447
454
|
*/
|
|
448
455
|
remove_focus_handler(handler_id: number): void;
|
|
449
456
|
|
|
@@ -455,6 +462,7 @@ export namespace Cally {
|
|
|
455
462
|
* object shows up on the screen, given its current position within the parents.
|
|
456
463
|
* @param type specify where the object should be made visible.
|
|
457
464
|
* @returns whether scrolling was successful.
|
|
465
|
+
* @since 2.30
|
|
458
466
|
*/
|
|
459
467
|
scroll_to(type: Atk.ScrollType): boolean;
|
|
460
468
|
|
|
@@ -465,6 +473,7 @@ export namespace Cally {
|
|
|
465
473
|
* @param x x-position where to scroll to
|
|
466
474
|
* @param y y-position where to scroll to
|
|
467
475
|
* @returns whether scrolling was successful.
|
|
476
|
+
* @since 2.30
|
|
468
477
|
*/
|
|
469
478
|
scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
|
|
470
479
|
|
|
@@ -522,6 +531,7 @@ export namespace Cally {
|
|
|
522
531
|
* Returns the alpha value (i.e. the opacity) for this
|
|
523
532
|
* `component`, on a scale from 0 (fully transparent) to 1.0
|
|
524
533
|
* (fully opaque).
|
|
534
|
+
* @since 1.12
|
|
525
535
|
* @virtual
|
|
526
536
|
*/
|
|
527
537
|
vfunc_get_alpha(): number;
|
|
@@ -556,6 +566,7 @@ export namespace Cally {
|
|
|
556
566
|
* If the position can not be obtained (e.g. a non-embedded plug or missing
|
|
557
567
|
* support), x and y are set to -1.
|
|
558
568
|
* @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
|
|
569
|
+
* @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
|
|
559
570
|
* @virtual
|
|
560
571
|
*/
|
|
561
572
|
vfunc_get_position(coord_type: Atk.CoordType): [number, number];
|
|
@@ -565,6 +576,7 @@ export namespace Cally {
|
|
|
565
576
|
*
|
|
566
577
|
* If the size can not be obtained (e.g. a non-embedded plug or missing
|
|
567
578
|
* support), width and height are set to -1.
|
|
579
|
+
* @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
|
|
568
580
|
* @virtual
|
|
569
581
|
*/
|
|
570
582
|
vfunc_get_size(): [number, number];
|
|
@@ -590,6 +602,7 @@ export namespace Cally {
|
|
|
590
602
|
* functions to be executed when this object receives focus events
|
|
591
603
|
* (in or out).
|
|
592
604
|
* @param handler_id the handler id of the focus handler to be removed from `component`
|
|
605
|
+
* @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.
|
|
593
606
|
* @virtual
|
|
594
607
|
*/
|
|
595
608
|
vfunc_remove_focus_handler(handler_id: number): void;
|
|
@@ -601,6 +614,7 @@ export namespace Cally {
|
|
|
601
614
|
* `component` in its parent, this only makes the parents scroll so that the
|
|
602
615
|
* object shows up on the screen, given its current position within the parents.
|
|
603
616
|
* @param type specify where the object should be made visible.
|
|
617
|
+
* @since 2.30
|
|
604
618
|
* @virtual
|
|
605
619
|
*/
|
|
606
620
|
vfunc_scroll_to(type: Atk.ScrollType): boolean;
|
|
@@ -611,6 +625,7 @@ export namespace Cally {
|
|
|
611
625
|
* @param coords specify whether coordinates are relative to the screen or to the parent object.
|
|
612
626
|
* @param x x-position where to scroll to
|
|
613
627
|
* @param y y-position where to scroll to
|
|
628
|
+
* @since 2.30
|
|
614
629
|
* @virtual
|
|
615
630
|
*/
|
|
616
631
|
vfunc_scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
|
|
@@ -939,6 +954,7 @@ export namespace Cally {
|
|
|
939
954
|
* `component`, on a scale from 0 (fully transparent) to 1.0
|
|
940
955
|
* (fully opaque).
|
|
941
956
|
* @returns An alpha value from 0 to 1.0, inclusive.
|
|
957
|
+
* @since 1.12
|
|
942
958
|
*/
|
|
943
959
|
get_alpha(): number;
|
|
944
960
|
|
|
@@ -971,6 +987,7 @@ export namespace Cally {
|
|
|
971
987
|
* If the position can not be obtained (e.g. a non-embedded plug or missing
|
|
972
988
|
* support), x and y are set to -1.
|
|
973
989
|
* @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
|
|
990
|
+
* @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
|
|
974
991
|
*/
|
|
975
992
|
get_position(coord_type: Atk.CoordType): [number, number];
|
|
976
993
|
|
|
@@ -979,6 +996,7 @@ export namespace Cally {
|
|
|
979
996
|
*
|
|
980
997
|
* If the size can not be obtained (e.g. a non-embedded plug or missing
|
|
981
998
|
* support), width and height are set to -1.
|
|
999
|
+
* @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
|
|
982
1000
|
*/
|
|
983
1001
|
get_size(): [number, number];
|
|
984
1002
|
|
|
@@ -1003,6 +1021,7 @@ export namespace Cally {
|
|
|
1003
1021
|
* functions to be executed when this object receives focus events
|
|
1004
1022
|
* (in or out).
|
|
1005
1023
|
* @param handler_id the handler id of the focus handler to be removed from `component`
|
|
1024
|
+
* @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.
|
|
1006
1025
|
*/
|
|
1007
1026
|
remove_focus_handler(handler_id: number): void;
|
|
1008
1027
|
|
|
@@ -1014,6 +1033,7 @@ export namespace Cally {
|
|
|
1014
1033
|
* object shows up on the screen, given its current position within the parents.
|
|
1015
1034
|
* @param type specify where the object should be made visible.
|
|
1016
1035
|
* @returns whether scrolling was successful.
|
|
1036
|
+
* @since 2.30
|
|
1017
1037
|
*/
|
|
1018
1038
|
scroll_to(type: Atk.ScrollType): boolean;
|
|
1019
1039
|
|
|
@@ -1024,6 +1044,7 @@ export namespace Cally {
|
|
|
1024
1044
|
* @param x x-position where to scroll to
|
|
1025
1045
|
* @param y y-position where to scroll to
|
|
1026
1046
|
* @returns whether scrolling was successful.
|
|
1047
|
+
* @since 2.30
|
|
1027
1048
|
*/
|
|
1028
1049
|
scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
|
|
1029
1050
|
|
|
@@ -1081,6 +1102,7 @@ export namespace Cally {
|
|
|
1081
1102
|
* Returns the alpha value (i.e. the opacity) for this
|
|
1082
1103
|
* `component`, on a scale from 0 (fully transparent) to 1.0
|
|
1083
1104
|
* (fully opaque).
|
|
1105
|
+
* @since 1.12
|
|
1084
1106
|
* @virtual
|
|
1085
1107
|
*/
|
|
1086
1108
|
vfunc_get_alpha(): number;
|
|
@@ -1115,6 +1137,7 @@ export namespace Cally {
|
|
|
1115
1137
|
* If the position can not be obtained (e.g. a non-embedded plug or missing
|
|
1116
1138
|
* support), x and y are set to -1.
|
|
1117
1139
|
* @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
|
|
1140
|
+
* @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
|
|
1118
1141
|
* @virtual
|
|
1119
1142
|
*/
|
|
1120
1143
|
vfunc_get_position(coord_type: Atk.CoordType): [number, number];
|
|
@@ -1124,6 +1147,7 @@ export namespace Cally {
|
|
|
1124
1147
|
*
|
|
1125
1148
|
* If the size can not be obtained (e.g. a non-embedded plug or missing
|
|
1126
1149
|
* support), width and height are set to -1.
|
|
1150
|
+
* @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
|
|
1127
1151
|
* @virtual
|
|
1128
1152
|
*/
|
|
1129
1153
|
vfunc_get_size(): [number, number];
|
|
@@ -1149,6 +1173,7 @@ export namespace Cally {
|
|
|
1149
1173
|
* functions to be executed when this object receives focus events
|
|
1150
1174
|
* (in or out).
|
|
1151
1175
|
* @param handler_id the handler id of the focus handler to be removed from `component`
|
|
1176
|
+
* @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.
|
|
1152
1177
|
* @virtual
|
|
1153
1178
|
*/
|
|
1154
1179
|
vfunc_remove_focus_handler(handler_id: number): void;
|
|
@@ -1160,6 +1185,7 @@ export namespace Cally {
|
|
|
1160
1185
|
* `component` in its parent, this only makes the parents scroll so that the
|
|
1161
1186
|
* object shows up on the screen, given its current position within the parents.
|
|
1162
1187
|
* @param type specify where the object should be made visible.
|
|
1188
|
+
* @since 2.30
|
|
1163
1189
|
* @virtual
|
|
1164
1190
|
*/
|
|
1165
1191
|
vfunc_scroll_to(type: Atk.ScrollType): boolean;
|
|
@@ -1170,6 +1196,7 @@ export namespace Cally {
|
|
|
1170
1196
|
* @param coords specify whether coordinates are relative to the screen or to the parent object.
|
|
1171
1197
|
* @param x x-position where to scroll to
|
|
1172
1198
|
* @param y y-position where to scroll to
|
|
1199
|
+
* @since 2.30
|
|
1173
1200
|
* @virtual
|
|
1174
1201
|
*/
|
|
1175
1202
|
vfunc_scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
|
|
@@ -1564,6 +1591,7 @@ export namespace Cally {
|
|
|
1564
1591
|
* `component`, on a scale from 0 (fully transparent) to 1.0
|
|
1565
1592
|
* (fully opaque).
|
|
1566
1593
|
* @returns An alpha value from 0 to 1.0, inclusive.
|
|
1594
|
+
* @since 1.12
|
|
1567
1595
|
*/
|
|
1568
1596
|
get_alpha(): number;
|
|
1569
1597
|
|
|
@@ -1596,6 +1624,7 @@ export namespace Cally {
|
|
|
1596
1624
|
* If the position can not be obtained (e.g. a non-embedded plug or missing
|
|
1597
1625
|
* support), x and y are set to -1.
|
|
1598
1626
|
* @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
|
|
1627
|
+
* @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
|
|
1599
1628
|
*/
|
|
1600
1629
|
get_position(coord_type: Atk.CoordType): [number, number];
|
|
1601
1630
|
|
|
@@ -1604,6 +1633,7 @@ export namespace Cally {
|
|
|
1604
1633
|
*
|
|
1605
1634
|
* If the size can not be obtained (e.g. a non-embedded plug or missing
|
|
1606
1635
|
* support), width and height are set to -1.
|
|
1636
|
+
* @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
|
|
1607
1637
|
*/
|
|
1608
1638
|
get_size(): [number, number];
|
|
1609
1639
|
|
|
@@ -1628,6 +1658,7 @@ export namespace Cally {
|
|
|
1628
1658
|
* functions to be executed when this object receives focus events
|
|
1629
1659
|
* (in or out).
|
|
1630
1660
|
* @param handler_id the handler id of the focus handler to be removed from `component`
|
|
1661
|
+
* @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.
|
|
1631
1662
|
*/
|
|
1632
1663
|
remove_focus_handler(handler_id: number): void;
|
|
1633
1664
|
|
|
@@ -1639,6 +1670,7 @@ export namespace Cally {
|
|
|
1639
1670
|
* object shows up on the screen, given its current position within the parents.
|
|
1640
1671
|
* @param type specify where the object should be made visible.
|
|
1641
1672
|
* @returns whether scrolling was successful.
|
|
1673
|
+
* @since 2.30
|
|
1642
1674
|
*/
|
|
1643
1675
|
scroll_to(type: Atk.ScrollType): boolean;
|
|
1644
1676
|
|
|
@@ -1649,6 +1681,7 @@ export namespace Cally {
|
|
|
1649
1681
|
* @param x x-position where to scroll to
|
|
1650
1682
|
* @param y y-position where to scroll to
|
|
1651
1683
|
* @returns whether scrolling was successful.
|
|
1684
|
+
* @since 2.30
|
|
1652
1685
|
*/
|
|
1653
1686
|
scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
|
|
1654
1687
|
|
|
@@ -1706,6 +1739,7 @@ export namespace Cally {
|
|
|
1706
1739
|
* Returns the alpha value (i.e. the opacity) for this
|
|
1707
1740
|
* `component`, on a scale from 0 (fully transparent) to 1.0
|
|
1708
1741
|
* (fully opaque).
|
|
1742
|
+
* @since 1.12
|
|
1709
1743
|
* @virtual
|
|
1710
1744
|
*/
|
|
1711
1745
|
vfunc_get_alpha(): number;
|
|
@@ -1740,6 +1774,7 @@ export namespace Cally {
|
|
|
1740
1774
|
* If the position can not be obtained (e.g. a non-embedded plug or missing
|
|
1741
1775
|
* support), x and y are set to -1.
|
|
1742
1776
|
* @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
|
|
1777
|
+
* @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
|
|
1743
1778
|
* @virtual
|
|
1744
1779
|
*/
|
|
1745
1780
|
vfunc_get_position(coord_type: Atk.CoordType): [number, number];
|
|
@@ -1749,6 +1784,7 @@ export namespace Cally {
|
|
|
1749
1784
|
*
|
|
1750
1785
|
* If the size can not be obtained (e.g. a non-embedded plug or missing
|
|
1751
1786
|
* support), width and height are set to -1.
|
|
1787
|
+
* @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
|
|
1752
1788
|
* @virtual
|
|
1753
1789
|
*/
|
|
1754
1790
|
vfunc_get_size(): [number, number];
|
|
@@ -1774,6 +1810,7 @@ export namespace Cally {
|
|
|
1774
1810
|
* functions to be executed when this object receives focus events
|
|
1775
1811
|
* (in or out).
|
|
1776
1812
|
* @param handler_id the handler id of the focus handler to be removed from `component`
|
|
1813
|
+
* @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.
|
|
1777
1814
|
* @virtual
|
|
1778
1815
|
*/
|
|
1779
1816
|
vfunc_remove_focus_handler(handler_id: number): void;
|
|
@@ -1785,6 +1822,7 @@ export namespace Cally {
|
|
|
1785
1822
|
* `component` in its parent, this only makes the parents scroll so that the
|
|
1786
1823
|
* object shows up on the screen, given its current position within the parents.
|
|
1787
1824
|
* @param type specify where the object should be made visible.
|
|
1825
|
+
* @since 2.30
|
|
1788
1826
|
* @virtual
|
|
1789
1827
|
*/
|
|
1790
1828
|
vfunc_scroll_to(type: Atk.ScrollType): boolean;
|
|
@@ -1795,6 +1833,7 @@ export namespace Cally {
|
|
|
1795
1833
|
* @param coords specify whether coordinates are relative to the screen or to the parent object.
|
|
1796
1834
|
* @param x x-position where to scroll to
|
|
1797
1835
|
* @param y y-position where to scroll to
|
|
1836
|
+
* @since 2.30
|
|
1798
1837
|
* @virtual
|
|
1799
1838
|
*/
|
|
1800
1839
|
vfunc_scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
|
|
@@ -2123,6 +2162,7 @@ export namespace Cally {
|
|
|
2123
2162
|
* `component`, on a scale from 0 (fully transparent) to 1.0
|
|
2124
2163
|
* (fully opaque).
|
|
2125
2164
|
* @returns An alpha value from 0 to 1.0, inclusive.
|
|
2165
|
+
* @since 1.12
|
|
2126
2166
|
*/
|
|
2127
2167
|
get_alpha(): number;
|
|
2128
2168
|
|
|
@@ -2155,6 +2195,7 @@ export namespace Cally {
|
|
|
2155
2195
|
* If the position can not be obtained (e.g. a non-embedded plug or missing
|
|
2156
2196
|
* support), x and y are set to -1.
|
|
2157
2197
|
* @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
|
|
2198
|
+
* @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
|
|
2158
2199
|
*/
|
|
2159
2200
|
get_position(coord_type: Atk.CoordType): [number, number];
|
|
2160
2201
|
|
|
@@ -2163,6 +2204,7 @@ export namespace Cally {
|
|
|
2163
2204
|
*
|
|
2164
2205
|
* If the size can not be obtained (e.g. a non-embedded plug or missing
|
|
2165
2206
|
* support), width and height are set to -1.
|
|
2207
|
+
* @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
|
|
2166
2208
|
*/
|
|
2167
2209
|
get_size(): [number, number];
|
|
2168
2210
|
|
|
@@ -2187,6 +2229,7 @@ export namespace Cally {
|
|
|
2187
2229
|
* functions to be executed when this object receives focus events
|
|
2188
2230
|
* (in or out).
|
|
2189
2231
|
* @param handler_id the handler id of the focus handler to be removed from `component`
|
|
2232
|
+
* @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.
|
|
2190
2233
|
*/
|
|
2191
2234
|
remove_focus_handler(handler_id: number): void;
|
|
2192
2235
|
|
|
@@ -2198,6 +2241,7 @@ export namespace Cally {
|
|
|
2198
2241
|
* object shows up on the screen, given its current position within the parents.
|
|
2199
2242
|
* @param type specify where the object should be made visible.
|
|
2200
2243
|
* @returns whether scrolling was successful.
|
|
2244
|
+
* @since 2.30
|
|
2201
2245
|
*/
|
|
2202
2246
|
scroll_to(type: Atk.ScrollType): boolean;
|
|
2203
2247
|
|
|
@@ -2208,6 +2252,7 @@ export namespace Cally {
|
|
|
2208
2252
|
* @param x x-position where to scroll to
|
|
2209
2253
|
* @param y y-position where to scroll to
|
|
2210
2254
|
* @returns whether scrolling was successful.
|
|
2255
|
+
* @since 2.30
|
|
2211
2256
|
*/
|
|
2212
2257
|
scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
|
|
2213
2258
|
|
|
@@ -2265,6 +2310,7 @@ export namespace Cally {
|
|
|
2265
2310
|
* Returns the alpha value (i.e. the opacity) for this
|
|
2266
2311
|
* `component`, on a scale from 0 (fully transparent) to 1.0
|
|
2267
2312
|
* (fully opaque).
|
|
2313
|
+
* @since 1.12
|
|
2268
2314
|
* @virtual
|
|
2269
2315
|
*/
|
|
2270
2316
|
vfunc_get_alpha(): number;
|
|
@@ -2299,6 +2345,7 @@ export namespace Cally {
|
|
|
2299
2345
|
* If the position can not be obtained (e.g. a non-embedded plug or missing
|
|
2300
2346
|
* support), x and y are set to -1.
|
|
2301
2347
|
* @param coord_type specifies whether the coordinates are relative to the screen or to the components top level window
|
|
2348
|
+
* @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
|
|
2302
2349
|
* @virtual
|
|
2303
2350
|
*/
|
|
2304
2351
|
vfunc_get_position(coord_type: Atk.CoordType): [number, number];
|
|
@@ -2308,6 +2355,7 @@ export namespace Cally {
|
|
|
2308
2355
|
*
|
|
2309
2356
|
* If the size can not be obtained (e.g. a non-embedded plug or missing
|
|
2310
2357
|
* support), width and height are set to -1.
|
|
2358
|
+
* @deprecated Since 2.12. Use `atk_component_get_extents()` instead.
|
|
2311
2359
|
* @virtual
|
|
2312
2360
|
*/
|
|
2313
2361
|
vfunc_get_size(): [number, number];
|
|
@@ -2333,6 +2381,7 @@ export namespace Cally {
|
|
|
2333
2381
|
* functions to be executed when this object receives focus events
|
|
2334
2382
|
* (in or out).
|
|
2335
2383
|
* @param handler_id the handler id of the focus handler to be removed from `component`
|
|
2384
|
+
* @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.
|
|
2336
2385
|
* @virtual
|
|
2337
2386
|
*/
|
|
2338
2387
|
vfunc_remove_focus_handler(handler_id: number): void;
|
|
@@ -2344,6 +2393,7 @@ export namespace Cally {
|
|
|
2344
2393
|
* `component` in its parent, this only makes the parents scroll so that the
|
|
2345
2394
|
* object shows up on the screen, given its current position within the parents.
|
|
2346
2395
|
* @param type specify where the object should be made visible.
|
|
2396
|
+
* @since 2.30
|
|
2347
2397
|
* @virtual
|
|
2348
2398
|
*/
|
|
2349
2399
|
vfunc_scroll_to(type: Atk.ScrollType): boolean;
|
|
@@ -2354,6 +2404,7 @@ export namespace Cally {
|
|
|
2354
2404
|
* @param coords specify whether coordinates are relative to the screen or to the parent object.
|
|
2355
2405
|
* @param x x-position where to scroll to
|
|
2356
2406
|
* @param y y-position where to scroll to
|
|
2407
|
+
* @since 2.30
|
|
2357
2408
|
* @virtual
|
|
2358
2409
|
*/
|
|
2359
2410
|
vfunc_scroll_to_point(coords: Atk.CoordType, x: number, y: number): boolean;
|
|
@@ -2520,6 +2571,7 @@ export namespace Cally {
|
|
|
2520
2571
|
* @param x_clip_type Specify the horizontal clip type.
|
|
2521
2572
|
* @param y_clip_type Specify the vertical clip type.
|
|
2522
2573
|
* @returns Array of AtkTextRange. The last element of the array returned by this function will be NULL.
|
|
2574
|
+
* @since 1.3
|
|
2523
2575
|
*/
|
|
2524
2576
|
get_bounded_ranges(rect: Atk.TextRectangle, coord_type: Atk.CoordType, x_clip_type: Atk.TextClipType, y_clip_type: Atk.TextClipType): Atk.TextRange[];
|
|
2525
2577
|
|
|
@@ -2587,6 +2639,7 @@ export namespace Cally {
|
|
|
2587
2639
|
* @param start_offset The offset of the first text character for which boundary information is required.
|
|
2588
2640
|
* @param end_offset The offset of the text character after the last character for which boundary information is required.
|
|
2589
2641
|
* @param coord_type Specify whether coordinates are relative to the screen or widget window.
|
|
2642
|
+
* @since 1.3
|
|
2590
2643
|
*/
|
|
2591
2644
|
get_range_extents(start_offset: number, end_offset: number, coord_type: Atk.CoordType): Atk.TextRectangle;
|
|
2592
2645
|
|
|
@@ -2644,6 +2697,7 @@ export namespace Cally {
|
|
|
2644
2697
|
* @param offset position
|
|
2645
2698
|
* @param granularity An {@link Atk.TextGranularity}
|
|
2646
2699
|
* @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.
|
|
2700
|
+
* @since 2.10
|
|
2647
2701
|
*/
|
|
2648
2702
|
get_string_at_offset(offset: number, granularity: Atk.TextGranularity): [string | null, number, number];
|
|
2649
2703
|
|
|
@@ -2660,6 +2714,7 @@ export namespace Cally {
|
|
|
2660
2714
|
* @param offset position
|
|
2661
2715
|
* @param boundary_type An {@link Atk.TextBoundary}
|
|
2662
2716
|
* @returns a newly allocated string containing the text after `offset` bounded by the specified `boundary_type`. Use `g_free()` to free the returned string.
|
|
2717
|
+
* @deprecated since 2.9.3: Please use `atk_text_get_string_at_offset()` instead.
|
|
2663
2718
|
*/
|
|
2664
2719
|
get_text_after_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
|
|
2665
2720
|
|
|
@@ -2691,6 +2746,7 @@ export namespace Cally {
|
|
|
2691
2746
|
* @param offset position
|
|
2692
2747
|
* @param boundary_type An {@link Atk.TextBoundary}
|
|
2693
2748
|
* @returns a newly allocated string containing the text at `offset` bounded by the specified `boundary_type`. Use `g_free()` to free the returned string.
|
|
2749
|
+
* @deprecated This method is deprecated since ATK version 2.9.4. Please use `atk_text_get_string_at_offset()` instead.
|
|
2694
2750
|
*/
|
|
2695
2751
|
get_text_at_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
|
|
2696
2752
|
|
|
@@ -2699,6 +2755,7 @@ export namespace Cally {
|
|
|
2699
2755
|
* @param offset position
|
|
2700
2756
|
* @param boundary_type An {@link Atk.TextBoundary}
|
|
2701
2757
|
* @returns a newly allocated string containing the text before `offset` bounded by the specified `boundary_type`. Use `g_free()` to free the returned string.
|
|
2758
|
+
* @deprecated since 2.9.3: Please use `atk_text_get_string_at_offset()` instead.
|
|
2702
2759
|
*/
|
|
2703
2760
|
get_text_before_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
|
|
2704
2761
|
|
|
@@ -2715,6 +2772,7 @@ export namespace Cally {
|
|
|
2715
2772
|
* @param end_offset end offset in the `text`, or -1 for the end of the text.
|
|
2716
2773
|
* @param type specify where the object should be made visible.
|
|
2717
2774
|
* @returns whether scrolling was successful.
|
|
2775
|
+
* @since 2.32
|
|
2718
2776
|
*/
|
|
2719
2777
|
scroll_substring_to(start_offset: number, end_offset: number, type: Atk.ScrollType): boolean;
|
|
2720
2778
|
|
|
@@ -2727,6 +2785,7 @@ export namespace Cally {
|
|
|
2727
2785
|
* @param x x-position where to scroll to
|
|
2728
2786
|
* @param y y-position where to scroll to
|
|
2729
2787
|
* @returns whether scrolling was successful.
|
|
2788
|
+
* @since 2.32
|
|
2730
2789
|
*/
|
|
2731
2790
|
scroll_substring_to_point(start_offset: number, end_offset: number, coords: Atk.CoordType, x: number, y: number): boolean;
|
|
2732
2791
|
|
|
@@ -2776,6 +2835,7 @@ export namespace Cally {
|
|
|
2776
2835
|
* @param coord_type Specify whether coordinates are relative to the screen or widget window.
|
|
2777
2836
|
* @param x_clip_type Specify the horizontal clip type.
|
|
2778
2837
|
* @param y_clip_type Specify the vertical clip type.
|
|
2838
|
+
* @since 1.3
|
|
2779
2839
|
* @virtual
|
|
2780
2840
|
*/
|
|
2781
2841
|
vfunc_get_bounded_ranges(rect: Atk.TextRectangle, coord_type: Atk.CoordType, x_clip_type: Atk.TextClipType, y_clip_type: Atk.TextClipType): Atk.TextRange[];
|
|
@@ -2845,6 +2905,7 @@ export namespace Cally {
|
|
|
2845
2905
|
* @param start_offset The offset of the first text character for which boundary information is required.
|
|
2846
2906
|
* @param end_offset The offset of the text character after the last character for which boundary information is required.
|
|
2847
2907
|
* @param coord_type Specify whether coordinates are relative to the screen or widget window.
|
|
2908
|
+
* @since 1.3
|
|
2848
2909
|
* @virtual
|
|
2849
2910
|
*/
|
|
2850
2911
|
vfunc_get_range_extents(start_offset: number, end_offset: number, coord_type: Atk.CoordType): Atk.TextRectangle;
|
|
@@ -2902,6 +2963,7 @@ export namespace Cally {
|
|
|
2902
2963
|
* of the following paragraph after the offset.
|
|
2903
2964
|
* @param offset position
|
|
2904
2965
|
* @param granularity An {@link Atk.TextGranularity}
|
|
2966
|
+
* @since 2.10
|
|
2905
2967
|
* @virtual
|
|
2906
2968
|
*/
|
|
2907
2969
|
vfunc_get_string_at_offset(offset: number, granularity: Atk.TextGranularity): [string | null, number, number];
|
|
@@ -2918,6 +2980,7 @@ export namespace Cally {
|
|
|
2918
2980
|
* Gets the specified text.
|
|
2919
2981
|
* @param offset position
|
|
2920
2982
|
* @param boundary_type An {@link Atk.TextBoundary}
|
|
2983
|
+
* @deprecated since 2.9.3: Please use `atk_text_get_string_at_offset()` instead.
|
|
2921
2984
|
* @virtual
|
|
2922
2985
|
*/
|
|
2923
2986
|
vfunc_get_text_after_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
|
|
@@ -2949,6 +3012,7 @@ export namespace Cally {
|
|
|
2949
3012
|
* start after the offset.
|
|
2950
3013
|
* @param offset position
|
|
2951
3014
|
* @param boundary_type An {@link Atk.TextBoundary}
|
|
3015
|
+
* @deprecated This method is deprecated since ATK version 2.9.4. Please use `atk_text_get_string_at_offset()` instead.
|
|
2952
3016
|
* @virtual
|
|
2953
3017
|
*/
|
|
2954
3018
|
vfunc_get_text_at_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
|
|
@@ -2957,6 +3021,7 @@ export namespace Cally {
|
|
|
2957
3021
|
* Gets the specified text.
|
|
2958
3022
|
* @param offset position
|
|
2959
3023
|
* @param boundary_type An {@link Atk.TextBoundary}
|
|
3024
|
+
* @deprecated since 2.9.3: Please use `atk_text_get_string_at_offset()` instead.
|
|
2960
3025
|
* @virtual
|
|
2961
3026
|
*/
|
|
2962
3027
|
vfunc_get_text_before_offset(offset: number, boundary_type: Atk.TextBoundary): [string, number, number];
|
|
@@ -2973,6 +3038,7 @@ export namespace Cally {
|
|
|
2973
3038
|
* @param start_offset start offset in the `text`
|
|
2974
3039
|
* @param end_offset end offset in the `text`, or -1 for the end of the text.
|
|
2975
3040
|
* @param type specify where the object should be made visible.
|
|
3041
|
+
* @since 2.32
|
|
2976
3042
|
* @virtual
|
|
2977
3043
|
*/
|
|
2978
3044
|
vfunc_scroll_substring_to(start_offset: number, end_offset: number, type: Atk.ScrollType): boolean;
|
|
@@ -2985,6 +3051,7 @@ export namespace Cally {
|
|
|
2985
3051
|
* @param coords specify whether coordinates are relative to the screen or to the parent object.
|
|
2986
3052
|
* @param x x-position where to scroll to
|
|
2987
3053
|
* @param y y-position where to scroll to
|
|
3054
|
+
* @since 2.32
|
|
2988
3055
|
* @virtual
|
|
2989
3056
|
*/
|
|
2990
3057
|
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-7",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.4.0",
|
|
4
4
|
"description": "GJS TypeScript type definitions for Cally-7",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"module": "cally-7.js",
|
|
@@ -31,23 +31,23 @@
|
|
|
31
31
|
"test": "tsc --project tsconfig.json"
|
|
32
32
|
},
|
|
33
33
|
"dependencies": {
|
|
34
|
-
"@girs/gjs": "^4.
|
|
35
|
-
"@girs/coglpango-7": "^4.
|
|
36
|
-
"@girs/pangocairo-1.0": "^4.
|
|
37
|
-
"@girs/cairo-1.0": "^4.
|
|
38
|
-
"@girs/gobject-2.0": "^4.
|
|
39
|
-
"@girs/glib-2.0": "^4.
|
|
40
|
-
"@girs/pango-1.0": "^4.
|
|
41
|
-
"@girs/harfbuzz-0.0": "^4.
|
|
42
|
-
"@girs/freetype2-2.0": "^4.
|
|
43
|
-
"@girs/gio-2.0": "^4.
|
|
44
|
-
"@girs/gmodule-2.0": "^4.
|
|
45
|
-
"@girs/cogl-7": "^4.
|
|
46
|
-
"@girs/graphene-1.0": "^4.
|
|
47
|
-
"@girs/gl-1.0": "^4.
|
|
48
|
-
"@girs/clutter-7": "^4.
|
|
49
|
-
"@girs/json-1.0": "^4.
|
|
50
|
-
"@girs/atk-1.0": "^4.
|
|
34
|
+
"@girs/gjs": "^4.4.0",
|
|
35
|
+
"@girs/coglpango-7": "^4.4.0",
|
|
36
|
+
"@girs/pangocairo-1.0": "^4.4.0",
|
|
37
|
+
"@girs/cairo-1.0": "^4.4.0",
|
|
38
|
+
"@girs/gobject-2.0": "^4.4.0",
|
|
39
|
+
"@girs/glib-2.0": "^4.4.0",
|
|
40
|
+
"@girs/pango-1.0": "^4.4.0",
|
|
41
|
+
"@girs/harfbuzz-0.0": "^4.4.0",
|
|
42
|
+
"@girs/freetype2-2.0": "^4.4.0",
|
|
43
|
+
"@girs/gio-2.0": "^4.4.0",
|
|
44
|
+
"@girs/gmodule-2.0": "^4.4.0",
|
|
45
|
+
"@girs/cogl-7": "^4.4.0",
|
|
46
|
+
"@girs/graphene-1.0": "^4.4.0",
|
|
47
|
+
"@girs/gl-1.0": "^4.4.0",
|
|
48
|
+
"@girs/clutter-7": "^4.4.0",
|
|
49
|
+
"@girs/json-1.0": "^4.4.0",
|
|
50
|
+
"@girs/atk-1.0": "^4.4.0" },
|
|
51
51
|
"devDependencies": {
|
|
52
52
|
"typescript": "*"
|
|
53
53
|
},
|