@girs/foundryadw-1 5.1.0 → 5.2.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
@@ -4,7 +4,7 @@
4
4
  ![version](https://img.shields.io/npm/v/@girs/foundryadw-1)
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/foundryadw-1)
6
6
 
7
- GJS TypeScript type definitions for FoundryAdw-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v5.1.0.
7
+ GJS TypeScript type definitions for FoundryAdw-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v5.2.0.
8
8
 
9
9
  This package contains type declarations only. It ships no runtime code, so it adds
10
10
  nothing to your program and works with any bundler or none at all.
@@ -1,9 +1,9 @@
1
1
  /**
2
2
  * The GIR-derived widget VOCABULARY for FoundryAdw-1.
3
3
  *
4
- * GENERATED — do not edit. Provenance: FoundryAdw-1 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object
4
+ * GENERATED — do not edit. Provenance: FoundryAdw-1 — dropped empty base(s): GObject.Object GObject.InitiallyUnowned
5
5
  *
6
- * 7 concrete widgets, 7 declarations, 1 enum nick unions, 12 slot candidates.
6
+ * 10 instantiable GTypes (of which 7 concrete widgets), 11 declarations, 1 enum nick unions, 12 slot candidates.
7
7
  *
8
8
  * Module-scoped exports only. There is no `JSX` namespace here, no tag spelling and
9
9
  * no `on<Signal>` prop name: those are DIALECT, and every framework answers them
@@ -54,6 +54,18 @@ export type GFileTypeNick = 'unknown' | 'regular' | 'directory' | 'symbolic-link
54
54
  // GIR keeps them once, on the interface.
55
55
  // ---------------------------------------------------------------------------
56
56
 
57
+ export interface FoundryDocumentationNavigatorProps extends FoundryPathNavigatorProps {
58
+ documentation?: Foundry.Documentation;
59
+ }
60
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
61
+ export type FoundryDocumentationNavigatorConstructOnly = FoundryPathNavigatorConstructOnly | 'documentation';
62
+
63
+ export interface FoundryFileNavigatorProps extends FoundryPathNavigatorProps {
64
+ file?: Gio.File;
65
+ }
66
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
67
+ export type FoundryFileNavigatorConstructOnly = FoundryPathNavigatorConstructOnly | 'file';
68
+
57
69
  /** An `AdwPreferencesRow` that allows typing or navigating to a file or directory path. */
58
70
  export interface FoundryFileRowProps extends AdwEntryRowProps, GtkAccessibleProps, GtkActionableProps, GtkBuildableProps, GtkConstraintTargetProps, GtkEditableProps {
59
71
  file?: Gio.File;
@@ -89,6 +101,11 @@ export interface FoundryPathBarProps extends GtkWidgetProps, GtkAccessibleProps,
89
101
  /** Settable only at construction — a renderer must REBUILD, not patch. */
90
102
  export type FoundryPathBarConstructOnly = GtkWidgetConstructOnly | GtkAccessibleConstructOnly | GtkBuildableConstructOnly | GtkConstraintTargetConstructOnly;
91
103
 
104
+ export interface FoundryPathNavigatorProps {
105
+ }
106
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
107
+ export type FoundryPathNavigatorConstructOnly = never;
108
+
92
109
  export interface FoundrySearchDialogProps extends AdwDialogProps, GtkAccessibleProps, GtkBuildableProps, GtkConstraintTargetProps, GtkShortcutManagerProps {
93
110
  context?: Foundry.Context;
94
111
  /** @default NULL */
@@ -97,6 +114,12 @@ export interface FoundrySearchDialogProps extends AdwDialogProps, GtkAccessibleP
97
114
  /** Settable only at construction — a renderer must REBUILD, not patch. */
98
115
  export type FoundrySearchDialogConstructOnly = AdwDialogConstructOnly | GtkAccessibleConstructOnly | GtkBuildableConstructOnly | GtkConstraintTargetConstructOnly | GtkShortcutManagerConstructOnly;
99
116
 
117
+ export interface FoundrySymbolNavigatorProps extends FoundryPathNavigatorProps {
118
+ symbol?: Foundry.Symbol;
119
+ }
120
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
121
+ export type FoundrySymbolNavigatorConstructOnly = FoundryPathNavigatorConstructOnly | 'symbol';
122
+
100
123
  export interface FoundryTreeExpanderProps extends GtkWidgetProps, GtkAccessibleProps, GtkBuildableProps, GtkConstraintTargetProps {
101
124
  /**
102
125
  * Whether clicking on the expander should activate the row instead of expanding or collapsing it.
@@ -230,7 +253,11 @@ export interface Widgets {
230
253
  };
231
254
  }
232
255
 
233
- /** Every GType this namespace can create. A consumer derives its own tag map. */
256
+ /**
257
+ * Every GType this namespace can create AND put on screen. A consumer derives its own
258
+ * tag map. For everything a UI file can instantiate — layout managers, event
259
+ * controllers, cell renderers, `GtkSizeGroup` — read `DECLS` below.
260
+ */
234
261
  export type WidgetGType = keyof Widgets;
235
262
 
236
263
  // ---------------------------------------------------------------------------
@@ -282,7 +309,14 @@ export const PROVENANCE: {
282
309
  readonly childHolders: number;
283
310
  readonly droppedBases: readonly string[];
284
311
  readonly inlinedBases: readonly string[];
312
+ /** `<decl>.<prop>` for every property printed `never` because TypeScript has no value for it. */
285
313
  readonly unsettableProps: readonly string[];
314
+ /**
315
+ * `<decl>.<prop>: <Ns>.<Name>` for every property printed `never` because the model
316
+ * could not resolve its type across a namespace boundary — two independently released
317
+ * GIRs disagreeing, which is what the main emitter answers `never` for as well.
318
+ */
319
+ readonly unresolvedProps: readonly string[];
286
320
  };
287
321
 
288
322
  /** Declaration GType -> its own settable properties, as GObject registered them. */
@@ -296,7 +330,17 @@ export const OWN_PROPS: Readonly<Record<string, readonly string[]>>;
296
330
  */
297
331
  export const OWN_SIGNALS: Readonly<Record<string, readonly string[]>>;
298
332
 
299
- /** Widget GType -> every declaration its members come from, self first. */
333
+ /**
334
+ * Instantiable GType -> every declaration its members come from, self first.
335
+ *
336
+ * The key set is what a UI description file can NAME: every registered, non-abstract
337
+ * class this namespace declares. GtkBuilder resolves a `<object class="…">` through
338
+ * `g_type_from_name`, which knows nothing about widgets, so this is wider than
339
+ * `Widgets` by design — `GtkSizeGroup`, `GtkTextTag`, every `GtkEventController`
340
+ * and every `GtkCellRenderer` are here and are not widgets.
341
+ *
342
+ * `Widgets` and `CHILD_HOLDERS` are the narrower questions and answer them unchanged.
343
+ */
300
344
  export const DECLS: Readonly<Record<string, readonly string[]>>;
301
345
 
302
346
  /** The GTypes in `DECLS` that hold a widget without being one — see `ChildHolders`. */
@@ -308,8 +352,8 @@ export const ENUM_NICKS: Readonly<Record<string, readonly string[]>>;
308
352
  /**
309
353
  * `<enum GType>.<nick>` -> the integer GObject registers for it, from GIR's `value`.
310
354
  *
311
- * Position in `ENUM_NICKS` is NOT this number. Counting is wrong on 6 of the 129 enums a
312
- * GTK 4 vocabulary carries -- 104 in Gtk-4.0 and 25 in Adw-1: `GtkResponseType` runs -1 to -11, `GtkTextWindowType` starts
355
+ * Position in `ENUM_NICKS` is NOT this number. Counting is wrong on 6 of the 137 enums a
356
+ * GTK 4 vocabulary carries -- 112 in Gtk-4.0 and 25 in Adw-1: `GtkResponseType` runs -1 to -11, `GtkTextWindowType` starts
313
357
  * at 1, `GtkOrdering` and `GtkConstraintRelation` are -1/0/1, `GtkAlign` has two names
314
358
  * on one value, and `GtkConstraintStrength.required` is 1001001000 where counting says 0.
315
359
  *
@@ -347,10 +391,11 @@ export const ENUM_VALUES_UNREADABLE: Readonly<Record<string, string>>;
347
391
  *
348
392
  * `ENUM_NICKS` carries no bitfield, because GObject cannot resolve a nick SET; that says
349
393
  * nothing about a single member's number, and the number is what a host without GI needs.
350
- * 21 writable widget properties in Gtk-4.0 and Adw-1 are bitfield-typed and are declared
351
- * bare `number` -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`, `AdwTabView:shortcuts`
352
- * among them. Counting is worst here: 95 of 121 Gtk-4.0 bitfield members disagree with their
353
- * position, against 29 of 685 enumeration members.
394
+ * 23 settable properties in Gtk-4.0 and Adw-1 are bitfield-typed and are declared bare
395
+ * `number` -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`, `AdwTabView:shortcuts`,
396
+ * `GtkDropTarget:actions` among them. Counting is worst here: 119 of the 156 Gtk-4.0
397
+ * bitfield members this vocabulary carries disagree with their declaration position,
398
+ * against 29 of 672 enumeration members.
354
399
  *
355
400
  * Combine with `|` as GObject does. There is no nick table to pair this with, so a name
356
401
  * here is resolvable and a SET still is not.
@@ -374,7 +419,7 @@ export const FLAG_VALUES_UNREADABLE: Readonly<Record<string, string>>;
374
419
  *
375
420
  * The GType named here is not always one THIS module gives numbers for. A nick vocabulary is
376
421
  * emitted once, by the namespace that owns the enum, so `AdwComboRow.search-match-mode` names
377
- * `GtkStringFilterMatchMode` and its rows are in `@girs/gtk-4.0/vocabulary` — 57 of the 438
422
+ * `GtkStringFilterMatchMode` and its rows are in `@girs/gtk-4.0/vocabulary` — 83 of the 909
378
423
  * entries in a full run resolve only with the owner's vocabulary loaded beside this one. An
379
424
  * owner with no vocabulary of its own (Gdk, Pango) is inlined here instead, so every entry
380
425
  * resolves against SOME module.
@@ -1,6 +1,6 @@
1
1
  // The widget vocabulary of FoundryAdw-1 as runtime data.
2
2
  //
3
- // GENERATED — do not edit. Provenance: FoundryAdw-1 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object
3
+ // GENERATED — do not edit. Provenance: FoundryAdw-1 — dropped empty base(s): GObject.Object GObject.InitiallyUnowned
4
4
  //
5
5
  // The type half of this subpath is the sibling `.d.ts`. This file exists because
6
6
  // types are erased: a consumer that wants to ask the installed library whether every
@@ -11,17 +11,21 @@ export const PROVENANCE = {
11
11
  version: '1',
12
12
  libraryVersion: null,
13
13
  childHolders: 0,
14
- droppedBases: ['GObject.InitiallyUnowned', 'GObject.Object'],
14
+ droppedBases: ['GObject.Object', 'GObject.InitiallyUnowned'],
15
15
  inlinedBases: [],
16
16
  unsettableProps: [],
17
+ unresolvedProps: [],
17
18
  };
18
19
 
19
20
  export const OWN_PROPS = {
21
+ FoundryDocumentationNavigator: ['documentation'],
22
+ FoundryFileNavigator: ['file'],
20
23
  FoundryFileRow: ['file', 'file-type'],
21
24
  FoundryPage: ['auxiliary', 'content', 'needs-attention'],
22
25
  FoundryPanelBar: ['show-bottom', 'show-start', 'workspace'],
23
26
  FoundryPathBar: ['root', 'selected-item'],
24
27
  FoundrySearchDialog: ['context', 'search-text'],
28
+ FoundrySymbolNavigator: ['symbol'],
25
29
  FoundryTreeExpander: ['activate-on-click', 'expanded-icon', 'expanded-icon-name', 'expanded-paintable', 'icon', 'icon-name', 'ignored', 'list-row', 'menu-model', 'paintable', 'suffix', 'title', 'use-markup'],
26
30
  FoundryWorkspace: ['auxiliary-placeholder', 'collapsed-titlebar', 'context', 'primary-menu', 'show-auxiliary', 'show-sidebar', 'show-utilities', 'sidebar-titlebar', 'status-widget', 'titlebar'],
27
31
  };
@@ -31,20 +35,31 @@ export const OWN_SIGNALS = {
31
35
  FoundryTreeExpander: ['context-menu'],
32
36
  };
33
37
 
38
+ // Every GType this namespace can INSTANTIATE -> the declarations its members come from.
39
+ //
40
+ // The key set is what a UI description file can name: a registered, non-abstract class.
41
+ // Not "every widget" — GtkBuilder resolves a name through `g_type_from_name`, which knows
42
+ // nothing about widgets, and a `.ui` file is full of `GtkSizeGroup`, `GtkTextTag`,
43
+ // `GtkEventController*` and `GtkCellRenderer*`. Use `Widgets` and `CHILD_HOLDERS`
44
+ // below for the narrower questions; they did not move.
34
45
  export const DECLS = {
46
+ FoundryDocumentationNavigator: ['FoundryDocumentationNavigator', 'FoundryPathNavigator'],
47
+ FoundryFileNavigator: ['FoundryFileNavigator', 'FoundryPathNavigator'],
35
48
  FoundryFileRow: ['FoundryFileRow', 'AdwEntryRow', 'AdwPreferencesRow', 'GtkListBoxRow', 'GtkWidget', 'GtkAccessible', 'GtkActionable', 'GtkBuildable', 'GtkConstraintTarget', 'GtkEditable'],
36
49
  FoundryPage: ['FoundryPage', 'GtkWidget', 'GtkAccessible', 'GtkBuildable', 'GtkConstraintTarget'],
37
50
  FoundryPanelBar: ['FoundryPanelBar', 'GtkWidget', 'GtkAccessible', 'GtkBuildable', 'GtkConstraintTarget'],
38
51
  FoundryPathBar: ['FoundryPathBar', 'GtkWidget', 'GtkAccessible', 'GtkBuildable', 'GtkConstraintTarget'],
39
52
  FoundrySearchDialog: ['FoundrySearchDialog', 'AdwDialog', 'GtkWidget', 'GtkAccessible', 'GtkBuildable', 'GtkConstraintTarget', 'GtkShortcutManager'],
53
+ FoundrySymbolNavigator: ['FoundrySymbolNavigator', 'FoundryPathNavigator'],
40
54
  FoundryTreeExpander: ['FoundryTreeExpander', 'GtkWidget', 'GtkAccessible', 'GtkBuildable', 'GtkConstraintTarget'],
41
55
  FoundryWorkspace: ['FoundryWorkspace', 'GtkWidget', 'GtkAccessible', 'GtkBuildable', 'GtkConstraintTarget'],
42
56
  };
43
57
 
44
- // The GTypes above that are NOT widgets: they hold one through `set_child`/`get_child`
45
- // and descend from `GObject.Object`. A renderer places them like a container; a check
46
- // asking "is this a widget" must not count them. Derived from the accessor pair, never
47
- // from a list — the count is in the provenance line above.
58
+ // The GTypes above that ARE widgets are the `Widgets` map in the sibling `.d.ts`; these
59
+ // are the ones that merely HOLD one, through `set_child`/`get_child`, descending from
60
+ // `GObject.Object`. A renderer places them like a container; a check asking "is this a
61
+ // widget" must not count them. Derived from the accessor pair, never from a list — the
62
+ // count is in the provenance line above.
48
63
  export const CHILD_HOLDERS = [];
49
64
 
50
65
  export const ENUM_NICKS = {
@@ -56,7 +71,7 @@ export const ENUM_NICKS = {
56
71
  // It ships because position in `ENUM_NICKS` is not the value and a consumer with no
57
72
  // typelib has no other way to learn it: a surface without GI still has to hand GObject an
58
73
  // integer. The alternative a consumer reaches for first is counting, and counting is wrong
59
- // on 6 of the 129 enums a GTK 4 vocabulary carries (104 in Gtk-4.0, 25 in Adw-1) --
74
+ // on 6 of the 137 enums a GTK 4 vocabulary carries (112 in Gtk-4.0, 25 in Adw-1) --
60
75
  // `GtkResponseType` runs -1 down to
61
76
  // -11, `GtkTextWindowType` starts at 1, and `GtkConstraintStrength.required` is
62
77
  // 1001001000 where counting answers 0.
@@ -101,11 +116,12 @@ export const ENUM_VALUES_UNREADABLE = {};
101
116
  // The number behind each member of a registered BITFIELD, keyed the same way.
102
117
  //
103
118
  // `ENUM_NICKS` refuses a bitfield because GObject cannot resolve a nick SET, and that
104
- // reason says nothing about one member's number. 21 writable widget properties in Gtk-4.0
105
- // and Adw-1 are bitfield-typed -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`,
106
- // `AdwTabView:shortcuts`, ... -- and they are typed bare `number`, so a host without GI
107
- // has nothing to compute one from. Counting is worst exactly here: 95 of 121 Gtk-4.0
108
- // bitfield members disagree with their position, against 29 of 685 enumeration members.
119
+ // reason says nothing about one member's number. 23 settable properties in Gtk-4.0 and
120
+ // Adw-1 are bitfield-typed -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`,
121
+ // `AdwTabView:shortcuts`, `GtkDropTarget:actions`, ... -- and they are typed bare
122
+ // `number`, so a host without GI has nothing to compute one from. Counting is worst
123
+ // exactly here: 119 of the 156 Gtk-4.0 bitfield members this vocabulary carries disagree
124
+ // with their declaration position, against 29 of 672 enumeration members.
109
125
  //
110
126
  // A table of its own rather than more rows in `ENUM_VALUES`, so that "every nick in
111
127
  // `ENUM_NICKS` has a number or a declared reason" stays a claim about one set.
@@ -128,7 +144,7 @@ export const FLAG_VALUES_UNREADABLE = {};
128
144
  // one are both entries a consumer would resolve wrongly, so neither is written.
129
145
  //
130
146
  // A GType named here has numbers in SOME vocabulary, not necessarily this one: the namespace
131
- // that OWNS an enum publishes it, so 57 of the 438 entries a full run emits want the owner's
147
+ // that OWNS an enum publishes it, so 83 of the 909 entries a full run emits want the owner's
132
148
  // vocabulary loaded too. Owners that emit none (Gdk, Pango) are inlined into the tables above.
133
149
  export const PROP_ENUMS = {
134
150
  'FoundryFileRow.file-type': 'GFileType',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/foundryadw-1",
3
- "version": "5.1.0",
3
+ "version": "5.2.0",
4
4
  "description": "GJS TypeScript type definitions for FoundryAdw-1",
5
5
  "type": "module",
6
6
  "module": "foundryadw-1.js",
@@ -36,29 +36,29 @@
36
36
  "test": "tsc --project tsconfig.json"
37
37
  },
38
38
  "dependencies": {
39
- "@girs/gjs": "^5.1.0",
40
- "@girs/peas-2": "^5.1.0",
41
- "@girs/gio-2.0": "^5.1.0",
42
- "@girs/gobject-2.0": "^5.1.0",
43
- "@girs/glib-2.0": "^5.1.0",
44
- "@girs/gmodule-2.0": "^5.1.0",
45
- "@girs/gtk-4.0": "^5.1.0",
46
- "@girs/gsk-4.0": "^5.1.0",
47
- "@girs/graphene-1.0": "^5.1.0",
48
- "@girs/gdk-4.0": "^5.1.0",
49
- "@girs/cairo-1.0": "^5.1.0",
50
- "@girs/pangocairo-1.0": "^5.1.0",
51
- "@girs/pango-1.0": "^5.1.0",
52
- "@girs/harfbuzz-0.0": "^5.1.0",
53
- "@girs/freetype2-2.0": "^5.1.0",
54
- "@girs/gdkpixbuf-2.0": "^5.1.0",
55
- "@girs/foundrygtk-1": "^5.1.0",
56
- "@girs/json-1.0": "^5.1.0",
57
- "@girs/gtksource-5": "^5.1.0",
58
- "@girs/foundry-1": "^5.1.0",
59
- "@girs/dex-1": "^5.1.0",
60
- "@girs/giounix-2.0": "^5.1.0",
61
- "@girs/adw-1": "^5.1.0" },
39
+ "@girs/gjs": "^5.2.0",
40
+ "@girs/peas-2": "^5.2.0",
41
+ "@girs/gio-2.0": "^5.2.0",
42
+ "@girs/gobject-2.0": "^5.2.0",
43
+ "@girs/glib-2.0": "^5.2.0",
44
+ "@girs/gmodule-2.0": "^5.2.0",
45
+ "@girs/gtk-4.0": "^5.2.0",
46
+ "@girs/gsk-4.0": "^5.2.0",
47
+ "@girs/graphene-1.0": "^5.2.0",
48
+ "@girs/gdk-4.0": "^5.2.0",
49
+ "@girs/cairo-1.0": "^5.2.0",
50
+ "@girs/pangocairo-1.0": "^5.2.0",
51
+ "@girs/pango-1.0": "^5.2.0",
52
+ "@girs/harfbuzz-0.0": "^5.2.0",
53
+ "@girs/freetype2-2.0": "^5.2.0",
54
+ "@girs/gdkpixbuf-2.0": "^5.2.0",
55
+ "@girs/foundrygtk-1": "^5.2.0",
56
+ "@girs/json-1.0": "^5.2.0",
57
+ "@girs/gtksource-5": "^5.2.0",
58
+ "@girs/foundry-1": "^5.2.0",
59
+ "@girs/dex-1": "^5.2.0",
60
+ "@girs/giounix-2.0": "^5.2.0",
61
+ "@girs/adw-1": "^5.2.0" },
62
62
  "devDependencies": {
63
63
  "typescript": "*"
64
64
  },