@girs/gdl-3 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/gdl-3)
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/gdl-3)
6
6
 
7
- GJS TypeScript type definitions for Gdl-3 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v5.1.0.
7
+ GJS TypeScript type definitions for Gdl-3 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.
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * GENERATED — do not edit. Provenance: Gdl-3 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object Atk.ImplementorIface — prop(s) no TypeScript value satisfies: Gdl.DockObject.pixbuf-icon
5
5
  *
6
- * 12 concrete widgets, 12 declarations, 3 enum nick unions, 4 slot candidates.
6
+ * 15 instantiable GTypes (of which 12 concrete widgets), 15 declarations, 3 enum nick unions, 4 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
@@ -128,6 +128,28 @@ export interface GdlDockItemGripProps extends GtkContainerProps, GtkBuildablePro
128
128
  /** Settable only at construction — a renderer must REBUILD, not patch. */
129
129
  export type GdlDockItemGripConstructOnly = GtkContainerConstructOnly | GtkBuildableConstructOnly | 'item';
130
130
 
131
+ /** The GdlDockLayout struct contains only private fields and should not be directly accessed. */
132
+ export interface GdlDockLayoutProps {
133
+ master?: GObject.Object;
134
+ }
135
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
136
+ export type GdlDockLayoutConstructOnly = never;
137
+
138
+ export interface GdlDockMasterProps {
139
+ /** @default NULL */
140
+ 'default-title'?: string;
141
+ /** @default 0 */
142
+ locked?: number;
143
+ /** @default GDL_SWITCHER_STYLE_BOTH */
144
+ 'switcher-style'?: GdlSwitcherStyleNick | Gdl.SwitcherStyle;
145
+ /** @default GTK_POS_BOTTOM */
146
+ 'tab-pos'?: GtkPositionTypeNick | Gtk.PositionType;
147
+ /** @default FALSE */
148
+ 'tab-reorderable'?: boolean;
149
+ }
150
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
151
+ export type GdlDockMasterConstructOnly = never;
152
+
131
153
  export interface GdlDockNotebookProps extends GdlDockItemProps, GtkBuildableProps {
132
154
  /** @default -1 */
133
155
  page?: number;
@@ -169,6 +191,11 @@ export interface GdlDockPanedProps extends GdlDockItemProps, GtkBuildableProps {
169
191
  /** Settable only at construction — a renderer must REBUILD, not patch. */
170
192
  export type GdlDockPanedConstructOnly = GdlDockItemConstructOnly | GtkBuildableConstructOnly;
171
193
 
194
+ export interface GdlDockParamProps {
195
+ }
196
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
197
+ export type GdlDockParamConstructOnly = never;
198
+
172
199
  export interface GdlDockPlaceholderProps extends GdlDockObjectProps, GtkBuildableProps {
173
200
  /** @default FALSE */
174
201
  floating?: boolean;
@@ -320,7 +347,11 @@ export interface Widgets {
320
347
  };
321
348
  }
322
349
 
323
- /** Every GType this namespace can create. A consumer derives its own tag map. */
350
+ /**
351
+ * Every GType this namespace can create AND put on screen. A consumer derives its own
352
+ * tag map. For everything a UI file can instantiate — layout managers, event
353
+ * controllers, cell renderers, `GtkSizeGroup` — read `DECLS` below.
354
+ */
324
355
  export type WidgetGType = keyof Widgets;
325
356
 
326
357
  // ---------------------------------------------------------------------------
@@ -372,7 +403,14 @@ export const PROVENANCE: {
372
403
  readonly childHolders: number;
373
404
  readonly droppedBases: readonly string[];
374
405
  readonly inlinedBases: readonly string[];
406
+ /** `<decl>.<prop>` for every property printed `never` because TypeScript has no value for it. */
375
407
  readonly unsettableProps: readonly string[];
408
+ /**
409
+ * `<decl>.<prop>: <Ns>.<Name>` for every property printed `never` because the model
410
+ * could not resolve its type across a namespace boundary — two independently released
411
+ * GIRs disagreeing, which is what the main emitter answers `never` for as well.
412
+ */
413
+ readonly unresolvedProps: readonly string[];
376
414
  };
377
415
 
378
416
  /** Declaration GType -> its own settable properties, as GObject registered them. */
@@ -386,7 +424,17 @@ export const OWN_PROPS: Readonly<Record<string, readonly string[]>>;
386
424
  */
387
425
  export const OWN_SIGNALS: Readonly<Record<string, readonly string[]>>;
388
426
 
389
- /** Widget GType -> every declaration its members come from, self first. */
427
+ /**
428
+ * Instantiable GType -> every declaration its members come from, self first.
429
+ *
430
+ * The key set is what a UI description file can NAME: every registered, non-abstract
431
+ * class this namespace declares. GtkBuilder resolves a `<object class="…">` through
432
+ * `g_type_from_name`, which knows nothing about widgets, so this is wider than
433
+ * `Widgets` by design — `GtkSizeGroup`, `GtkTextTag`, every `GtkEventController`
434
+ * and every `GtkCellRenderer` are here and are not widgets.
435
+ *
436
+ * `Widgets` and `CHILD_HOLDERS` are the narrower questions and answer them unchanged.
437
+ */
390
438
  export const DECLS: Readonly<Record<string, readonly string[]>>;
391
439
 
392
440
  /** The GTypes in `DECLS` that hold a widget without being one — see `ChildHolders`. */
@@ -398,8 +446,8 @@ export const ENUM_NICKS: Readonly<Record<string, readonly string[]>>;
398
446
  /**
399
447
  * `<enum GType>.<nick>` -> the integer GObject registers for it, from GIR's `value`.
400
448
  *
401
- * Position in `ENUM_NICKS` is NOT this number. Counting is wrong on 6 of the 129 enums a
402
- * GTK 4 vocabulary carries -- 104 in Gtk-4.0 and 25 in Adw-1: `GtkResponseType` runs -1 to -11, `GtkTextWindowType` starts
449
+ * Position in `ENUM_NICKS` is NOT this number. Counting is wrong on 6 of the 137 enums a
450
+ * GTK 4 vocabulary carries -- 112 in Gtk-4.0 and 25 in Adw-1: `GtkResponseType` runs -1 to -11, `GtkTextWindowType` starts
403
451
  * at 1, `GtkOrdering` and `GtkConstraintRelation` are -1/0/1, `GtkAlign` has two names
404
452
  * on one value, and `GtkConstraintStrength.required` is 1001001000 where counting says 0.
405
453
  *
@@ -437,10 +485,11 @@ export const ENUM_VALUES_UNREADABLE: Readonly<Record<string, string>>;
437
485
  *
438
486
  * `ENUM_NICKS` carries no bitfield, because GObject cannot resolve a nick SET; that says
439
487
  * nothing about a single member's number, and the number is what a host without GI needs.
440
- * 21 writable widget properties in Gtk-4.0 and Adw-1 are bitfield-typed and are declared
441
- * bare `number` -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`, `AdwTabView:shortcuts`
442
- * among them. Counting is worst here: 95 of 121 Gtk-4.0 bitfield members disagree with their
443
- * position, against 29 of 685 enumeration members.
488
+ * 23 settable properties in Gtk-4.0 and Adw-1 are bitfield-typed and are declared bare
489
+ * `number` -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`, `AdwTabView:shortcuts`,
490
+ * `GtkDropTarget:actions` among them. Counting is worst here: 119 of the 156 Gtk-4.0
491
+ * bitfield members this vocabulary carries disagree with their declaration position,
492
+ * against 29 of 672 enumeration members.
444
493
  *
445
494
  * Combine with `|` as GObject does. There is no nick table to pair this with, so a name
446
495
  * here is resolvable and a SET still is not.
@@ -464,7 +513,7 @@ export const FLAG_VALUES_UNREADABLE: Readonly<Record<string, string>>;
464
513
  *
465
514
  * The GType named here is not always one THIS module gives numbers for. A nick vocabulary is
466
515
  * emitted once, by the namespace that owns the enum, so `AdwComboRow.search-match-mode` names
467
- * `GtkStringFilterMatchMode` and its rows are in `@girs/gtk-4.0/vocabulary` — 57 of the 438
516
+ * `GtkStringFilterMatchMode` and its rows are in `@girs/gtk-4.0/vocabulary` — 83 of the 909
468
517
  * entries in a full run resolve only with the owner's vocabulary loaded beside this one. An
469
518
  * owner with no vocabulary of its own (Gdk, Pango) is inlined here instead, so every entry
470
519
  * resolves against SOME module.
@@ -14,6 +14,7 @@ export const PROVENANCE = {
14
14
  droppedBases: ['GObject.InitiallyUnowned', 'GObject.Object', 'Atk.ImplementorIface'],
15
15
  inlinedBases: [],
16
16
  unsettableProps: ['Gdl.DockObject.pixbuf-icon'],
17
+ unresolvedProps: [],
17
18
  };
18
19
 
19
20
  export const OWN_PROPS = {
@@ -21,6 +22,8 @@ export const OWN_PROPS = {
21
22
  GdlDockBar: ['dockbar-style', 'master'],
22
23
  GdlDockItem: ['behavior', 'closed', 'iconified', 'locked', 'orientation', 'preferred-height', 'preferred-width', 'resize'],
23
24
  GdlDockItemGrip: ['item'],
25
+ GdlDockLayout: ['master'],
26
+ GdlDockMaster: ['default-title', 'locked', 'switcher-style', 'tab-pos', 'tab-reorderable'],
24
27
  GdlDockNotebook: ['page'],
25
28
  GdlDockObject: ['long-name', 'master', 'name', 'pixbuf-icon', 'stock-id'],
26
29
  GdlDockPaned: ['position'],
@@ -32,29 +35,41 @@ export const OWN_PROPS = {
32
35
  export const OWN_SIGNALS = {
33
36
  GdlDock: ['layout-changed'],
34
37
  GdlDockItem: ['deselected', 'dock-drag-begin', 'dock-drag-end', 'dock-drag-motion', 'move-focus-child', 'selected'],
38
+ GdlDockMaster: ['layout-changed'],
35
39
  GdlDockObject: ['detach', 'dock'],
36
40
  GdlDockTablabel: ['button-pressed-handle'],
37
41
  };
38
42
 
43
+ // Every GType this namespace can INSTANTIATE -> the declarations its members come from.
44
+ //
45
+ // The key set is what a UI description file can name: a registered, non-abstract class.
46
+ // Not "every widget" — GtkBuilder resolves a name through `g_type_from_name`, which knows
47
+ // nothing about widgets, and a `.ui` file is full of `GtkSizeGroup`, `GtkTextTag`,
48
+ // `GtkEventController*` and `GtkCellRenderer*`. Use `Widgets` and `CHILD_HOLDERS`
49
+ // below for the narrower questions; they did not move.
39
50
  export const DECLS = {
40
51
  GdlDock: ['GdlDock', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
41
52
  GdlDockBar: ['GdlDockBar', 'GtkBox', 'GtkContainer', 'GtkWidget', 'GtkBuildable', 'GtkOrientable'],
42
53
  GdlDockItem: ['GdlDockItem', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
43
54
  GdlDockItemButtonImage: ['GdlDockItemButtonImage', 'GtkWidget', 'GtkBuildable'],
44
55
  GdlDockItemGrip: ['GdlDockItemGrip', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
56
+ GdlDockLayout: ['GdlDockLayout'],
57
+ GdlDockMaster: ['GdlDockMaster'],
45
58
  GdlDockNotebook: ['GdlDockNotebook', 'GdlDockItem', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
46
59
  GdlDockObject: ['GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
47
60
  GdlDockPaned: ['GdlDockPaned', 'GdlDockItem', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
61
+ GdlDockParam: ['GdlDockParam'],
48
62
  GdlDockPlaceholder: ['GdlDockPlaceholder', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
49
63
  GdlDockTablabel: ['GdlDockTablabel', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
50
64
  GdlPreviewWindow: ['GdlPreviewWindow', 'GtkWindow', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
51
65
  GdlSwitcher: ['GdlSwitcher', 'GtkNotebook', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
52
66
  };
53
67
 
54
- // The GTypes above that are NOT widgets: they hold one through `set_child`/`get_child`
55
- // and descend from `GObject.Object`. A renderer places them like a container; a check
56
- // asking "is this a widget" must not count them. Derived from the accessor pair, never
57
- // from a list the count is in the provenance line above.
68
+ // The GTypes above that ARE widgets are the `Widgets` map in the sibling `.d.ts`; these
69
+ // are the ones that merely HOLD one, through `set_child`/`get_child`, descending from
70
+ // `GObject.Object`. A renderer places them like a container; a check asking "is this a
71
+ // widget" must not count them. Derived from the accessor pair, never from a list — the
72
+ // count is in the provenance line above.
58
73
  export const CHILD_HOLDERS = [];
59
74
 
60
75
  export const ENUM_NICKS = {
@@ -68,7 +83,7 @@ export const ENUM_NICKS = {
68
83
  // It ships because position in `ENUM_NICKS` is not the value and a consumer with no
69
84
  // typelib has no other way to learn it: a surface without GI still has to hand GObject an
70
85
  // integer. The alternative a consumer reaches for first is counting, and counting is wrong
71
- // on 6 of the 129 enums a GTK 4 vocabulary carries (104 in Gtk-4.0, 25 in Adw-1) --
86
+ // on 6 of the 137 enums a GTK 4 vocabulary carries (112 in Gtk-4.0, 25 in Adw-1) --
72
87
  // `GtkResponseType` runs -1 down to
73
88
  // -11, `GtkTextWindowType` starts at 1, and `GtkConstraintStrength.required` is
74
89
  // 1001001000 where counting answers 0.
@@ -123,11 +138,12 @@ export const ENUM_VALUES_UNREADABLE = {};
123
138
  // The number behind each member of a registered BITFIELD, keyed the same way.
124
139
  //
125
140
  // `ENUM_NICKS` refuses a bitfield because GObject cannot resolve a nick SET, and that
126
- // reason says nothing about one member's number. 21 writable widget properties in Gtk-4.0
127
- // and Adw-1 are bitfield-typed -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`,
128
- // `AdwTabView:shortcuts`, ... -- and they are typed bare `number`, so a host without GI
129
- // has nothing to compute one from. Counting is worst exactly here: 95 of 121 Gtk-4.0
130
- // bitfield members disagree with their position, against 29 of 685 enumeration members.
141
+ // reason says nothing about one member's number. 23 settable properties in Gtk-4.0 and
142
+ // Adw-1 are bitfield-typed -- `GtkEntry:input-hints`, `GtkPopoverMenu:flags`,
143
+ // `AdwTabView:shortcuts`, `GtkDropTarget:actions`, ... -- and they are typed bare
144
+ // `number`, so a host without GI has nothing to compute one from. Counting is worst
145
+ // exactly here: 119 of the 156 Gtk-4.0 bitfield members this vocabulary carries disagree
146
+ // with their declaration position, against 29 of 672 enumeration members.
131
147
  //
132
148
  // A table of its own rather than more rows in `ENUM_VALUES`, so that "every nick in
133
149
  // `ENUM_NICKS` has a number or a declared reason" stays a claim about one set.
@@ -174,12 +190,14 @@ export const FLAG_VALUES_UNREADABLE = {};
174
190
  // one are both entries a consumer would resolve wrongly, so neither is written.
175
191
  //
176
192
  // A GType named here has numbers in SOME vocabulary, not necessarily this one: the namespace
177
- // that OWNS an enum publishes it, so 57 of the 438 entries a full run emits want the owner's
193
+ // that OWNS an enum publishes it, so 83 of the 909 entries a full run emits want the owner's
178
194
  // vocabulary loaded too. Owners that emit none (Gdk, Pango) are inlined into the tables above.
179
195
  export const PROP_ENUMS = {
180
196
  'GdlDockBar.dockbar-style': 'GdlDockBarStyle',
181
197
  'GdlDockItem.behavior': 'GdlDockItemBehavior',
182
198
  'GdlDockItem.orientation': 'GtkOrientation',
199
+ 'GdlDockMaster.switcher-style': 'GdlSwitcherStyle',
200
+ 'GdlDockMaster.tab-pos': 'GtkPositionType',
183
201
  'GdlDockPlaceholder.next-placement': 'GdlDockPlacement',
184
202
  'GdlSwitcher.switcher-style': 'GdlSwitcherStyle',
185
203
  'GdlSwitcher.tab-pos': 'GtkPositionType',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/gdl-3",
3
- "version": "5.1.0",
3
+ "version": "5.2.0",
4
4
  "description": "GJS TypeScript type definitions for Gdl-3",
5
5
  "type": "module",
6
6
  "module": "gdl-3.js",
@@ -36,20 +36,20 @@
36
36
  "test": "tsc --project tsconfig.json"
37
37
  },
38
38
  "dependencies": {
39
- "@girs/gjs": "^5.1.0",
40
- "@girs/gtk-3.0": "^5.1.0",
41
- "@girs/xlib-2.0": "^5.1.0",
42
- "@girs/gdk-3.0": "^5.1.0",
43
- "@girs/cairo-1.0": "^5.1.0",
44
- "@girs/gobject-2.0": "^5.1.0",
45
- "@girs/glib-2.0": "^5.1.0",
46
- "@girs/pango-1.0": "^5.1.0",
47
- "@girs/harfbuzz-0.0": "^5.1.0",
48
- "@girs/freetype2-2.0": "^5.1.0",
49
- "@girs/gio-2.0": "^5.1.0",
50
- "@girs/gmodule-2.0": "^5.1.0",
51
- "@girs/gdkpixbuf-2.0": "^5.1.0",
52
- "@girs/atk-1.0": "^5.1.0" },
39
+ "@girs/gjs": "^5.2.0",
40
+ "@girs/gtk-3.0": "^5.2.0",
41
+ "@girs/xlib-2.0": "^5.2.0",
42
+ "@girs/gdk-3.0": "^5.2.0",
43
+ "@girs/cairo-1.0": "^5.2.0",
44
+ "@girs/gobject-2.0": "^5.2.0",
45
+ "@girs/glib-2.0": "^5.2.0",
46
+ "@girs/pango-1.0": "^5.2.0",
47
+ "@girs/harfbuzz-0.0": "^5.2.0",
48
+ "@girs/freetype2-2.0": "^5.2.0",
49
+ "@girs/gio-2.0": "^5.2.0",
50
+ "@girs/gmodule-2.0": "^5.2.0",
51
+ "@girs/gdkpixbuf-2.0": "^5.2.0",
52
+ "@girs/atk-1.0": "^5.2.0" },
53
53
  "devDependencies": {
54
54
  "typescript": "*"
55
55
  },