@girs/foundrygtk-1 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 CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/foundrygtk-1)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for FoundryGtk-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.0.
8
+ GJS TypeScript type definitions for FoundryGtk-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.0.
9
9
 
10
10
  ## Install
11
11
 
@@ -166,6 +166,23 @@ export interface Widgets {
166
166
  /** Every GType this namespace can create. A consumer derives its own tag map. */
167
167
  export type WidgetGType = keyof Widgets;
168
168
 
169
+ // ---------------------------------------------------------------------------
170
+ // Child holders — the same shape, for objects that CARRY a widget without being one.
171
+ //
172
+ // `GtkListItem`, `GtkListHeader`, `GtkColumnViewCell` and `AdwToggle` descend from
173
+ // `GObject.Object` and hold a widget through `set_child`/`get_child`. A renderer places
174
+ // them exactly like a container, so they belong in the vocabulary; a check asking "is
175
+ // this a widget" must still be able to say no. Hence a sibling table rather than four
176
+ // more rows in `Widgets`: concatenate them when you mean both.
177
+ // ---------------------------------------------------------------------------
178
+
179
+ export interface ChildHolders {
180
+
181
+ }
182
+
183
+ /** Every GType this namespace holds a child in without it being a widget. */
184
+ export type ChildHolderGType = keyof ChildHolders;
185
+
169
186
  /** The writable, optional, GObject-keyed property surface of one GType. */
170
187
  export type PropsOf<G extends WidgetGType> = Widgets[G]['props'];
171
188
 
@@ -201,6 +218,9 @@ export const OWN_SIGNALS: Readonly<Record<string, readonly string[]>>;
201
218
  /** Widget GType -> every declaration its members come from, self first. */
202
219
  export const DECLS: Readonly<Record<string, readonly string[]>>;
203
220
 
221
+ /** The GTypes in `DECLS` that hold a widget without being one — see `ChildHolders`. */
222
+ export const CHILD_HOLDERS: readonly string[];
223
+
204
224
  /** Enum GType -> the nicks this surface offers. */
205
225
  export const ENUM_NICKS: Readonly<Record<string, readonly string[]>>;
206
226
 
@@ -27,6 +27,12 @@ export const DECLS = {
27
27
  FoundryTerminal: ['FoundryTerminal', 'GtkWidget', 'GtkAccessible', 'GtkAccessibleText', 'GtkBuildable', 'GtkConstraintTarget', 'GtkScrollable'],
28
28
  };
29
29
 
30
+ // The GTypes above that are NOT widgets: they hold one through `set_child`/`get_child`
31
+ // and descend from `GObject.Object`. A renderer places them like a container; a check
32
+ // asking "is this a widget" must not count them. Derived from the accessor pair, never
33
+ // from a list — the count is in the provenance line above.
34
+ export const CHILD_HOLDERS = [];
35
+
30
36
  export const ENUM_NICKS = {};
31
37
 
32
38
  export const SLOT_CANDIDATES = {};
package/foundrygtk-1.d.ts CHANGED
@@ -369,12 +369,14 @@ export namespace FoundryGtk {
369
369
  /**
370
370
  * Gets the graph entry displayed by `self`.
371
371
  * @returns a {@link Foundry.VcsGraphEntry}
372
+ * @since 1.2
372
373
  */
373
374
  dup_entry(): Foundry.VcsGraphEntry | null;
374
375
 
375
376
  /**
376
377
  * Sets the graph entry displayed by `self`.
377
378
  * @param entry a {@link Foundry.VcsGraphEntry}
379
+ * @since 1.2
378
380
  */
379
381
  set_entry(entry: Foundry.VcsGraphEntry | null): void;
380
382
 
@@ -384,6 +386,7 @@ export namespace FoundryGtk {
384
386
  * If `colors` is `null`, the default lane colors are used. When `colors` is not
385
387
  * `null`, the colors are copied and `n_colors` must be greater than zero.
386
388
  * @param colors the lane colors
389
+ * @since 1.2
387
390
  */
388
391
  set_lane_colors(colors: Gdk.RGBA[] | null): void;
389
392
 
@@ -419,6 +422,7 @@ export namespace FoundryGtk {
419
422
  * does not interrupts the user's current screen reader output.
420
423
  * @param message the string to announce
421
424
  * @param priority the priority of the announcement
425
+ * @since 4.14
422
426
  */
423
427
  announce(message: string, priority: Gtk.AccessibleAnnouncementPriority): void;
424
428
 
@@ -431,6 +435,7 @@ export namespace FoundryGtk {
431
435
  * It is left to the accessible implementation to define the scope
432
436
  * and uniqueness of the identifier.
433
437
  * @returns the accessible identifier
438
+ * @since 4.22
434
439
  */
435
440
  get_accessible_id(): string | null;
436
441
 
@@ -439,6 +444,7 @@ export namespace FoundryGtk {
439
444
  *
440
445
  * This function returns `NULL` for top level widgets.
441
446
  * @returns the accessible parent
447
+ * @since 4.10
442
448
  */
443
449
  get_accessible_parent(): Gtk.Accessible | null;
444
450
 
@@ -451,6 +457,7 @@ export namespace FoundryGtk {
451
457
  /**
452
458
  * Retrieves the implementation for the given accessible object.
453
459
  * @returns the accessible implementation object
460
+ * @since 4.10
454
461
  */
455
462
  get_at_context(): Gtk.ATContext;
456
463
 
@@ -461,18 +468,21 @@ export namespace FoundryGtk {
461
468
  * implementations, e.g. to get the bounds from an ignored
462
469
  * child widget.
463
470
  * @returns true if the bounds are valid, and false otherwise
471
+ * @since 4.10
464
472
  */
465
473
  get_bounds(): [boolean, number, number, number, number];
466
474
 
467
475
  /**
468
476
  * Retrieves the first accessible child of an accessible object.
469
477
  * @returns the first accessible child
478
+ * @since 4.10
470
479
  */
471
480
  get_first_accessible_child(): Gtk.Accessible | null;
472
481
 
473
482
  /**
474
483
  * Retrieves the next accessible sibling of an accessible object
475
484
  * @returns the next accessible sibling
485
+ * @since 4.10
476
486
  */
477
487
  get_next_accessible_sibling(): Gtk.Accessible | null;
478
488
 
@@ -484,6 +494,7 @@ export namespace FoundryGtk {
484
494
  * child widget, as is the case for {@link Gtk.Text} wrappers.
485
495
  * @param state platform state to query
486
496
  * @returns the value of state for the accessible
497
+ * @since 4.10
487
498
  */
488
499
  get_platform_state(state: Gtk.AccessiblePlatformState): boolean;
489
500
 
@@ -517,6 +528,7 @@ export namespace FoundryGtk {
517
528
  * object is the container widget.
518
529
  * @param parent the parent accessible object
519
530
  * @param next_sibling the sibling accessible object
531
+ * @since 4.10
520
532
  */
521
533
  set_accessible_parent(parent: Gtk.Accessible | null, next_sibling: Gtk.Accessible | null): void;
522
534
 
@@ -526,6 +538,7 @@ export namespace FoundryGtk {
526
538
  * That might be useful when a new child of a custom accessible
527
539
  * is created, and it needs to be linked to a previous child.
528
540
  * @param new_sibling the new next accessible sibling to set
541
+ * @since 4.10
529
542
  */
530
543
  update_next_accessible_sibling(new_sibling: Gtk.Accessible | null): void;
531
544
 
@@ -536,6 +549,7 @@ export namespace FoundryGtk {
536
549
  * have a platform state but are not widgets. Widgets handle platform
537
550
  * states automatically.
538
551
  * @param state the platform state to update
552
+ * @since 4.18
539
553
  */
540
554
  update_platform_state(state: Gtk.AccessiblePlatformState): void;
541
555
 
@@ -583,6 +597,7 @@ export namespace FoundryGtk {
583
597
  *
584
598
  * It is left to the accessible implementation to define the scope
585
599
  * and uniqueness of the identifier.
600
+ * @since 4.22
586
601
  * @virtual
587
602
  */
588
603
  vfunc_get_accessible_id(): string | null;
@@ -591,12 +606,14 @@ export namespace FoundryGtk {
591
606
  * Retrieves the accessible parent for an accessible object.
592
607
  *
593
608
  * This function returns `NULL` for top level widgets.
609
+ * @since 4.10
594
610
  * @virtual
595
611
  */
596
612
  vfunc_get_accessible_parent(): Gtk.Accessible | null;
597
613
 
598
614
  /**
599
615
  * Retrieves the implementation for the given accessible object.
616
+ * @since 4.10
600
617
  * @virtual
601
618
  */
602
619
  vfunc_get_at_context(): Gtk.ATContext | null;
@@ -607,18 +624,21 @@ export namespace FoundryGtk {
607
624
  * This functionality can be overridden by {@link Gtk.Accessible}
608
625
  * implementations, e.g. to get the bounds from an ignored
609
626
  * child widget.
627
+ * @since 4.10
610
628
  * @virtual
611
629
  */
612
630
  vfunc_get_bounds(): [boolean, number, number, number, number];
613
631
 
614
632
  /**
615
633
  * Retrieves the first accessible child of an accessible object.
634
+ * @since 4.10
616
635
  * @virtual
617
636
  */
618
637
  vfunc_get_first_accessible_child(): Gtk.Accessible | null;
619
638
 
620
639
  /**
621
640
  * Retrieves the next accessible sibling of an accessible object
641
+ * @since 4.10
622
642
  * @virtual
623
643
  */
624
644
  vfunc_get_next_accessible_sibling(): Gtk.Accessible | null;
@@ -630,6 +650,7 @@ export namespace FoundryGtk {
630
650
  * implementations, e.g. to get platform state from an ignored
631
651
  * child widget, as is the case for {@link Gtk.Text} wrappers.
632
652
  * @param state platform state to query
653
+ * @since 4.10
633
654
  * @virtual
634
655
  */
635
656
  vfunc_get_platform_state(state: Gtk.AccessiblePlatformState): boolean;
@@ -852,6 +873,7 @@ export namespace FoundryGtk {
852
873
  * does not interrupts the user's current screen reader output.
853
874
  * @param message the string to announce
854
875
  * @param priority the priority of the announcement
876
+ * @since 4.14
855
877
  */
856
878
  announce(message: string, priority: Gtk.AccessibleAnnouncementPriority): void;
857
879
 
@@ -864,6 +886,7 @@ export namespace FoundryGtk {
864
886
  * It is left to the accessible implementation to define the scope
865
887
  * and uniqueness of the identifier.
866
888
  * @returns the accessible identifier
889
+ * @since 4.22
867
890
  */
868
891
  get_accessible_id(): string | null;
869
892
 
@@ -872,6 +895,7 @@ export namespace FoundryGtk {
872
895
  *
873
896
  * This function returns `NULL` for top level widgets.
874
897
  * @returns the accessible parent
898
+ * @since 4.10
875
899
  */
876
900
  get_accessible_parent(): Gtk.Accessible | null;
877
901
 
@@ -884,6 +908,7 @@ export namespace FoundryGtk {
884
908
  /**
885
909
  * Retrieves the implementation for the given accessible object.
886
910
  * @returns the accessible implementation object
911
+ * @since 4.10
887
912
  */
888
913
  get_at_context(): Gtk.ATContext;
889
914
 
@@ -894,18 +919,21 @@ export namespace FoundryGtk {
894
919
  * implementations, e.g. to get the bounds from an ignored
895
920
  * child widget.
896
921
  * @returns true if the bounds are valid, and false otherwise
922
+ * @since 4.10
897
923
  */
898
924
  get_bounds(): [boolean, number, number, number, number];
899
925
 
900
926
  /**
901
927
  * Retrieves the first accessible child of an accessible object.
902
928
  * @returns the first accessible child
929
+ * @since 4.10
903
930
  */
904
931
  get_first_accessible_child(): Gtk.Accessible | null;
905
932
 
906
933
  /**
907
934
  * Retrieves the next accessible sibling of an accessible object
908
935
  * @returns the next accessible sibling
936
+ * @since 4.10
909
937
  */
910
938
  get_next_accessible_sibling(): Gtk.Accessible | null;
911
939
 
@@ -917,6 +945,7 @@ export namespace FoundryGtk {
917
945
  * child widget, as is the case for {@link Gtk.Text} wrappers.
918
946
  * @param state platform state to query
919
947
  * @returns the value of state for the accessible
948
+ * @since 4.10
920
949
  */
921
950
  get_platform_state(state: Gtk.AccessiblePlatformState): boolean;
922
951
 
@@ -950,6 +979,7 @@ export namespace FoundryGtk {
950
979
  * object is the container widget.
951
980
  * @param parent the parent accessible object
952
981
  * @param next_sibling the sibling accessible object
982
+ * @since 4.10
953
983
  */
954
984
  set_accessible_parent(parent: Gtk.Accessible | null, next_sibling: Gtk.Accessible | null): void;
955
985
 
@@ -959,6 +989,7 @@ export namespace FoundryGtk {
959
989
  * That might be useful when a new child of a custom accessible
960
990
  * is created, and it needs to be linked to a previous child.
961
991
  * @param new_sibling the new next accessible sibling to set
992
+ * @since 4.10
962
993
  */
963
994
  update_next_accessible_sibling(new_sibling: Gtk.Accessible | null): void;
964
995
 
@@ -969,6 +1000,7 @@ export namespace FoundryGtk {
969
1000
  * have a platform state but are not widgets. Widgets handle platform
970
1001
  * states automatically.
971
1002
  * @param state the platform state to update
1003
+ * @since 4.18
972
1004
  */
973
1005
  update_platform_state(state: Gtk.AccessiblePlatformState): void;
974
1006
 
@@ -1016,6 +1048,7 @@ export namespace FoundryGtk {
1016
1048
  *
1017
1049
  * It is left to the accessible implementation to define the scope
1018
1050
  * and uniqueness of the identifier.
1051
+ * @since 4.22
1019
1052
  * @virtual
1020
1053
  */
1021
1054
  vfunc_get_accessible_id(): string | null;
@@ -1024,12 +1057,14 @@ export namespace FoundryGtk {
1024
1057
  * Retrieves the accessible parent for an accessible object.
1025
1058
  *
1026
1059
  * This function returns `NULL` for top level widgets.
1060
+ * @since 4.10
1027
1061
  * @virtual
1028
1062
  */
1029
1063
  vfunc_get_accessible_parent(): Gtk.Accessible | null;
1030
1064
 
1031
1065
  /**
1032
1066
  * Retrieves the implementation for the given accessible object.
1067
+ * @since 4.10
1033
1068
  * @virtual
1034
1069
  */
1035
1070
  vfunc_get_at_context(): Gtk.ATContext | null;
@@ -1040,18 +1075,21 @@ export namespace FoundryGtk {
1040
1075
  * This functionality can be overridden by {@link Gtk.Accessible}
1041
1076
  * implementations, e.g. to get the bounds from an ignored
1042
1077
  * child widget.
1078
+ * @since 4.10
1043
1079
  * @virtual
1044
1080
  */
1045
1081
  vfunc_get_bounds(): [boolean, number, number, number, number];
1046
1082
 
1047
1083
  /**
1048
1084
  * Retrieves the first accessible child of an accessible object.
1085
+ * @since 4.10
1049
1086
  * @virtual
1050
1087
  */
1051
1088
  vfunc_get_first_accessible_child(): Gtk.Accessible | null;
1052
1089
 
1053
1090
  /**
1054
1091
  * Retrieves the next accessible sibling of an accessible object
1092
+ * @since 4.10
1055
1093
  * @virtual
1056
1094
  */
1057
1095
  vfunc_get_next_accessible_sibling(): Gtk.Accessible | null;
@@ -1063,6 +1101,7 @@ export namespace FoundryGtk {
1063
1101
  * implementations, e.g. to get platform state from an ignored
1064
1102
  * child widget, as is the case for {@link Gtk.Text} wrappers.
1065
1103
  * @param state platform state to query
1104
+ * @since 4.10
1066
1105
  * @virtual
1067
1106
  */
1068
1107
  vfunc_get_platform_state(state: Gtk.AccessiblePlatformState): boolean;
@@ -1240,6 +1279,7 @@ export namespace FoundryGtk {
1240
1279
  /**
1241
1280
  * @param resource
1242
1281
  * @returns the merge id
1282
+ * @since 1.4
1243
1283
  */
1244
1284
  add_resource(resource: string): number;
1245
1285
 
@@ -1250,17 +1290,20 @@ export namespace FoundryGtk {
1250
1290
  * If no match is found, `null` is returned.
1251
1291
  * @param id the identifier of the menu item
1252
1292
  * @returns a {@link Gio.Menu} if successful; otherwise `null` and `position` is unset.
1293
+ * @since 1.4
1253
1294
  */
1254
1295
  find_item_by_id(id: string): [Gio.Menu | null, number];
1255
1296
 
1256
1297
  /**
1257
1298
  * @param menu_id
1258
1299
  * @returns A {@link Gio.Menu}.
1300
+ * @since 1.4
1259
1301
  */
1260
1302
  get_menu_by_id(menu_id: string): Gio.Menu;
1261
1303
 
1262
1304
  /**
1263
1305
  * Gets the known menu ids as a string array.
1306
+ * @since 1.4
1264
1307
  */
1265
1308
  get_menu_ids(): string[];
1266
1309
 
@@ -1269,6 +1312,7 @@ export namespace FoundryGtk {
1269
1312
  * @param menu_id the identifier of the menu
1270
1313
  * @param menu_model the menu model to merge
1271
1314
  * @returns the merge-id which can be used with `foundry_menu_manager_remove()`
1315
+ * @since 1.4
1272
1316
  */
1273
1317
  merge(menu_id: string, menu_model: Gio.MenuModel): number;
1274
1318
 
@@ -1277,6 +1321,7 @@ export namespace FoundryGtk {
1277
1321
  * menu merge. Use the value returned from `foundry_menu_manager_merge()` as
1278
1322
  * the `merge_id`.
1279
1323
  * @param merge_id A previously registered merge id
1324
+ * @since 1.4
1280
1325
  */
1281
1326
  remove(merge_id: number): void;
1282
1327
 
@@ -1290,6 +1335,7 @@ export namespace FoundryGtk {
1290
1335
  * @param position the index of the item in the menu
1291
1336
  * @param attribute the attribute to change
1292
1337
  * @param value the new value for the attribute
1338
+ * @since 1.4
1293
1339
  */
1294
1340
  set_attribute_string(menu: Gio.Menu, position: number, attribute: string, value: string): void;
1295
1341
  }
@@ -1440,6 +1486,7 @@ export namespace FoundryGtk {
1440
1486
  * The item type of a {@link Gio.ListModel} can not change during the life of the
1441
1487
  * model.
1442
1488
  * @returns the {@link GObject.GType} of the items contained in `list`.
1489
+ * @since 2.44
1443
1490
  */
1444
1491
  get_item_type(): GObject.GType;
1445
1492
 
@@ -1450,6 +1497,7 @@ export namespace FoundryGtk {
1450
1497
  * less efficient than iterating the list with increasing values for
1451
1498
  * `position` until `g_list_model_get_item()` returns `null`.
1452
1499
  * @returns the number of items in `list`.
1500
+ * @since 2.44
1453
1501
  */
1454
1502
  get_n_items(): number;
1455
1503
 
@@ -1468,6 +1516,7 @@ export namespace FoundryGtk {
1468
1516
  * See also: `g_list_model_get_n_items()`
1469
1517
  * @param position the position of the item to fetch
1470
1518
  * @returns the object at `position`.
1519
+ * @since 2.44
1471
1520
  */
1472
1521
  get_item(position: number): A | null;
1473
1522
 
@@ -1495,6 +1544,7 @@ export namespace FoundryGtk {
1495
1544
  * @param position the position at which `list` changed
1496
1545
  * @param removed the number of items removed
1497
1546
  * @param added the number of items added
1547
+ * @since 2.44
1498
1548
  */
1499
1549
  items_changed(position: number, removed: number, added: number): void;
1500
1550
 
@@ -1507,6 +1557,7 @@ export namespace FoundryGtk {
1507
1557
  *
1508
1558
  * The same {@link GObject.Object} instance may not appear more than once in a {@link Gio.ListModel}.
1509
1559
  * @param position the position of the item to fetch
1560
+ * @since 2.44
1510
1561
  * @virtual
1511
1562
  */
1512
1563
  vfunc_get_item(position: number): A | null;
@@ -1520,6 +1571,7 @@ export namespace FoundryGtk {
1520
1571
  *
1521
1572
  * The item type of a {@link Gio.ListModel} can not change during the life of the
1522
1573
  * model.
1574
+ * @since 2.44
1523
1575
  * @virtual
1524
1576
  */
1525
1577
  vfunc_get_item_type(): GObject.GType;
@@ -1530,6 +1582,7 @@ export namespace FoundryGtk {
1530
1582
  * Depending on the model implementation, calling this function may be
1531
1583
  * less efficient than iterating the list with increasing values for
1532
1584
  * `position` until `g_list_model_get_item()` returns `null`.
1585
+ * @since 2.44
1533
1586
  * @virtual
1534
1587
  */
1535
1588
  vfunc_get_n_items(): number;
@@ -1616,6 +1669,7 @@ export namespace FoundryGtk {
1616
1669
  * The item type of a {@link Gio.ListModel} can not change during the life of the
1617
1670
  * model.
1618
1671
  * @returns the {@link GObject.GType} of the items contained in `list`.
1672
+ * @since 2.44
1619
1673
  */
1620
1674
  get_item_type(): GObject.GType;
1621
1675
 
@@ -1626,6 +1680,7 @@ export namespace FoundryGtk {
1626
1680
  * less efficient than iterating the list with increasing values for
1627
1681
  * `position` until `g_list_model_get_item()` returns `null`.
1628
1682
  * @returns the number of items in `list`.
1683
+ * @since 2.44
1629
1684
  */
1630
1685
  get_n_items(): number;
1631
1686
 
@@ -1644,6 +1699,7 @@ export namespace FoundryGtk {
1644
1699
  * See also: `g_list_model_get_n_items()`
1645
1700
  * @param position the position of the item to fetch
1646
1701
  * @returns the object at `position`.
1702
+ * @since 2.44
1647
1703
  */
1648
1704
  get_item(position: number): A | null;
1649
1705
 
@@ -1671,6 +1727,7 @@ export namespace FoundryGtk {
1671
1727
  * @param position the position at which `list` changed
1672
1728
  * @param removed the number of items removed
1673
1729
  * @param added the number of items added
1730
+ * @since 2.44
1674
1731
  */
1675
1732
  items_changed(position: number, removed: number, added: number): void;
1676
1733
 
@@ -1683,6 +1740,7 @@ export namespace FoundryGtk {
1683
1740
  *
1684
1741
  * The same {@link GObject.Object} instance may not appear more than once in a {@link Gio.ListModel}.
1685
1742
  * @param position the position of the item to fetch
1743
+ * @since 2.44
1686
1744
  * @virtual
1687
1745
  */
1688
1746
  vfunc_get_item(position: number): A | null;
@@ -1696,6 +1754,7 @@ export namespace FoundryGtk {
1696
1754
  *
1697
1755
  * The item type of a {@link Gio.ListModel} can not change during the life of the
1698
1756
  * model.
1757
+ * @since 2.44
1699
1758
  * @virtual
1700
1759
  */
1701
1760
  vfunc_get_item_type(): GObject.GType;
@@ -1706,6 +1765,7 @@ export namespace FoundryGtk {
1706
1765
  * Depending on the model implementation, calling this function may be
1707
1766
  * less efficient than iterating the list with increasing values for
1708
1767
  * `position` until `g_list_model_get_item()` returns `null`.
1768
+ * @since 2.44
1709
1769
  * @virtual
1710
1770
  */
1711
1771
  vfunc_get_n_items(): number;
@@ -1894,6 +1954,7 @@ export namespace FoundryGtk {
1894
1954
  * for the current language.
1895
1955
  * @param begin start of the text range to comment
1896
1956
  * @param end end of the text range to comment
1957
+ * @since 1.1
1897
1958
  */
1898
1959
  comment(begin: Gtk.TextIter, end: Gtk.TextIter): void;
1899
1960
 
@@ -1932,6 +1993,7 @@ export namespace FoundryGtk {
1932
1993
  * Removes comment markers from the specified text range.
1933
1994
  * @param begin start of the text range to uncomment
1934
1995
  * @param end end of the text range to uncomment
1996
+ * @since 1.1
1935
1997
  */
1936
1998
  uncomment(begin: Gtk.TextIter, end: Gtk.TextIter): void;
1937
1999
 
@@ -1942,6 +2004,7 @@ export namespace FoundryGtk {
1942
2004
  * @param flags non-zero flags to dispatch
1943
2005
  * @param commit_notify
1944
2006
  * @returns a non-zero commit handler id if supported; otherwise zero.
2007
+ * @since 1.1
1945
2008
  */
1946
2009
  add_commit_notify(flags: Foundry.TextBufferNotifyFlags, commit_notify: Foundry.TextBufferCommitNotify): number;
1947
2010
 
@@ -2003,6 +2066,7 @@ export namespace FoundryGtk {
2003
2066
  /**
2004
2067
  * Remove a commit notify handler.
2005
2068
  * @param commit_notify_handler the previously registered non-zero commit handler
2069
+ * @since 1.1
2006
2070
  */
2007
2071
  remove_commit_notify(commit_notify_handler: number): void;
2008
2072
 
@@ -2019,6 +2083,7 @@ export namespace FoundryGtk {
2019
2083
  * If the implementation does not support this, zero is returned.
2020
2084
  * @param flags non-zero flags to dispatch
2021
2085
  * @param commit_notify
2086
+ * @since 1.1
2022
2087
  * @virtual
2023
2088
  */
2024
2089
  vfunc_add_commit_notify(flags: Foundry.TextBufferNotifyFlags, commit_notify: Foundry.TextBufferCommitNotify): number;
@@ -2059,6 +2124,7 @@ export namespace FoundryGtk {
2059
2124
  /**
2060
2125
  * Remove a commit notify handler.
2061
2126
  * @param commit_notify_handler the previously registered non-zero commit handler
2127
+ * @since 1.1
2062
2128
  * @virtual
2063
2129
  */
2064
2130
  vfunc_remove_commit_notify(commit_notify_handler: number): void;
@@ -2388,6 +2454,7 @@ export namespace FoundryGtk {
2388
2454
  * @param use_align
2389
2455
  * @param xalign
2390
2456
  * @param yalign
2457
+ * @since 1.1
2391
2458
  */
2392
2459
  jump_to_iter(iter: Gtk.TextIter, within_margin: number, use_align: boolean, xalign: number, yalign: number): void;
2393
2460
 
@@ -2697,6 +2764,7 @@ export namespace FoundryGtk {
2697
2764
  * does not interrupts the user's current screen reader output.
2698
2765
  * @param message the string to announce
2699
2766
  * @param priority the priority of the announcement
2767
+ * @since 4.14
2700
2768
  */
2701
2769
  announce(message: string, priority: Gtk.AccessibleAnnouncementPriority): void;
2702
2770
 
@@ -2709,6 +2777,7 @@ export namespace FoundryGtk {
2709
2777
  * It is left to the accessible implementation to define the scope
2710
2778
  * and uniqueness of the identifier.
2711
2779
  * @returns the accessible identifier
2780
+ * @since 4.22
2712
2781
  */
2713
2782
  get_accessible_id(): string | null;
2714
2783
 
@@ -2717,6 +2786,7 @@ export namespace FoundryGtk {
2717
2786
  *
2718
2787
  * This function returns `NULL` for top level widgets.
2719
2788
  * @returns the accessible parent
2789
+ * @since 4.10
2720
2790
  */
2721
2791
  get_accessible_parent(): Gtk.Accessible | null;
2722
2792
 
@@ -2729,6 +2799,7 @@ export namespace FoundryGtk {
2729
2799
  /**
2730
2800
  * Retrieves the implementation for the given accessible object.
2731
2801
  * @returns the accessible implementation object
2802
+ * @since 4.10
2732
2803
  */
2733
2804
  get_at_context(): Gtk.ATContext;
2734
2805
 
@@ -2739,18 +2810,21 @@ export namespace FoundryGtk {
2739
2810
  * implementations, e.g. to get the bounds from an ignored
2740
2811
  * child widget.
2741
2812
  * @returns true if the bounds are valid, and false otherwise
2813
+ * @since 4.10
2742
2814
  */
2743
2815
  get_bounds(): [boolean, number, number, number, number];
2744
2816
 
2745
2817
  /**
2746
2818
  * Retrieves the first accessible child of an accessible object.
2747
2819
  * @returns the first accessible child
2820
+ * @since 4.10
2748
2821
  */
2749
2822
  get_first_accessible_child(): Gtk.Accessible | null;
2750
2823
 
2751
2824
  /**
2752
2825
  * Retrieves the next accessible sibling of an accessible object
2753
2826
  * @returns the next accessible sibling
2827
+ * @since 4.10
2754
2828
  */
2755
2829
  get_next_accessible_sibling(): Gtk.Accessible | null;
2756
2830
 
@@ -2762,6 +2836,7 @@ export namespace FoundryGtk {
2762
2836
  * child widget, as is the case for {@link Gtk.Text} wrappers.
2763
2837
  * @param state platform state to query
2764
2838
  * @returns the value of state for the accessible
2839
+ * @since 4.10
2765
2840
  */
2766
2841
  get_platform_state(state: Gtk.AccessiblePlatformState): boolean;
2767
2842
 
@@ -2795,6 +2870,7 @@ export namespace FoundryGtk {
2795
2870
  * object is the container widget.
2796
2871
  * @param parent the parent accessible object
2797
2872
  * @param next_sibling the sibling accessible object
2873
+ * @since 4.10
2798
2874
  */
2799
2875
  set_accessible_parent(parent: Gtk.Accessible | null, next_sibling: Gtk.Accessible | null): void;
2800
2876
 
@@ -2804,6 +2880,7 @@ export namespace FoundryGtk {
2804
2880
  * That might be useful when a new child of a custom accessible
2805
2881
  * is created, and it needs to be linked to a previous child.
2806
2882
  * @param new_sibling the new next accessible sibling to set
2883
+ * @since 4.10
2807
2884
  */
2808
2885
  update_next_accessible_sibling(new_sibling: Gtk.Accessible | null): void;
2809
2886
 
@@ -2814,6 +2891,7 @@ export namespace FoundryGtk {
2814
2891
  * have a platform state but are not widgets. Widgets handle platform
2815
2892
  * states automatically.
2816
2893
  * @param state the platform state to update
2894
+ * @since 4.18
2817
2895
  */
2818
2896
  update_platform_state(state: Gtk.AccessiblePlatformState): void;
2819
2897
 
@@ -2861,6 +2939,7 @@ export namespace FoundryGtk {
2861
2939
  *
2862
2940
  * It is left to the accessible implementation to define the scope
2863
2941
  * and uniqueness of the identifier.
2942
+ * @since 4.22
2864
2943
  * @virtual
2865
2944
  */
2866
2945
  vfunc_get_accessible_id(): string | null;
@@ -2869,12 +2948,14 @@ export namespace FoundryGtk {
2869
2948
  * Retrieves the accessible parent for an accessible object.
2870
2949
  *
2871
2950
  * This function returns `NULL` for top level widgets.
2951
+ * @since 4.10
2872
2952
  * @virtual
2873
2953
  */
2874
2954
  vfunc_get_accessible_parent(): Gtk.Accessible | null;
2875
2955
 
2876
2956
  /**
2877
2957
  * Retrieves the implementation for the given accessible object.
2958
+ * @since 4.10
2878
2959
  * @virtual
2879
2960
  */
2880
2961
  vfunc_get_at_context(): Gtk.ATContext | null;
@@ -2885,18 +2966,21 @@ export namespace FoundryGtk {
2885
2966
  * This functionality can be overridden by {@link Gtk.Accessible}
2886
2967
  * implementations, e.g. to get the bounds from an ignored
2887
2968
  * child widget.
2969
+ * @since 4.10
2888
2970
  * @virtual
2889
2971
  */
2890
2972
  vfunc_get_bounds(): [boolean, number, number, number, number];
2891
2973
 
2892
2974
  /**
2893
2975
  * Retrieves the first accessible child of an accessible object.
2976
+ * @since 4.10
2894
2977
  * @virtual
2895
2978
  */
2896
2979
  vfunc_get_first_accessible_child(): Gtk.Accessible | null;
2897
2980
 
2898
2981
  /**
2899
2982
  * Retrieves the next accessible sibling of an accessible object
2983
+ * @since 4.10
2900
2984
  * @virtual
2901
2985
  */
2902
2986
  vfunc_get_next_accessible_sibling(): Gtk.Accessible | null;
@@ -2908,6 +2992,7 @@ export namespace FoundryGtk {
2908
2992
  * implementations, e.g. to get platform state from an ignored
2909
2993
  * child widget, as is the case for {@link Gtk.Text} wrappers.
2910
2994
  * @param state platform state to query
2995
+ * @since 4.10
2911
2996
  * @virtual
2912
2997
  */
2913
2998
  vfunc_get_platform_state(state: Gtk.AccessiblePlatformState): boolean;
@@ -2918,6 +3003,7 @@ export namespace FoundryGtk {
2918
3003
  * Implementations of the {@link Gtk.AccessibleText} interface should call this
2919
3004
  * function every time the caret has moved, in order to notify assistive
2920
3005
  * technologies.
3006
+ * @since 4.14
2921
3007
  */
2922
3008
  update_caret_position(): void;
2923
3009
 
@@ -2934,6 +3020,7 @@ export namespace FoundryGtk {
2934
3020
  * @param change the type of change in the contents
2935
3021
  * @param start the starting offset of the change, in characters
2936
3022
  * @param end the end offset of the change, in characters
3023
+ * @since 4.14
2937
3024
  */
2938
3025
  update_contents(change: Gtk.AccessibleTextContentChange, start: number, end: number): void;
2939
3026
 
@@ -2943,6 +3030,7 @@ export namespace FoundryGtk {
2943
3030
  * Implementations of the {@link Gtk.AccessibleText} interface should call this
2944
3031
  * function every time the selection has moved, in order to notify assistive
2945
3032
  * technologies.
3033
+ * @since 4.14
2946
3034
  */
2947
3035
  update_selection_bound(): void;
2948
3036
 
@@ -2965,12 +3053,14 @@ export namespace FoundryGtk {
2965
3053
  * greater than or equal to one, `ranges` will be set to a newly
2966
3054
  * allocated array of [struct#Gtk.AccessibleTextRange].
2967
3055
  * @param offset the offset, in characters
3056
+ * @since 4.14
2968
3057
  * @virtual
2969
3058
  */
2970
3059
  vfunc_get_attributes(offset: number): [boolean, Gtk.AccessibleTextRange[] | null, string[] | null, string[] | null];
2971
3060
 
2972
3061
  /**
2973
3062
  * Retrieves the position of the caret inside the accessible object.
3063
+ * @since 4.14
2974
3064
  * @virtual
2975
3065
  */
2976
3066
  vfunc_get_caret_position(): number;
@@ -2983,6 +3073,7 @@ export namespace FoundryGtk {
2983
3073
  * of the accessible object.
2984
3074
  * @param start the beginning of the range, in characters
2985
3075
  * @param end the end of the range, in characters
3076
+ * @since 4.14
2986
3077
  * @virtual
2987
3078
  */
2988
3079
  vfunc_get_contents(start: number, end: number): GLib.Bytes | Uint8Array;
@@ -2994,6 +3085,7 @@ export namespace FoundryGtk {
2994
3085
  * The `start` and `end` values contain the boundaries of the text.
2995
3086
  * @param offset the offset, in characters
2996
3087
  * @param granularity the granularity of the query
3088
+ * @since 4.14
2997
3089
  * @virtual
2998
3090
  */
2999
3091
  vfunc_get_contents_at(offset: number, granularity: Gtk.AccessibleTextGranularity): [GLib.Bytes | Uint8Array, number, number];
@@ -3011,6 +3103,7 @@ export namespace FoundryGtk {
3011
3103
  *
3012
3104
  * GTK provides support for various text attribute names and values, but
3013
3105
  * implementations of this interface are free to add their own attributes.
3106
+ * @since 4.14
3014
3107
  * @virtual
3015
3108
  */
3016
3109
  vfunc_get_default_attributes(): [string[] | null, string[] | null];
@@ -3020,6 +3113,7 @@ export namespace FoundryGtk {
3020
3113
  * @param start the start offset, in characters
3021
3114
  * @param end the end offset, in characters, `extents` (out caller-allocates): return location for the extents
3022
3115
  * @param extents
3116
+ * @since 4.16
3023
3117
  * @virtual
3024
3118
  */
3025
3119
  vfunc_get_extents(start: number, end: number, extents: Graphene.Rect): boolean;
@@ -3027,6 +3121,7 @@ export namespace FoundryGtk {
3027
3121
  /**
3028
3122
  * Gets the text offset at a given point.
3029
3123
  * @param point a point in widget coordinates of `self`
3124
+ * @since 4.16
3030
3125
  * @virtual
3031
3126
  */
3032
3127
  vfunc_get_offset(point: Graphene.Point): [boolean, number];
@@ -3037,6 +3132,7 @@ export namespace FoundryGtk {
3037
3132
  * If this function returns true, `n_ranges` will be set to a value
3038
3133
  * greater than or equal to one, and `ranges` will be set to a newly
3039
3134
  * allocated array of [struct#Gtk.AccessibleTextRange].
3135
+ * @since 4.14
3040
3136
  * @virtual
3041
3137
  */
3042
3138
  vfunc_get_selection(): [boolean, Gtk.AccessibleTextRange[] | null];
@@ -3044,6 +3140,7 @@ export namespace FoundryGtk {
3044
3140
  /**
3045
3141
  * Sets the caret position.
3046
3142
  * @param offset the text offset in characters
3143
+ * @since 4.22
3047
3144
  * @virtual
3048
3145
  */
3049
3146
  vfunc_set_caret_position(offset: number): boolean;
@@ -3052,6 +3149,7 @@ export namespace FoundryGtk {
3052
3149
  * Sets the caret position.
3053
3150
  * @param i the selection to set
3054
3151
  * @param range the range to set the selection to
3152
+ * @since 4.22
3055
3153
  * @virtual
3056
3154
  */
3057
3155
  vfunc_set_selection(i: number, range: Gtk.AccessibleTextRange): boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/foundrygtk-1",
3
- "version": "4.3.0",
3
+ "version": "4.4.0",
4
4
  "description": "GJS TypeScript type definitions for FoundryGtk-1",
5
5
  "type": "module",
6
6
  "module": "foundrygtk-1.js",
@@ -36,27 +36,27 @@
36
36
  "test": "tsc --project tsconfig.json"
37
37
  },
38
38
  "dependencies": {
39
- "@girs/gjs": "^4.3.0",
40
- "@girs/peas-2": "^4.3.0",
41
- "@girs/gio-2.0": "^4.3.0",
42
- "@girs/gobject-2.0": "^4.3.0",
43
- "@girs/glib-2.0": "^4.3.0",
44
- "@girs/gmodule-2.0": "^4.3.0",
45
- "@girs/json-1.0": "^4.3.0",
46
- "@girs/gtksource-5": "^4.3.0",
47
- "@girs/gtk-4.0": "^4.3.0",
48
- "@girs/gsk-4.0": "^4.3.0",
49
- "@girs/graphene-1.0": "^4.3.0",
50
- "@girs/gdk-4.0": "^4.3.0",
51
- "@girs/cairo-1.0": "^4.3.0",
52
- "@girs/pangocairo-1.0": "^4.3.0",
53
- "@girs/pango-1.0": "^4.3.0",
54
- "@girs/harfbuzz-0.0": "^4.3.0",
55
- "@girs/freetype2-2.0": "^4.3.0",
56
- "@girs/gdkpixbuf-2.0": "^4.3.0",
57
- "@girs/foundry-1": "^4.3.0",
58
- "@girs/dex-1": "^4.3.0",
59
- "@girs/giounix-2.0": "^4.3.0" },
39
+ "@girs/gjs": "^4.4.0",
40
+ "@girs/peas-2": "^4.4.0",
41
+ "@girs/gio-2.0": "^4.4.0",
42
+ "@girs/gobject-2.0": "^4.4.0",
43
+ "@girs/glib-2.0": "^4.4.0",
44
+ "@girs/gmodule-2.0": "^4.4.0",
45
+ "@girs/json-1.0": "^4.4.0",
46
+ "@girs/gtksource-5": "^4.4.0",
47
+ "@girs/gtk-4.0": "^4.4.0",
48
+ "@girs/gsk-4.0": "^4.4.0",
49
+ "@girs/graphene-1.0": "^4.4.0",
50
+ "@girs/gdk-4.0": "^4.4.0",
51
+ "@girs/cairo-1.0": "^4.4.0",
52
+ "@girs/pangocairo-1.0": "^4.4.0",
53
+ "@girs/pango-1.0": "^4.4.0",
54
+ "@girs/harfbuzz-0.0": "^4.4.0",
55
+ "@girs/freetype2-2.0": "^4.4.0",
56
+ "@girs/gdkpixbuf-2.0": "^4.4.0",
57
+ "@girs/foundry-1": "^4.4.0",
58
+ "@girs/dex-1": "^4.4.0",
59
+ "@girs/giounix-2.0": "^4.4.0" },
60
60
  "devDependencies": {
61
61
  "typescript": "*"
62
62
  },