@girs/gcrui-3 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.
package/README.md CHANGED
@@ -5,25 +5,25 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/gcrui-3)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for GcrUi-3 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
8
+ GJS TypeScript type definitions for GcrUi-3 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/gcrui-3
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 GcrUi from '@girs/gcrui-3';
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/gcrui-3` or `@girs/gcrui-3/ambient` in your `tsconfig` or entry point Typescript file:
28
28
 
29
29
  `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/gcrui-3'
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 GcrUi from 'gi://GcrUi?version=3';
@@ -50,7 +50,7 @@ import GcrUi from 'gi://GcrUi?version=3';
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/gcrui-3` or `@girs/gcrui-3/import` in your `tsconfig` or entry point Typescript file:
55
55
 
56
56
  `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/gcrui-3'
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 GcrUi = imports.gi.GcrUi;
@@ -77,7 +77,7 @@ const GcrUi = imports.gi.GcrUi;
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
 
@@ -230,6 +230,23 @@ export interface Widgets {
230
230
  /** Every GType this namespace can create. A consumer derives its own tag map. */
231
231
  export type WidgetGType = keyof Widgets;
232
232
 
233
+ // ---------------------------------------------------------------------------
234
+ // Child holders — the same shape, for objects that CARRY a widget without being one.
235
+ //
236
+ // `GtkListItem`, `GtkListHeader`, `GtkColumnViewCell` and `AdwToggle` descend from
237
+ // `GObject.Object` and hold a widget through `set_child`/`get_child`. A renderer places
238
+ // them exactly like a container, so they belong in the vocabulary; a check asking "is
239
+ // this a widget" must still be able to say no. Hence a sibling table rather than four
240
+ // more rows in `Widgets`: concatenate them when you mean both.
241
+ // ---------------------------------------------------------------------------
242
+
243
+ export interface ChildHolders {
244
+
245
+ }
246
+
247
+ /** Every GType this namespace holds a child in without it being a widget. */
248
+ export type ChildHolderGType = keyof ChildHolders;
249
+
233
250
  /** The writable, optional, GObject-keyed property surface of one GType. */
234
251
  export type PropsOf<G extends WidgetGType> = Widgets[G]['props'];
235
252
 
@@ -265,6 +282,9 @@ export const OWN_SIGNALS: Readonly<Record<string, readonly string[]>>;
265
282
  /** Widget GType -> every declaration its members come from, self first. */
266
283
  export const DECLS: Readonly<Record<string, readonly string[]>>;
267
284
 
285
+ /** The GTypes in `DECLS` that hold a widget without being one — see `ChildHolders`. */
286
+ export const CHILD_HOLDERS: readonly string[];
287
+
268
288
  /** Enum GType -> the nicks this surface offers. */
269
289
  export const ENUM_NICKS: Readonly<Record<string, readonly string[]>>;
270
290
 
@@ -36,6 +36,12 @@ export const DECLS = {
36
36
  GcrViewerWidget: ['GcrViewerWidget', 'GtkBox', 'GtkContainer', 'GtkWidget', 'GtkBuildable', 'GtkOrientable'],
37
37
  };
38
38
 
39
+ // The GTypes above that are NOT widgets: they hold one through `set_child`/`get_child`
40
+ // and descend from `GObject.Object`. A renderer places them like a container; a check
41
+ // asking "is this a widget" must not count them. Derived from the accessor pair, never
42
+ // from a list — the count is in the provenance line above.
43
+ export const CHILD_HOLDERS = [];
44
+
39
45
  export const ENUM_NICKS = {};
40
46
 
41
47
  export const SLOT_CANDIDATES = {};
package/gcrui-3.d.ts CHANGED
@@ -485,11 +485,14 @@ export namespace GcrUi {
485
485
  set_attributes(attrs: Gck.Attributes | null): void;
486
486
 
487
487
  /**
488
+ * signal emitted when data being rendered changes
488
489
  * @virtual
489
490
  */
490
491
  vfunc_data_changed(): void;
491
492
 
492
493
  /**
494
+ * method invoked to populate a popup menu with additional
495
+ * renderer options
493
496
  * @param viewer
494
497
  * @param menu
495
498
  * @virtual
@@ -793,6 +796,7 @@ export namespace GcrUi {
793
796
  * and `root` as the virtual root.
794
797
  * @param root A {@link Gtk.TreePath} or `null`.
795
798
  * @returns A new {@link Gtk.TreeModel}.
799
+ * @since 2.4
796
800
  */
797
801
  filter_new(root: Gtk.TreePath | null): Gtk.TreeModel;
798
802
 
@@ -869,6 +873,7 @@ export namespace GcrUi {
869
873
  * return value for this string.
870
874
  * @param iter a {@link Gtk.TreeIter}-struct
871
875
  * @returns a newly-allocated string. Must be freed with `g_free()`.
876
+ * @since 2.2
872
877
  */
873
878
  get_string_from_iter(iter: Gtk.TreeIter): string;
874
879
 
@@ -959,6 +964,7 @@ export namespace GcrUi {
959
964
  * set to be invalid.
960
965
  * @param iter the {@link Gtk.TreeIter}-struct
961
966
  * @returns `true` if `iter` has been changed to the previous node
967
+ * @since 3.0
962
968
  */
963
969
  iter_previous(iter: Gtk.TreeIter): boolean;
964
970
 
@@ -1028,6 +1034,7 @@ export namespace GcrUi {
1028
1034
  * @param path a {@link Gtk.TreePath}-struct pointing to the tree node whose children have been reordered
1029
1035
  * @param iter a valid {@link Gtk.TreeIter}-struct pointing to the node whose children have been reordered, or `null` if the depth of `path` is 0
1030
1036
  * @param new_order an array of integers mapping the current position of each child to its old position before the re-ordering, i.e. `new_order``[newpos] = oldpos`
1037
+ * @since 3.10
1031
1038
  */
1032
1039
  rows_reordered(path: Gtk.TreePath, iter: Gtk.TreeIter | null, new_order: number[]): void;
1033
1040
 
@@ -1171,6 +1178,7 @@ export namespace GcrUi {
1171
1178
  * If there is no previous `iter`, `false` is returned and `iter` is
1172
1179
  * set to be invalid.
1173
1180
  * @param iter the {@link Gtk.TreeIter}-struct
1181
+ * @since 3.0
1174
1182
  * @virtual
1175
1183
  */
1176
1184
  vfunc_iter_previous(iter: Gtk.TreeIter): boolean;
@@ -1597,12 +1605,14 @@ export namespace GcrUi {
1597
1605
  * @param cell a {@link Gtk.CellRenderer}
1598
1606
  * @param attribute an attribute on the renderer
1599
1607
  * @param column the column position on the model to get the attribute from
1608
+ * @since 2.4
1600
1609
  */
1601
1610
  add_attribute(cell: Gtk.CellRenderer, attribute: string, column: number): void;
1602
1611
 
1603
1612
  /**
1604
1613
  * Unsets all the mappings on all renderers on `cell_layout` and
1605
1614
  * removes all renderers from `cell_layout`.
1615
+ * @since 2.4
1606
1616
  */
1607
1617
  clear(): void;
1608
1618
 
@@ -1610,6 +1620,7 @@ export namespace GcrUi {
1610
1620
  * Clears all existing attributes previously set with
1611
1621
  * `gtk_cell_layout_set_attributes()`.
1612
1622
  * @param cell a {@link Gtk.CellRenderer} to clear the attribute mapping on
1623
+ * @since 2.4
1613
1624
  */
1614
1625
  clear_attributes(cell: Gtk.CellRenderer): void;
1615
1626
 
@@ -1618,12 +1629,14 @@ export namespace GcrUi {
1618
1629
  * if called on a {@link Gtk.CellArea} or might be `null` if no {@link Gtk.CellArea}
1619
1630
  * is used by `cell_layout`.
1620
1631
  * @returns the cell area used by `cell_layout`, or `null` in case no cell area is used.
1632
+ * @since 3.0
1621
1633
  */
1622
1634
  get_area(): Gtk.CellArea | null;
1623
1635
 
1624
1636
  /**
1625
1637
  * Returns the cell renderers which have been added to `cell_layout`.
1626
1638
  * @returns a list of cell renderers. The list, but not the renderers has been newly allocated and should be freed with `g_list_free()` when no longer needed.
1639
+ * @since 2.12
1627
1640
  */
1628
1641
  get_cells(): Gtk.CellRenderer[];
1629
1642
 
@@ -1635,6 +1648,7 @@ export namespace GcrUi {
1635
1648
  * Note that reusing the same cell renderer is not supported.
1636
1649
  * @param cell a {@link Gtk.CellRenderer}
1637
1650
  * @param expand `true` if `cell` is to be given extra space allocated to `cell_layout`
1651
+ * @since 2.4
1638
1652
  */
1639
1653
  pack_end(cell: Gtk.CellRenderer, expand: boolean): void;
1640
1654
 
@@ -1646,6 +1660,7 @@ export namespace GcrUi {
1646
1660
  * Note that reusing the same cell renderer is not supported.
1647
1661
  * @param cell a {@link Gtk.CellRenderer}
1648
1662
  * @param expand `true` if `cell` is to be given extra space allocated to `cell_layout`
1663
+ * @since 2.4
1649
1664
  */
1650
1665
  pack_start(cell: Gtk.CellRenderer, expand: boolean): void;
1651
1666
 
@@ -1656,6 +1671,7 @@ export namespace GcrUi {
1656
1671
  * for this to function properly.
1657
1672
  * @param cell a {@link Gtk.CellRenderer} to reorder
1658
1673
  * @param position new position to insert `cell` at
1674
+ * @since 2.4
1659
1675
  */
1660
1676
  reorder(cell: Gtk.CellRenderer, position: number): void;
1661
1677
 
@@ -1669,6 +1685,7 @@ export namespace GcrUi {
1669
1685
  * `func` may be `null` to remove a previously set function.
1670
1686
  * @param cell a {@link Gtk.CellRenderer}
1671
1687
  * @param func the {@link Gtk.CellLayoutDataFunc} to use, or `null`
1688
+ * @since 2.4
1672
1689
  */
1673
1690
  set_cell_data_func(cell: Gtk.CellRenderer, func: Gtk.CellLayoutDataFunc | null): void;
1674
1691
 
@@ -1682,6 +1699,7 @@ export namespace GcrUi {
1682
1699
  * @param cell a {@link Gtk.CellRenderer}
1683
1700
  * @param attribute an attribute on the renderer
1684
1701
  * @param column the column position on the model to get the attribute from
1702
+ * @since 2.4
1685
1703
  * @virtual
1686
1704
  */
1687
1705
  vfunc_add_attribute(cell: Gtk.CellRenderer, attribute: string, column: number): void;
@@ -1689,6 +1707,7 @@ export namespace GcrUi {
1689
1707
  /**
1690
1708
  * Unsets all the mappings on all renderers on `cell_layout` and
1691
1709
  * removes all renderers from `cell_layout`.
1710
+ * @since 2.4
1692
1711
  * @virtual
1693
1712
  */
1694
1713
  vfunc_clear(): void;
@@ -1697,6 +1716,7 @@ export namespace GcrUi {
1697
1716
  * Clears all existing attributes previously set with
1698
1717
  * `gtk_cell_layout_set_attributes()`.
1699
1718
  * @param cell a {@link Gtk.CellRenderer} to clear the attribute mapping on
1719
+ * @since 2.4
1700
1720
  * @virtual
1701
1721
  */
1702
1722
  vfunc_clear_attributes(cell: Gtk.CellRenderer): void;
@@ -1705,12 +1725,14 @@ export namespace GcrUi {
1705
1725
  * Returns the underlying {@link Gtk.CellArea} which might be `cell_layout`
1706
1726
  * if called on a {@link Gtk.CellArea} or might be `null` if no {@link Gtk.CellArea}
1707
1727
  * is used by `cell_layout`.
1728
+ * @since 3.0
1708
1729
  * @virtual
1709
1730
  */
1710
1731
  vfunc_get_area(): Gtk.CellArea | null;
1711
1732
 
1712
1733
  /**
1713
1734
  * Returns the cell renderers which have been added to `cell_layout`.
1735
+ * @since 2.12
1714
1736
  * @virtual
1715
1737
  */
1716
1738
  vfunc_get_cells(): Gtk.CellRenderer[];
@@ -1723,6 +1745,7 @@ export namespace GcrUi {
1723
1745
  * Note that reusing the same cell renderer is not supported.
1724
1746
  * @param cell a {@link Gtk.CellRenderer}
1725
1747
  * @param expand `true` if `cell` is to be given extra space allocated to `cell_layout`
1748
+ * @since 2.4
1726
1749
  * @virtual
1727
1750
  */
1728
1751
  vfunc_pack_end(cell: Gtk.CellRenderer, expand: boolean): void;
@@ -1735,6 +1758,7 @@ export namespace GcrUi {
1735
1758
  * Note that reusing the same cell renderer is not supported.
1736
1759
  * @param cell a {@link Gtk.CellRenderer}
1737
1760
  * @param expand `true` if `cell` is to be given extra space allocated to `cell_layout`
1761
+ * @since 2.4
1738
1762
  * @virtual
1739
1763
  */
1740
1764
  vfunc_pack_start(cell: Gtk.CellRenderer, expand: boolean): void;
@@ -1746,6 +1770,7 @@ export namespace GcrUi {
1746
1770
  * for this to function properly.
1747
1771
  * @param cell a {@link Gtk.CellRenderer} to reorder
1748
1772
  * @param position new position to insert `cell` at
1773
+ * @since 2.4
1749
1774
  * @virtual
1750
1775
  */
1751
1776
  vfunc_reorder(cell: Gtk.CellRenderer, position: number): void;
@@ -1760,6 +1785,7 @@ export namespace GcrUi {
1760
1785
  * `func` may be `null` to remove a previously set function.
1761
1786
  * @param cell a {@link Gtk.CellRenderer}
1762
1787
  * @param func the {@link Gtk.CellLayoutDataFunc} to use, or `null`
1788
+ * @since 2.4
1763
1789
  * @virtual
1764
1790
  */
1765
1791
  vfunc_set_cell_data_func(cell: Gtk.CellRenderer, func: Gtk.CellLayoutDataFunc | null): void;
@@ -1786,6 +1812,7 @@ export namespace GcrUi {
1786
1812
  * Returns whether the widget should grab focus when it is clicked with the mouse.
1787
1813
  * See `gtk_widget_set_focus_on_click()`.
1788
1814
  * @returns `true` if the widget should grab focus when it is clicked with the mouse.
1815
+ * @since 3.20
1789
1816
  */
1790
1817
  get_focus_on_click(): boolean;
1791
1818
 
@@ -1795,6 +1822,7 @@ export namespace GcrUi {
1795
1822
  * you don’t want the keyboard focus removed from the main area of the
1796
1823
  * application.
1797
1824
  * @param focus_on_click whether the widget should grab focus when clicked with the mouse
1825
+ * @since 3.20
1798
1826
  */
1799
1827
  set_focus_on_click(focus_on_click: boolean): void;
1800
1828
  }
@@ -1899,11 +1927,14 @@ export namespace GcrUi {
1899
1927
  set_attributes(attrs: Gck.Attributes | null): void;
1900
1928
 
1901
1929
  /**
1930
+ * signal emitted when data being rendered changes
1902
1931
  * @virtual
1903
1932
  */
1904
1933
  vfunc_data_changed(): void;
1905
1934
 
1906
1935
  /**
1936
+ * method invoked to populate a popup menu with additional
1937
+ * renderer options
1907
1938
  * @param viewer
1908
1939
  * @param menu
1909
1940
  * @virtual
@@ -2040,6 +2071,7 @@ export namespace GcrUi {
2040
2071
 
2041
2072
  // Virtual methods
2042
2073
  /**
2074
+ * Emitted when the import completes, or fails.
2043
2075
  * @param importer
2044
2076
  * @param error
2045
2077
  * @virtual
@@ -2047,6 +2079,7 @@ export namespace GcrUi {
2047
2079
  vfunc_imported(importer: Gcr.Importer, error: GLib.Error): void;
2048
2080
 
2049
2081
  /**
2082
+ * Emitted when the import begins.
2050
2083
  * @param importer
2051
2084
  * @virtual
2052
2085
  */
@@ -2150,6 +2183,7 @@ export namespace GcrUi {
2150
2183
  *
2151
2184
  * See `gtk_actionable_set_action_name()` for more information.
2152
2185
  * @returns the action name, or `null` if none is set
2186
+ * @since 3.4
2153
2187
  */
2154
2188
  get_action_name(): string | null;
2155
2189
 
@@ -2158,6 +2192,7 @@ export namespace GcrUi {
2158
2192
  *
2159
2193
  * See `gtk_actionable_set_action_target_value()` for more information.
2160
2194
  * @returns the current target value
2195
+ * @since 3.4
2161
2196
  */
2162
2197
  get_action_target_value(): GLib.Variant;
2163
2198
 
@@ -2174,6 +2209,7 @@ export namespace GcrUi {
2174
2209
  * respectively. This is the same form used for actions in the {@link Gio.Menu}
2175
2210
  * associated with the window.
2176
2211
  * @param action_name an action name, or `null`
2212
+ * @since 3.4
2177
2213
  */
2178
2214
  set_action_name(action_name: string | null): void;
2179
2215
 
@@ -2198,6 +2234,7 @@ export namespace GcrUi {
2198
2234
  * be rendered as active (and the other buttons, with different targets,
2199
2235
  * rendered inactive).
2200
2236
  * @param target_value a {@link GLib.Variant} to set as the target value, or `null`
2237
+ * @since 3.4
2201
2238
  */
2202
2239
  set_action_target_value(target_value: GLib.Variant | null): void;
2203
2240
 
@@ -2214,6 +2251,7 @@ export namespace GcrUi {
2214
2251
  * `action` is the action name and `target` is the string to use
2215
2252
  * as the target.)
2216
2253
  * @param detailed_action_name the detailed action name
2254
+ * @since 3.4
2217
2255
  */
2218
2256
  set_detailed_action_name(detailed_action_name: string): void;
2219
2257
 
@@ -2221,6 +2259,7 @@ export namespace GcrUi {
2221
2259
  * Gets the action name for `actionable`.
2222
2260
  *
2223
2261
  * See `gtk_actionable_set_action_name()` for more information.
2262
+ * @since 3.4
2224
2263
  * @virtual
2225
2264
  */
2226
2265
  vfunc_get_action_name(): string | null;
@@ -2229,6 +2268,7 @@ export namespace GcrUi {
2229
2268
  * Gets the current target value of `actionable`.
2230
2269
  *
2231
2270
  * See `gtk_actionable_set_action_target_value()` for more information.
2271
+ * @since 3.4
2232
2272
  * @virtual
2233
2273
  */
2234
2274
  vfunc_get_action_target_value(): GLib.Variant;
@@ -2246,6 +2286,7 @@ export namespace GcrUi {
2246
2286
  * respectively. This is the same form used for actions in the {@link Gio.Menu}
2247
2287
  * associated with the window.
2248
2288
  * @param action_name an action name, or `null`
2289
+ * @since 3.4
2249
2290
  * @virtual
2250
2291
  */
2251
2292
  vfunc_set_action_name(action_name: string | null): void;
@@ -2271,6 +2312,7 @@ export namespace GcrUi {
2271
2312
  * be rendered as active (and the other buttons, with different targets,
2272
2313
  * rendered inactive).
2273
2314
  * @param target_value a {@link GLib.Variant} to set as the target value, or `null`
2315
+ * @since 3.4
2274
2316
  * @virtual
2275
2317
  */
2276
2318
  vfunc_set_action_target_value(target_value: GLib.Variant | null): void;
@@ -2292,12 +2334,16 @@ export namespace GcrUi {
2292
2334
  * > `gtk_activatable_get_related_action()` to retrieve the
2293
2335
  * > previous action.
2294
2336
  * @param action the {@link Gtk.Action} to set
2337
+ * @since 2.16
2338
+ * @deprecated since 3.10
2295
2339
  */
2296
2340
  do_set_related_action(action: Gtk.Action): void;
2297
2341
 
2298
2342
  /**
2299
2343
  * Gets the related {@link Gtk.Action} for `activatable`.
2300
2344
  * @returns the related {@link Gtk.Action} if one is set.
2345
+ * @since 2.16
2346
+ * @deprecated since 3.10
2301
2347
  */
2302
2348
  get_related_action(): Gtk.Action;
2303
2349
 
@@ -2306,6 +2352,8 @@ export namespace GcrUi {
2306
2352
  * and appearance when setting the related action or when
2307
2353
  * the action changes appearance.
2308
2354
  * @returns whether `activatable` uses its actions appearance.
2355
+ * @since 2.16
2356
+ * @deprecated since 3.10
2309
2357
  */
2310
2358
  get_use_action_appearance(): boolean;
2311
2359
 
@@ -2315,6 +2363,8 @@ export namespace GcrUi {
2315
2363
  * > {@link Gtk.Activatable} implementors need to handle the {@link Gtk.Activatable.related_action}
2316
2364
  * > property and call `gtk_activatable_do_set_related_action()` when it changes.
2317
2365
  * @param action the {@link Gtk.Action} to set
2366
+ * @since 2.16
2367
+ * @deprecated since 3.10
2318
2368
  */
2319
2369
  set_related_action(action: Gtk.Action): void;
2320
2370
 
@@ -2327,6 +2377,8 @@ export namespace GcrUi {
2327
2377
  * > `gtk_activatable_sync_action_properties()` to update `activatable`
2328
2378
  * > if needed.
2329
2379
  * @param use_appearance whether to use the actions appearance
2380
+ * @since 2.16
2381
+ * @deprecated since 3.10
2330
2382
  */
2331
2383
  set_use_action_appearance(use_appearance: boolean): void;
2332
2384
 
@@ -2336,6 +2388,8 @@ export namespace GcrUi {
2336
2388
  * or unset and by the implementing class when
2337
2389
  * {@link Gtk.Activatable.use_action_appearance} changes.
2338
2390
  * @param action the related {@link Gtk.Action} or `null`
2391
+ * @since 2.16
2392
+ * @deprecated since 3.10
2339
2393
  */
2340
2394
  sync_action_properties(action: Gtk.Action | null): void;
2341
2395
 
@@ -2345,6 +2399,8 @@ export namespace GcrUi {
2345
2399
  * or unset and by the implementing class when
2346
2400
  * {@link Gtk.Activatable.use_action_appearance} changes.
2347
2401
  * @param action the related {@link Gtk.Action} or `null`
2402
+ * @since 2.16
2403
+ * @deprecated since 3.10
2348
2404
  * @virtual
2349
2405
  */
2350
2406
  vfunc_sync_action_properties(action: Gtk.Action | null): void;
@@ -2381,6 +2437,7 @@ export namespace GcrUi {
2381
2437
  * Returns whether the widget should grab focus when it is clicked with the mouse.
2382
2438
  * See `gtk_widget_set_focus_on_click()`.
2383
2439
  * @returns `true` if the widget should grab focus when it is clicked with the mouse.
2440
+ * @since 3.20
2384
2441
  */
2385
2442
  get_focus_on_click(): boolean;
2386
2443
 
@@ -2390,6 +2447,7 @@ export namespace GcrUi {
2390
2447
  * you don’t want the keyboard focus removed from the main area of the
2391
2448
  * application.
2392
2449
  * @param focus_on_click whether the widget should grab focus when clicked with the mouse
2450
+ * @since 3.20
2393
2451
  */
2394
2452
  set_focus_on_click(focus_on_click: boolean): void;
2395
2453
  }
@@ -2498,11 +2556,14 @@ export namespace GcrUi {
2498
2556
  render_view(viewer: Viewer): void;
2499
2557
 
2500
2558
  /**
2559
+ * signal emitted when data being rendered changes
2501
2560
  * @virtual
2502
2561
  */
2503
2562
  vfunc_data_changed(): void;
2504
2563
 
2505
2564
  /**
2565
+ * method invoked to populate a popup menu with additional
2566
+ * renderer options
2506
2567
  * @param viewer
2507
2568
  * @param menu
2508
2569
  * @virtual
@@ -2845,36 +2906,42 @@ export namespace GcrUi {
2845
2906
  * display overlayed graphics, like the overshoot indication,
2846
2907
  * at the right position.
2847
2908
  * @returns `true` if `border` has been set
2909
+ * @since 3.16
2848
2910
  */
2849
2911
  get_border(): [boolean, Gtk.Border];
2850
2912
 
2851
2913
  /**
2852
2914
  * Retrieves the {@link Gtk.Adjustment} used for horizontal scrolling.
2853
2915
  * @returns horizontal {@link Gtk.Adjustment}.
2916
+ * @since 3.0
2854
2917
  */
2855
2918
  get_hadjustment(): Gtk.Adjustment;
2856
2919
 
2857
2920
  /**
2858
2921
  * Gets the horizontal {@link Gtk.ScrollablePolicy}.
2859
2922
  * @returns The horizontal {@link Gtk.ScrollablePolicy}.
2923
+ * @since 3.0
2860
2924
  */
2861
2925
  get_hscroll_policy(): Gtk.ScrollablePolicy;
2862
2926
 
2863
2927
  /**
2864
2928
  * Retrieves the {@link Gtk.Adjustment} used for vertical scrolling.
2865
2929
  * @returns vertical {@link Gtk.Adjustment}.
2930
+ * @since 3.0
2866
2931
  */
2867
2932
  get_vadjustment(): Gtk.Adjustment;
2868
2933
 
2869
2934
  /**
2870
2935
  * Gets the vertical {@link Gtk.ScrollablePolicy}.
2871
2936
  * @returns The vertical {@link Gtk.ScrollablePolicy}.
2937
+ * @since 3.0
2872
2938
  */
2873
2939
  get_vscroll_policy(): Gtk.ScrollablePolicy;
2874
2940
 
2875
2941
  /**
2876
2942
  * Sets the horizontal adjustment of the {@link Gtk.Scrollable}.
2877
2943
  * @param hadjustment a {@link Gtk.Adjustment}
2944
+ * @since 3.0
2878
2945
  */
2879
2946
  set_hadjustment(hadjustment: Gtk.Adjustment | null): void;
2880
2947
 
@@ -2883,12 +2950,14 @@ export namespace GcrUi {
2883
2950
  * horizontal scrolling should start below the minimum width or
2884
2951
  * below the natural width.
2885
2952
  * @param policy the horizontal {@link Gtk.ScrollablePolicy}
2953
+ * @since 3.0
2886
2954
  */
2887
2955
  set_hscroll_policy(policy: Gtk.ScrollablePolicy): void;
2888
2956
 
2889
2957
  /**
2890
2958
  * Sets the vertical adjustment of the {@link Gtk.Scrollable}.
2891
2959
  * @param vadjustment a {@link Gtk.Adjustment}
2960
+ * @since 3.0
2892
2961
  */
2893
2962
  set_vadjustment(vadjustment: Gtk.Adjustment | null): void;
2894
2963
 
@@ -2897,6 +2966,7 @@ export namespace GcrUi {
2897
2966
  * vertical scrolling should start below the minimum height or
2898
2967
  * below the natural height.
2899
2968
  * @param policy the vertical {@link Gtk.ScrollablePolicy}
2969
+ * @since 3.0
2900
2970
  */
2901
2971
  set_vscroll_policy(policy: Gtk.ScrollablePolicy): void;
2902
2972
 
@@ -2906,6 +2976,7 @@ export namespace GcrUi {
2906
2976
  * be treeview headers. GTK+ can use this information to
2907
2977
  * display overlayed graphics, like the overshoot indication,
2908
2978
  * at the right position.
2979
+ * @since 3.16
2909
2980
  * @virtual
2910
2981
  */
2911
2982
  vfunc_get_border(): [boolean, Gtk.Border];
@@ -3033,48 +3104,56 @@ export namespace GcrUi {
3033
3104
  /**
3034
3105
  * Whether the choice check box is visible or not.
3035
3106
  * @read-only
3107
+ * @default false
3036
3108
  */
3037
3109
  get choice_visible(): boolean;
3038
3110
 
3039
3111
  /**
3040
3112
  * Whether the choice check box is visible or not.
3041
3113
  * @read-only
3114
+ * @default false
3042
3115
  */
3043
3116
  get choiceVisible(): boolean;
3044
3117
 
3045
3118
  /**
3046
3119
  * Whether the password confirm entry is visible or not.
3047
3120
  * @read-only
3121
+ * @default false
3048
3122
  */
3049
3123
  get confirm_visible(): boolean;
3050
3124
 
3051
3125
  /**
3052
3126
  * Whether the password confirm entry is visible or not.
3053
3127
  * @read-only
3128
+ * @default false
3054
3129
  */
3055
3130
  get confirmVisible(): boolean;
3056
3131
 
3057
3132
  /**
3058
3133
  * Whether the password entry is visible or not.
3059
3134
  * @read-only
3135
+ * @default false
3060
3136
  */
3061
3137
  get password_visible(): boolean;
3062
3138
 
3063
3139
  /**
3064
3140
  * Whether the password entry is visible or not.
3065
3141
  * @read-only
3142
+ * @default false
3066
3143
  */
3067
3144
  get passwordVisible(): boolean;
3068
3145
 
3069
3146
  /**
3070
3147
  * Whether the warning label is visible or not.
3071
3148
  * @read-only
3149
+ * @default false
3072
3150
  */
3073
3151
  get warning_visible(): boolean;
3074
3152
 
3075
3153
  /**
3076
3154
  * Whether the warning label is visible or not.
3077
3155
  * @read-only
3156
+ * @default false
3078
3157
  */
3079
3158
  get warningVisible(): boolean;
3080
3159
 
@@ -4018,36 +4097,42 @@ export namespace GcrUi {
4018
4097
  * display overlayed graphics, like the overshoot indication,
4019
4098
  * at the right position.
4020
4099
  * @returns `true` if `border` has been set
4100
+ * @since 3.16
4021
4101
  */
4022
4102
  get_border(): [boolean, Gtk.Border];
4023
4103
 
4024
4104
  /**
4025
4105
  * Retrieves the {@link Gtk.Adjustment} used for horizontal scrolling.
4026
4106
  * @returns horizontal {@link Gtk.Adjustment}.
4107
+ * @since 3.0
4027
4108
  */
4028
4109
  get_hadjustment(): Gtk.Adjustment;
4029
4110
 
4030
4111
  /**
4031
4112
  * Gets the horizontal {@link Gtk.ScrollablePolicy}.
4032
4113
  * @returns The horizontal {@link Gtk.ScrollablePolicy}.
4114
+ * @since 3.0
4033
4115
  */
4034
4116
  get_hscroll_policy(): Gtk.ScrollablePolicy;
4035
4117
 
4036
4118
  /**
4037
4119
  * Retrieves the {@link Gtk.Adjustment} used for vertical scrolling.
4038
4120
  * @returns vertical {@link Gtk.Adjustment}.
4121
+ * @since 3.0
4039
4122
  */
4040
4123
  get_vadjustment(): Gtk.Adjustment;
4041
4124
 
4042
4125
  /**
4043
4126
  * Gets the vertical {@link Gtk.ScrollablePolicy}.
4044
4127
  * @returns The vertical {@link Gtk.ScrollablePolicy}.
4128
+ * @since 3.0
4045
4129
  */
4046
4130
  get_vscroll_policy(): Gtk.ScrollablePolicy;
4047
4131
 
4048
4132
  /**
4049
4133
  * Sets the horizontal adjustment of the {@link Gtk.Scrollable}.
4050
4134
  * @param hadjustment a {@link Gtk.Adjustment}
4135
+ * @since 3.0
4051
4136
  */
4052
4137
  set_hadjustment(hadjustment: Gtk.Adjustment | null): void;
4053
4138
 
@@ -4056,12 +4141,14 @@ export namespace GcrUi {
4056
4141
  * horizontal scrolling should start below the minimum width or
4057
4142
  * below the natural width.
4058
4143
  * @param policy the horizontal {@link Gtk.ScrollablePolicy}
4144
+ * @since 3.0
4059
4145
  */
4060
4146
  set_hscroll_policy(policy: Gtk.ScrollablePolicy): void;
4061
4147
 
4062
4148
  /**
4063
4149
  * Sets the vertical adjustment of the {@link Gtk.Scrollable}.
4064
4150
  * @param vadjustment a {@link Gtk.Adjustment}
4151
+ * @since 3.0
4065
4152
  */
4066
4153
  set_vadjustment(vadjustment: Gtk.Adjustment | null): void;
4067
4154
 
@@ -4070,6 +4157,7 @@ export namespace GcrUi {
4070
4157
  * vertical scrolling should start below the minimum height or
4071
4158
  * below the natural height.
4072
4159
  * @param policy the vertical {@link Gtk.ScrollablePolicy}
4160
+ * @since 3.0
4073
4161
  */
4074
4162
  set_vscroll_policy(policy: Gtk.ScrollablePolicy): void;
4075
4163
 
@@ -4079,6 +4167,7 @@ export namespace GcrUi {
4079
4167
  * be treeview headers. GTK+ can use this information to
4080
4168
  * display overlayed graphics, like the overshoot indication,
4081
4169
  * at the right position.
4170
+ * @since 3.16
4082
4171
  * @virtual
4083
4172
  */
4084
4173
  vfunc_get_border(): [boolean, Gtk.Border];
@@ -4156,9 +4245,15 @@ export namespace GcrUi {
4156
4245
  static $gtype: GObject.GType<UnlockOptionsWidget>;
4157
4246
 
4158
4247
  // Properties
4248
+ /**
4249
+ * @default null
4250
+ */
4159
4251
  get choice(): string;
4160
4252
  set choice(val: string);
4161
4253
 
4254
+ /**
4255
+ * @default 0
4256
+ */
4162
4257
  get ttl(): number;
4163
4258
  set ttl(val: number);
4164
4259
 
@@ -4349,6 +4444,7 @@ export namespace GcrUi {
4349
4444
  *
4350
4445
  * Used as a hint when displaying a title for the data, but may be
4351
4446
  * overridden by the parsed data.
4447
+ * @default null
4352
4448
  */
4353
4449
  get display_name(): string;
4354
4450
  set display_name(val: string);
@@ -4359,6 +4455,7 @@ export namespace GcrUi {
4359
4455
  *
4360
4456
  * Used as a hint when displaying a title for the data, but may be
4361
4457
  * overridden by the parsed data.
4458
+ * @default null
4362
4459
  */
4363
4460
  get displayName(): string;
4364
4461
  set displayName(val: string);
@@ -4484,12 +4581,14 @@ export namespace GcrUi {
4484
4581
  /**
4485
4582
  * Retrieves the orientation of the `orientable`.
4486
4583
  * @returns the orientation of the `orientable`.
4584
+ * @since 2.16
4487
4585
  */
4488
4586
  get_orientation(): Gtk.Orientation;
4489
4587
 
4490
4588
  /**
4491
4589
  * Sets the orientation of the `orientable`.
4492
4590
  * @param orientation the orientable’s new orientation.
4591
+ * @since 2.16
4493
4592
  */
4494
4593
  set_orientation(orientation: Gtk.Orientation): void;
4495
4594
  }
@@ -4688,11 +4787,14 @@ export namespace GcrUi {
4688
4787
 
4689
4788
  // Virtual methods
4690
4789
  /**
4790
+ * signal emitted when data being rendered changes
4691
4791
  * @virtual
4692
4792
  */
4693
4793
  vfunc_data_changed(): void;
4694
4794
 
4695
4795
  /**
4796
+ * method invoked to populate a popup menu with additional
4797
+ * renderer options
4696
4798
  * @param viewer
4697
4799
  * @param menu
4698
4800
  * @virtual
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/gcrui-3",
3
- "version": "4.2.0",
3
+ "version": "4.4.0",
4
4
  "description": "GJS TypeScript type definitions for GcrUi-3",
5
5
  "type": "module",
6
6
  "module": "gcrui-3.js",
@@ -36,22 +36,22 @@
36
36
  "test": "tsc --project tsconfig.json"
37
37
  },
38
38
  "dependencies": {
39
- "@girs/gjs": "^4.2.0",
40
- "@girs/gtk-3.0": "^4.2.0",
41
- "@girs/xlib-2.0": "^4.2.0",
42
- "@girs/gdk-3.0": "^4.2.0",
43
- "@girs/cairo-1.0": "^4.2.0",
44
- "@girs/gobject-2.0": "^4.2.0",
45
- "@girs/glib-2.0": "^4.2.0",
46
- "@girs/pango-1.0": "^4.2.0",
47
- "@girs/harfbuzz-0.0": "^4.2.0",
48
- "@girs/freetype2-2.0": "^4.2.0",
49
- "@girs/gio-2.0": "^4.2.0",
50
- "@girs/gmodule-2.0": "^4.2.0",
51
- "@girs/gdkpixbuf-2.0": "^4.2.0",
52
- "@girs/atk-1.0": "^4.2.0",
53
- "@girs/gcr-3": "^4.2.0",
54
- "@girs/gck-1": "^4.2.0" },
39
+ "@girs/gjs": "^4.4.0",
40
+ "@girs/gtk-3.0": "^4.4.0",
41
+ "@girs/xlib-2.0": "^4.4.0",
42
+ "@girs/gdk-3.0": "^4.4.0",
43
+ "@girs/cairo-1.0": "^4.4.0",
44
+ "@girs/gobject-2.0": "^4.4.0",
45
+ "@girs/glib-2.0": "^4.4.0",
46
+ "@girs/pango-1.0": "^4.4.0",
47
+ "@girs/harfbuzz-0.0": "^4.4.0",
48
+ "@girs/freetype2-2.0": "^4.4.0",
49
+ "@girs/gio-2.0": "^4.4.0",
50
+ "@girs/gmodule-2.0": "^4.4.0",
51
+ "@girs/gdkpixbuf-2.0": "^4.4.0",
52
+ "@girs/atk-1.0": "^4.4.0",
53
+ "@girs/gcr-3": "^4.4.0",
54
+ "@girs/gck-1": "^4.4.0" },
55
55
  "devDependencies": {
56
56
  "typescript": "*"
57
57
  },