@girs/gdl-3 5.2.0 → 5.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
@@ -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.2.0.
7
+ GJS TypeScript type definitions for Gdl-3 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v5.4.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,7 +1,7 @@
1
1
  /**
2
2
  * The GIR-derived widget VOCABULARY for Gdl-3.
3
3
  *
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
4
+ * GENERATED — do not edit. Provenance: Gdl-3 — dropped empty base(s): Atk.ImplementorIface — prop(s) no TypeScript value satisfies: Gdl.DockObject.pixbuf-icon
5
5
  *
6
6
  * 15 instantiable GTypes (of which 12 concrete widgets), 15 declarations, 3 enum nick unions, 4 slot candidates.
7
7
  *
@@ -27,6 +27,7 @@
27
27
  import type GObject from '@girs/gobject-2.0';
28
28
  import type Gdl from './gdl-3.js';
29
29
  import type Gtk from '@girs/gtk-3.0';
30
+ import type { GInitiallyUnownedConstructOnly, GInitiallyUnownedProps, GObjectConstructOnly, GObjectProps } from '@girs/gobject-2.0/vocabulary';
30
31
  import type { GtkBinConstructOnly, GtkBinProps, GtkBoxConstructOnly, GtkBoxProps, GtkBuildableConstructOnly, GtkBuildableProps, GtkContainerConstructOnly, GtkContainerProps, GtkNotebookConstructOnly, GtkNotebookProps, GtkOrientableConstructOnly, GtkOrientableProps, GtkOrientationNick, GtkPositionTypeNick, GtkWidgetConstructOnly, GtkWidgetProps, GtkWindowConstructOnly, GtkWindowProps } from '@girs/gtk-3.0/vocabulary';
31
32
 
32
33
  // ---------------------------------------------------------------------------
@@ -129,13 +130,13 @@ export interface GdlDockItemGripProps extends GtkContainerProps, GtkBuildablePro
129
130
  export type GdlDockItemGripConstructOnly = GtkContainerConstructOnly | GtkBuildableConstructOnly | 'item';
130
131
 
131
132
  /** The GdlDockLayout struct contains only private fields and should not be directly accessed. */
132
- export interface GdlDockLayoutProps {
133
+ export interface GdlDockLayoutProps extends GObjectProps {
133
134
  master?: GObject.Object;
134
135
  }
135
136
  /** Settable only at construction — a renderer must REBUILD, not patch. */
136
- export type GdlDockLayoutConstructOnly = never;
137
+ export type GdlDockLayoutConstructOnly = GObjectConstructOnly;
137
138
 
138
- export interface GdlDockMasterProps {
139
+ export interface GdlDockMasterProps extends GObjectProps {
139
140
  /** @default NULL */
140
141
  'default-title'?: string;
141
142
  /** @default 0 */
@@ -148,7 +149,7 @@ export interface GdlDockMasterProps {
148
149
  'tab-reorderable'?: boolean;
149
150
  }
150
151
  /** Settable only at construction — a renderer must REBUILD, not patch. */
151
- export type GdlDockMasterConstructOnly = never;
152
+ export type GdlDockMasterConstructOnly = GObjectConstructOnly;
152
153
 
153
154
  export interface GdlDockNotebookProps extends GdlDockItemProps, GtkBuildableProps {
154
155
  /** @default -1 */
@@ -411,6 +412,30 @@ export const PROVENANCE: {
411
412
  * GIRs disagreeing, which is what the main emitter answers `never` for as well.
412
413
  */
413
414
  readonly unresolvedProps: readonly string[];
415
+ /**
416
+ * `c:identifier-prefixes` from the GIR, verbatim and in order — `['G']` for Gio.
417
+ *
418
+ * The C prefix a type REFERENCE needs: resolving `Gio.Icon` means producing `GIcon`,
419
+ * and nothing else in this package states that `Gio` spells itself `G`. Carried rather
420
+ * than derived because GIR carries it, and a derivation over the `DECLS` keys is wrong
421
+ * wherever the C prefix is not a prefix of the type NAMES: gdkx11-4.0 and gdkwayland-4.0
422
+ * both state `Gdk` while every key they declare begins `GdkX11`/`GdkWayland`.
423
+ *
424
+ * Empty where the GIR states none — 17 of the 627 emitting namespaces — because
425
+ * inventing the namespace name there is a confident wrong answer in place of a missing
426
+ * one. A LIST because 20 of them state more than one, which no single string expresses.
427
+ */
428
+ readonly identifierPrefixes: readonly string[];
429
+ /**
430
+ * Sibling vocabularies this one's DECLARATIONS come from, as import specifiers.
431
+ *
432
+ * A chain link with no `OWN_PROPS` row is ambiguous on its own — `GtkSeparator` has no
433
+ * settable property, `GApplication` has its properties in another package — and this
434
+ * list is what tells the two apart. Enum and bitfield NUMBERS are not here: those are
435
+ * carried in this file, because a `PROP_ENUMS` row naming a foreign GType gives a
436
+ * consumer nothing to load and a `.ui` file using the property never names its owner.
437
+ */
438
+ readonly requiredVocabularies: readonly string[];
414
439
  };
415
440
 
416
441
  /** Declaration GType -> its own settable properties, as GObject registered them. */
@@ -520,6 +545,19 @@ export const FLAG_VALUES_UNREADABLE: Readonly<Record<string, string>>;
520
545
  */
521
546
  export const PROP_ENUMS: Readonly<Record<string, string>>;
522
547
 
548
+ /**
549
+ * `<declaration GType>.<property>` -> the GType of that property's own type.
550
+ *
551
+ * `PROP_ENUMS` one case wider, and separate on purpose: that table promises the GType it names
552
+ * has NUMBERS, and this one promises only that the GType is the property's. A host inferring a
553
+ * type from a property — the middle of an uncast lookup chain, an uncast closure's return type —
554
+ * reads this one; a host resolving a nick to a number reads that one.
555
+ *
556
+ * Absent means no GType can be stated, not that the property is scalar: `gchararray` is carried
557
+ * like any other, so absence is readable as "unknown".
558
+ */
559
+ export const PROP_TYPES: Readonly<Record<string, string>>;
560
+
523
561
  /**
524
562
  * The kinds of value a GTK accessible property, relation or state takes.
525
563
  *
@@ -1,6 +1,6 @@
1
1
  // The widget vocabulary of Gdl-3 as runtime data.
2
2
  //
3
- // 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
3
+ // GENERATED — do not edit. Provenance: Gdl-3 — dropped empty base(s): Atk.ImplementorIface — prop(s) no TypeScript value satisfies: Gdl.DockObject.pixbuf-icon
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,10 +11,12 @@ export const PROVENANCE = {
11
11
  version: '3',
12
12
  libraryVersion: null,
13
13
  childHolders: 0,
14
- droppedBases: ['GObject.InitiallyUnowned', 'GObject.Object', 'Atk.ImplementorIface'],
14
+ droppedBases: ['Atk.ImplementorIface'],
15
15
  inlinedBases: [],
16
16
  unsettableProps: ['Gdl.DockObject.pixbuf-icon'],
17
17
  unresolvedProps: [],
18
+ identifierPrefixes: ['Gdl'],
19
+ requiredVocabularies: ['@girs/gobject-2.0/vocabulary', '@girs/gtk-3.0/vocabulary'],
18
20
  };
19
21
 
20
22
  export const OWN_PROPS = {
@@ -48,21 +50,21 @@ export const OWN_SIGNALS = {
48
50
  // `GtkEventController*` and `GtkCellRenderer*`. Use `Widgets` and `CHILD_HOLDERS`
49
51
  // below for the narrower questions; they did not move.
50
52
  export const DECLS = {
51
- GdlDock: ['GdlDock', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
52
- GdlDockBar: ['GdlDockBar', 'GtkBox', 'GtkContainer', 'GtkWidget', 'GtkBuildable', 'GtkOrientable'],
53
- GdlDockItem: ['GdlDockItem', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
54
- GdlDockItemButtonImage: ['GdlDockItemButtonImage', 'GtkWidget', 'GtkBuildable'],
55
- GdlDockItemGrip: ['GdlDockItemGrip', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
56
- GdlDockLayout: ['GdlDockLayout'],
57
- GdlDockMaster: ['GdlDockMaster'],
58
- GdlDockNotebook: ['GdlDockNotebook', 'GdlDockItem', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
59
- GdlDockObject: ['GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
60
- GdlDockPaned: ['GdlDockPaned', 'GdlDockItem', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
53
+ GdlDock: ['GdlDock', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GtkBuildable'],
54
+ GdlDockBar: ['GdlDockBar', 'GtkBox', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GtkBuildable', 'GtkOrientable'],
55
+ GdlDockItem: ['GdlDockItem', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GtkBuildable'],
56
+ GdlDockItemButtonImage: ['GdlDockItemButtonImage', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GtkBuildable'],
57
+ GdlDockItemGrip: ['GdlDockItemGrip', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GtkBuildable'],
58
+ GdlDockLayout: ['GdlDockLayout', 'GObject'],
59
+ GdlDockMaster: ['GdlDockMaster', 'GObject'],
60
+ GdlDockNotebook: ['GdlDockNotebook', 'GdlDockItem', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GtkBuildable'],
61
+ GdlDockObject: ['GdlDockObject', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GtkBuildable'],
62
+ GdlDockPaned: ['GdlDockPaned', 'GdlDockItem', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GtkBuildable'],
61
63
  GdlDockParam: ['GdlDockParam'],
62
- GdlDockPlaceholder: ['GdlDockPlaceholder', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
63
- GdlDockTablabel: ['GdlDockTablabel', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
64
- GdlPreviewWindow: ['GdlPreviewWindow', 'GtkWindow', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
65
- GdlSwitcher: ['GdlSwitcher', 'GtkNotebook', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
64
+ GdlDockPlaceholder: ['GdlDockPlaceholder', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GtkBuildable'],
65
+ GdlDockTablabel: ['GdlDockTablabel', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GtkBuildable'],
66
+ GdlPreviewWindow: ['GdlPreviewWindow', 'GtkWindow', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GtkBuildable'],
67
+ GdlSwitcher: ['GdlSwitcher', 'GtkNotebook', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GtkBuildable'],
66
68
  };
67
69
 
68
70
  // The GTypes above that ARE widgets are the `Widgets` map in the sibling `.d.ts`; these
@@ -76,6 +78,8 @@ export const ENUM_NICKS = {
76
78
  GdlDockBarStyle: ['icons', 'text', 'both', 'auto'],
77
79
  GdlDockPlacement: ['none', 'top', 'bottom', 'right', 'left', 'center', 'floating'],
78
80
  GdlSwitcherStyle: ['text', 'icon', 'both', 'toolbar', 'tabs', 'none'],
81
+ GtkOrientation: ['horizontal', 'vertical'],
82
+ GtkPositionType: ['left', 'right', 'top', 'bottom'],
79
83
  };
80
84
 
81
85
  // The number behind each of those nicks, read from GIR's own `value` attribute.
@@ -110,6 +114,12 @@ export const ENUM_VALUES = {
110
114
  'GdlSwitcherStyle.tabs': 4,
111
115
  'GdlSwitcherStyle.text': 0,
112
116
  'GdlSwitcherStyle.toolbar': 3,
117
+ 'GtkOrientation.horizontal': 0,
118
+ 'GtkOrientation.vertical': 1,
119
+ 'GtkPositionType.bottom': 3,
120
+ 'GtkPositionType.left': 0,
121
+ 'GtkPositionType.right': 1,
122
+ 'GtkPositionType.top': 2,
113
123
  };
114
124
 
115
125
  // The nicks GIR marks `deprecated="1"`.
@@ -203,6 +213,62 @@ export const PROP_ENUMS = {
203
213
  'GdlSwitcher.tab-pos': 'GtkPositionType',
204
214
  };
205
215
 
216
+ // `<declaration GType>.<property>` -> the GType of that property's own type.
217
+ //
218
+ // `PROP_ENUMS` one case wider, and a SEPARATE table on purpose. That one is a join with a
219
+ // contract — the GType it names has numbers, in this vocabulary or the owner's — and folding a
220
+ // plain type table in would mix "resolvable to numbers" with "not" and hand the distinction to
221
+ // the consumer. `ARIA_VALUE_ENUMS` beside `ARIA_VALUE_TYPES` is the same split.
222
+ //
223
+ // A row is ABSENT where no GType can be stated: a fundamental spelling outside the generator's
224
+ // closed map, a registered type with no `glib:type-name`, or a property with no `<type>`
225
+ // child. Absence therefore reads as "unknown" and never as "scalar".
226
+ export const PROP_TYPES = {
227
+ 'GdlDock.default-title': 'gchararray',
228
+ 'GdlDock.floating': 'gboolean',
229
+ 'GdlDock.floatx': 'gint',
230
+ 'GdlDock.floaty': 'gint',
231
+ 'GdlDock.height': 'gint',
232
+ 'GdlDock.skip-taskbar': 'gboolean',
233
+ 'GdlDock.width': 'gint',
234
+ 'GdlDockBar.dockbar-style': 'GdlDockBarStyle',
235
+ 'GdlDockBar.master': 'GObject',
236
+ 'GdlDockItem.behavior': 'GdlDockItemBehavior',
237
+ 'GdlDockItem.closed': 'gboolean',
238
+ 'GdlDockItem.iconified': 'gboolean',
239
+ 'GdlDockItem.locked': 'gboolean',
240
+ 'GdlDockItem.orientation': 'GtkOrientation',
241
+ 'GdlDockItem.preferred-height': 'gint',
242
+ 'GdlDockItem.preferred-width': 'gint',
243
+ 'GdlDockItem.resize': 'gboolean',
244
+ 'GdlDockItemGrip.item': 'GdlDockItem',
245
+ 'GdlDockLayout.master': 'GObject',
246
+ 'GdlDockMaster.default-title': 'gchararray',
247
+ 'GdlDockMaster.locked': 'gint',
248
+ 'GdlDockMaster.switcher-style': 'GdlSwitcherStyle',
249
+ 'GdlDockMaster.tab-pos': 'GtkPositionType',
250
+ 'GdlDockMaster.tab-reorderable': 'gboolean',
251
+ 'GdlDockNotebook.page': 'gint',
252
+ 'GdlDockObject.long-name': 'gchararray',
253
+ 'GdlDockObject.master': 'GdlDockMaster',
254
+ 'GdlDockObject.name': 'gchararray',
255
+ 'GdlDockObject.pixbuf-icon': 'gpointer',
256
+ 'GdlDockObject.stock-id': 'gchararray',
257
+ 'GdlDockPaned.position': 'guint',
258
+ 'GdlDockPlaceholder.floating': 'gboolean',
259
+ 'GdlDockPlaceholder.floatx': 'gint',
260
+ 'GdlDockPlaceholder.floaty': 'gint',
261
+ 'GdlDockPlaceholder.height': 'gint',
262
+ 'GdlDockPlaceholder.host': 'GdlDockObject',
263
+ 'GdlDockPlaceholder.next-placement': 'GdlDockPlacement',
264
+ 'GdlDockPlaceholder.sticky': 'gboolean',
265
+ 'GdlDockPlaceholder.width': 'gint',
266
+ 'GdlDockTablabel.item': 'GdlDockItem',
267
+ 'GdlSwitcher.switcher-style': 'GdlSwitcherStyle',
268
+ 'GdlSwitcher.tab-pos': 'GtkPositionType',
269
+ 'GdlSwitcher.tab-reorderable': 'gboolean',
270
+ };
271
+
206
272
  // `<enum GType>.<nick>` -> the kind of value that ARIA slot takes.
207
273
  //
208
274
  // The one table here that is not about a ParamSpec. A GtkBuilder or Blueprint
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/gdl-3",
3
- "version": "5.2.0",
3
+ "version": "5.4.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.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" },
39
+ "@girs/gjs": "^5.4.0",
40
+ "@girs/gtk-3.0": "^5.4.0",
41
+ "@girs/xlib-2.0": "^5.4.0",
42
+ "@girs/gdk-3.0": "^5.4.0",
43
+ "@girs/cairo-1.0": "^5.4.0",
44
+ "@girs/gobject-2.0": "^5.4.0",
45
+ "@girs/glib-2.0": "^5.4.0",
46
+ "@girs/pango-1.0": "^5.4.0",
47
+ "@girs/harfbuzz-0.0": "^5.4.0",
48
+ "@girs/freetype2-2.0": "^5.4.0",
49
+ "@girs/gio-2.0": "^5.4.0",
50
+ "@girs/gmodule-2.0": "^5.4.0",
51
+ "@girs/gdkpixbuf-2.0": "^5.4.0",
52
+ "@girs/atk-1.0": "^5.4.0" },
53
53
  "devDependencies": {
54
54
  "typescript": "*"
55
55
  },