@girs/gtef-2 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/gtef-2)
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/gtef-2)
6
6
 
7
- GJS TypeScript type definitions for Gtef-2 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v5.2.0.
7
+ GJS TypeScript type definitions for Gtef-2 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 Gtef-2.
3
3
  *
4
- * GENERATED — do not edit. Provenance: Gtef-2 — dropped empty base(s): GObject.Object GObject.InitiallyUnowned Atk.ImplementorIface
4
+ * GENERATED — do not edit. Provenance: Gtef-2 — dropped empty base(s): Atk.ImplementorIface
5
5
  *
6
6
  * 15 instantiable GTypes (of which 3 concrete widgets), 15 declarations, 3 enum nick unions, 2 slot candidates.
7
7
  *
@@ -28,6 +28,7 @@ import type Gio from '@girs/gio-2.0';
28
28
  import type Gtef from './gtef-2.js';
29
29
  import type Gtk from '@girs/gtk-3.0';
30
30
  import type GtkSource from '@girs/gtksource-3.0';
31
+ import type { GInitiallyUnownedConstructOnly, GInitiallyUnownedProps, GObjectConstructOnly, GObjectProps } from '@girs/gobject-2.0/vocabulary';
31
32
  import type { GtkBoxConstructOnly, GtkBoxProps, GtkBuildableConstructOnly, GtkBuildableProps, GtkContainerConstructOnly, GtkContainerProps, GtkGridConstructOnly, GtkGridProps, GtkInfoBarConstructOnly, GtkInfoBarProps, GtkOrientableConstructOnly, GtkOrientableProps, GtkScrollableConstructOnly, GtkScrollableProps, GtkTextBufferConstructOnly, GtkTextBufferProps, GtkTextViewConstructOnly, GtkTextViewProps, GtkWidgetConstructOnly, GtkWidgetProps } from '@girs/gtk-3.0/vocabulary';
32
33
  import type { GtkSourceBufferConstructOnly, GtkSourceBufferProps, GtkSourceCompressionTypeNick, GtkSourceGutterRendererConstructOnly, GtkSourceGutterRendererProps, GtkSourceNewlineTypeNick, GtkSourceViewConstructOnly, GtkSourceViewProps } from '@girs/gtksource-3.0/vocabulary';
33
34
 
@@ -55,12 +56,12 @@ export type GtefSelectionTypeNick = 'no-selection' | 'on-same-line' | 'multiple-
55
56
  // GIR keeps them once, on the interface.
56
57
  // ---------------------------------------------------------------------------
57
58
 
58
- export interface GtefActionInfoCentralStoreProps {
59
+ export interface GtefActionInfoCentralStoreProps extends GObjectProps {
59
60
  }
60
61
  /** Settable only at construction — a renderer must REBUILD, not patch. */
61
- export type GtefActionInfoCentralStoreConstructOnly = never;
62
+ export type GtefActionInfoCentralStoreConstructOnly = GObjectConstructOnly;
62
63
 
63
- export interface GtefActionInfoStoreProps {
64
+ export interface GtefActionInfoStoreProps extends GObjectProps {
64
65
  /**
65
66
  * The associated #GtkApplication.
66
67
  * @since 2.0
@@ -68,9 +69,9 @@ export interface GtefActionInfoStoreProps {
68
69
  application?: Gtk.Application | null;
69
70
  }
70
71
  /** Settable only at construction — a renderer must REBUILD, not patch. */
71
- export type GtefActionInfoStoreConstructOnly = 'application';
72
+ export type GtefActionInfoStoreConstructOnly = GObjectConstructOnly | 'application';
72
73
 
73
- export interface GtefApplicationProps {
74
+ export interface GtefApplicationProps extends GObjectProps {
74
75
  /**
75
76
  * The #GtkApplication.
76
77
  * @since 2.0
@@ -78,9 +79,9 @@ export interface GtefApplicationProps {
78
79
  application?: Gtk.Application;
79
80
  }
80
81
  /** Settable only at construction — a renderer must REBUILD, not patch. */
81
- export type GtefApplicationConstructOnly = 'application';
82
+ export type GtefApplicationConstructOnly = GObjectConstructOnly | 'application';
82
83
 
83
- export interface GtefApplicationWindowProps {
84
+ export interface GtefApplicationWindowProps extends GObjectProps {
84
85
  /**
85
86
  * The #GtkApplicationWindow.
86
87
  * @since 2.0
@@ -93,7 +94,7 @@ export interface GtefApplicationWindowProps {
93
94
  statusbar?: Gtk.Statusbar | null;
94
95
  }
95
96
  /** Settable only at construction — a renderer must REBUILD, not patch. */
96
- export type GtefApplicationWindowConstructOnly = 'application-window';
97
+ export type GtefApplicationWindowConstructOnly = GObjectConstructOnly | 'application-window';
97
98
 
98
99
  export interface GtefBufferProps extends GtkSourceBufferProps {
99
100
  /**
@@ -105,7 +106,7 @@ export interface GtefBufferProps extends GtkSourceBufferProps {
105
106
  /** Settable only at construction — a renderer must REBUILD, not patch. */
106
107
  export type GtefBufferConstructOnly = GtkSourceBufferConstructOnly;
107
108
 
108
- export interface GtefFileProps {
109
+ export interface GtefFileProps extends GObjectProps {
109
110
  /**
110
111
  * The location.
111
112
  * @since 1.0
@@ -113,9 +114,9 @@ export interface GtefFileProps {
113
114
  location?: Gio.File;
114
115
  }
115
116
  /** Settable only at construction — a renderer must REBUILD, not patch. */
116
- export type GtefFileConstructOnly = never;
117
+ export type GtefFileConstructOnly = GObjectConstructOnly;
117
118
 
118
- export interface GtefFileLoaderProps {
119
+ export interface GtefFileLoaderProps extends GObjectProps {
119
120
  /**
120
121
  * The #GtefBuffer to load the content into.
121
122
  * @since 1.0
@@ -143,9 +144,9 @@ export interface GtefFileLoaderProps {
143
144
  'max-size'?: bigint | number;
144
145
  }
145
146
  /** Settable only at construction — a renderer must REBUILD, not patch. */
146
- export type GtefFileLoaderConstructOnly = 'buffer' | 'file' | 'location';
147
+ export type GtefFileLoaderConstructOnly = GObjectConstructOnly | 'buffer' | 'file' | 'location';
147
148
 
148
- export interface GtefFileMetadataProps {
149
+ export interface GtefFileMetadataProps extends GObjectProps {
149
150
  /**
150
151
  * The #GtefFile that the metadata belong to.
151
152
  * @since 1.0
@@ -153,9 +154,9 @@ export interface GtefFileMetadataProps {
153
154
  file?: Gtef.File;
154
155
  }
155
156
  /** Settable only at construction — a renderer must REBUILD, not patch. */
156
- export type GtefFileMetadataConstructOnly = 'file';
157
+ export type GtefFileMetadataConstructOnly = GObjectConstructOnly | 'file';
157
158
 
158
- export interface GtefFileSaverProps {
159
+ export interface GtefFileSaverProps extends GObjectProps {
159
160
  /**
160
161
  * The #GtefBuffer to save.
161
162
  * @since 1.0
@@ -193,9 +194,9 @@ export interface GtefFileSaverProps {
193
194
  'newline-type'?: GtkSourceNewlineTypeNick | GtkSource.NewlineType;
194
195
  }
195
196
  /** Settable only at construction — a renderer must REBUILD, not patch. */
196
- export type GtefFileSaverConstructOnly = 'buffer' | 'file' | 'location';
197
+ export type GtefFileSaverConstructOnly = GObjectConstructOnly | 'buffer' | 'file' | 'location';
197
198
 
198
- export interface GtefFoldRegionProps {
199
+ export interface GtefFoldRegionProps extends GObjectProps {
199
200
  /**
200
201
  * The #GtkTextBuffer where the fold region is applied.
201
202
  * @since 1.0
@@ -208,7 +209,7 @@ export interface GtefFoldRegionProps {
208
209
  folded?: boolean;
209
210
  }
210
211
  /** Settable only at construction — a renderer must REBUILD, not patch. */
211
- export type GtefFoldRegionConstructOnly = 'buffer';
212
+ export type GtefFoldRegionConstructOnly = GObjectConstructOnly | 'buffer';
212
213
 
213
214
  export interface GtefGutterRendererFoldsProps extends GtkSourceGutterRendererProps {
214
215
  }
@@ -220,7 +221,7 @@ export interface GtefInfoBarProps extends GtkInfoBarProps, GtkBuildableProps, Gt
220
221
  /** Settable only at construction — a renderer must REBUILD, not patch. */
221
222
  export type GtefInfoBarConstructOnly = GtkInfoBarConstructOnly | GtkBuildableConstructOnly | GtkOrientableConstructOnly;
222
223
 
223
- export interface GtefMenuShellProps {
224
+ export interface GtefMenuShellProps extends GObjectProps {
224
225
  /**
225
226
  * The #GtkMenuShell.
226
227
  * @since 2.0
@@ -228,7 +229,7 @@ export interface GtefMenuShellProps {
228
229
  'menu-shell'?: Gtk.MenuShell;
229
230
  }
230
231
  /** Settable only at construction — a renderer must REBUILD, not patch. */
231
- export type GtefMenuShellConstructOnly = 'menu-shell';
232
+ export type GtefMenuShellConstructOnly = GObjectConstructOnly | 'menu-shell';
232
233
 
233
234
  export interface GtefTabProps extends GtkGridProps, GtkBuildableProps, GtkOrientableProps {
234
235
  }
@@ -347,6 +348,30 @@ export const PROVENANCE: {
347
348
  * GIRs disagreeing, which is what the main emitter answers `never` for as well.
348
349
  */
349
350
  readonly unresolvedProps: readonly string[];
351
+ /**
352
+ * `c:identifier-prefixes` from the GIR, verbatim and in order — `['G']` for Gio.
353
+ *
354
+ * The C prefix a type REFERENCE needs: resolving `Gio.Icon` means producing `GIcon`,
355
+ * and nothing else in this package states that `Gio` spells itself `G`. Carried rather
356
+ * than derived because GIR carries it, and a derivation over the `DECLS` keys is wrong
357
+ * wherever the C prefix is not a prefix of the type NAMES: gdkx11-4.0 and gdkwayland-4.0
358
+ * both state `Gdk` while every key they declare begins `GdkX11`/`GdkWayland`.
359
+ *
360
+ * Empty where the GIR states none — 17 of the 627 emitting namespaces — because
361
+ * inventing the namespace name there is a confident wrong answer in place of a missing
362
+ * one. A LIST because 20 of them state more than one, which no single string expresses.
363
+ */
364
+ readonly identifierPrefixes: readonly string[];
365
+ /**
366
+ * Sibling vocabularies this one's DECLARATIONS come from, as import specifiers.
367
+ *
368
+ * A chain link with no `OWN_PROPS` row is ambiguous on its own — `GtkSeparator` has no
369
+ * settable property, `GApplication` has its properties in another package — and this
370
+ * list is what tells the two apart. Enum and bitfield NUMBERS are not here: those are
371
+ * carried in this file, because a `PROP_ENUMS` row naming a foreign GType gives a
372
+ * consumer nothing to load and a `.ui` file using the property never names its owner.
373
+ */
374
+ readonly requiredVocabularies: readonly string[];
350
375
  };
351
376
 
352
377
  /** Declaration GType -> its own settable properties, as GObject registered them. */
@@ -456,6 +481,19 @@ export const FLAG_VALUES_UNREADABLE: Readonly<Record<string, string>>;
456
481
  */
457
482
  export const PROP_ENUMS: Readonly<Record<string, string>>;
458
483
 
484
+ /**
485
+ * `<declaration GType>.<property>` -> the GType of that property's own type.
486
+ *
487
+ * `PROP_ENUMS` one case wider, and separate on purpose: that table promises the GType it names
488
+ * has NUMBERS, and this one promises only that the GType is the property's. A host inferring a
489
+ * type from a property — the middle of an uncast lookup chain, an uncast closure's return type —
490
+ * reads this one; a host resolving a nick to a number reads that one.
491
+ *
492
+ * Absent means no GType can be stated, not that the property is scalar: `gchararray` is carried
493
+ * like any other, so absence is readable as "unknown".
494
+ */
495
+ export const PROP_TYPES: Readonly<Record<string, string>>;
496
+
459
497
  /**
460
498
  * The kinds of value a GTK accessible property, relation or state takes.
461
499
  *
@@ -1,6 +1,6 @@
1
1
  // The widget vocabulary of Gtef-2 as runtime data.
2
2
  //
3
- // GENERATED — do not edit. Provenance: Gtef-2 — dropped empty base(s): GObject.Object GObject.InitiallyUnowned Atk.ImplementorIface
3
+ // GENERATED — do not edit. Provenance: Gtef-2 — dropped empty base(s): Atk.ImplementorIface
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: '2',
12
12
  libraryVersion: null,
13
13
  childHolders: 0,
14
- droppedBases: ['GObject.Object', 'GObject.InitiallyUnowned', 'Atk.ImplementorIface'],
14
+ droppedBases: ['Atk.ImplementorIface'],
15
15
  inlinedBases: [],
16
16
  unsettableProps: [],
17
17
  unresolvedProps: [],
18
+ identifierPrefixes: ['Gtef'],
19
+ requiredVocabularies: ['@girs/gobject-2.0/vocabulary', '@girs/gtk-3.0/vocabulary', '@girs/gtksource-3.0/vocabulary'],
18
20
  };
19
21
 
20
22
  export const OWN_PROPS = {
@@ -43,21 +45,21 @@ export const OWN_SIGNALS = {
43
45
  // `GtkEventController*` and `GtkCellRenderer*`. Use `Widgets` and `CHILD_HOLDERS`
44
46
  // below for the narrower questions; they did not move.
45
47
  export const DECLS = {
46
- GtefActionInfoCentralStore: ['GtefActionInfoCentralStore'],
47
- GtefActionInfoStore: ['GtefActionInfoStore'],
48
- GtefApplication: ['GtefApplication'],
49
- GtefApplicationWindow: ['GtefApplicationWindow'],
50
- GtefBuffer: ['GtefBuffer', 'GtkSourceBuffer', 'GtkTextBuffer'],
51
- GtefFile: ['GtefFile'],
52
- GtefFileLoader: ['GtefFileLoader'],
53
- GtefFileMetadata: ['GtefFileMetadata'],
54
- GtefFileSaver: ['GtefFileSaver'],
55
- GtefFoldRegion: ['GtefFoldRegion'],
56
- GtefGutterRendererFolds: ['GtefGutterRendererFolds', 'GtkSourceGutterRenderer'],
57
- GtefInfoBar: ['GtefInfoBar', 'GtkInfoBar', 'GtkBox', 'GtkContainer', 'GtkWidget', 'GtkBuildable', 'GtkOrientable'],
58
- GtefMenuShell: ['GtefMenuShell'],
59
- GtefTab: ['GtefTab', 'GtkGrid', 'GtkContainer', 'GtkWidget', 'GtkBuildable', 'GtkOrientable'],
60
- GtefView: ['GtefView', 'GtkSourceView', 'GtkTextView', 'GtkContainer', 'GtkWidget', 'GtkBuildable', 'GtkScrollable'],
48
+ GtefActionInfoCentralStore: ['GtefActionInfoCentralStore', 'GObject'],
49
+ GtefActionInfoStore: ['GtefActionInfoStore', 'GObject'],
50
+ GtefApplication: ['GtefApplication', 'GObject'],
51
+ GtefApplicationWindow: ['GtefApplicationWindow', 'GObject'],
52
+ GtefBuffer: ['GtefBuffer', 'GtkSourceBuffer', 'GtkTextBuffer', 'GObject'],
53
+ GtefFile: ['GtefFile', 'GObject'],
54
+ GtefFileLoader: ['GtefFileLoader', 'GObject'],
55
+ GtefFileMetadata: ['GtefFileMetadata', 'GObject'],
56
+ GtefFileSaver: ['GtefFileSaver', 'GObject'],
57
+ GtefFoldRegion: ['GtefFoldRegion', 'GObject'],
58
+ GtefGutterRendererFolds: ['GtefGutterRendererFolds', 'GtkSourceGutterRenderer', 'GInitiallyUnowned', 'GObject'],
59
+ GtefInfoBar: ['GtefInfoBar', 'GtkInfoBar', 'GtkBox', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GtkBuildable', 'GtkOrientable'],
60
+ GtefMenuShell: ['GtefMenuShell', 'GObject'],
61
+ GtefTab: ['GtefTab', 'GtkGrid', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GtkBuildable', 'GtkOrientable'],
62
+ GtefView: ['GtefView', 'GtkSourceView', 'GtkTextView', 'GtkContainer', 'GtkWidget', 'GInitiallyUnowned', 'GObject', 'GtkBuildable', 'GtkScrollable'],
61
63
  };
62
64
 
63
65
  // The GTypes above that ARE widgets are the `Widgets` map in the sibling `.d.ts`; these
@@ -71,6 +73,8 @@ export const ENUM_NICKS = {
71
73
  GtefCompressionType: ['none', 'gzip'],
72
74
  GtefNewlineType: ['lf', 'cr', 'cr-lf'],
73
75
  GtefSelectionType: ['no-selection', 'on-same-line', 'multiple-lines'],
76
+ GtkSourceCompressionType: ['none', 'gzip'],
77
+ GtkSourceNewlineType: ['lf', 'cr', 'cr-lf'],
74
78
  };
75
79
 
76
80
  // The number behind each of those nicks, read from GIR's own `value` attribute.
@@ -96,6 +100,11 @@ export const ENUM_VALUES = {
96
100
  'GtefSelectionType.multiple-lines': 2,
97
101
  'GtefSelectionType.no-selection': 0,
98
102
  'GtefSelectionType.on-same-line': 1,
103
+ 'GtkSourceCompressionType.gzip': 1,
104
+ 'GtkSourceCompressionType.none': 0,
105
+ 'GtkSourceNewlineType.cr': 1,
106
+ 'GtkSourceNewlineType.cr-lf': 2,
107
+ 'GtkSourceNewlineType.lf': 0,
99
108
  };
100
109
 
101
110
  // The nicks GIR marks `deprecated="1"`.
@@ -170,6 +179,40 @@ export const PROP_ENUMS = {
170
179
  'GtefFileSaver.newline-type': 'GtkSourceNewlineType',
171
180
  };
172
181
 
182
+ // `<declaration GType>.<property>` -> the GType of that property's own type.
183
+ //
184
+ // `PROP_ENUMS` one case wider, and a SEPARATE table on purpose. That one is a join with a
185
+ // contract — the GType it names has numbers, in this vocabulary or the owner's — and folding a
186
+ // plain type table in would mix "resolvable to numbers" with "not" and hand the distinction to
187
+ // the consumer. `ARIA_VALUE_ENUMS` beside `ARIA_VALUE_TYPES` is the same split.
188
+ //
189
+ // A row is ABSENT where no GType can be stated: a fundamental spelling outside the generator's
190
+ // closed map, a registered type with no `glib:type-name`, or a property with no `<type>`
191
+ // child. Absence therefore reads as "unknown" and never as "scalar".
192
+ export const PROP_TYPES = {
193
+ 'GtefActionInfoStore.application': 'GtkApplication',
194
+ 'GtefApplication.application': 'GtkApplication',
195
+ 'GtefApplicationWindow.application-window': 'GtkApplicationWindow',
196
+ 'GtefApplicationWindow.statusbar': 'GtkStatusbar',
197
+ 'GtefBuffer.gtef-style-scheme-id': 'gchararray',
198
+ 'GtefFile.location': 'GFile',
199
+ 'GtefFileLoader.buffer': 'GtefBuffer',
200
+ 'GtefFileLoader.chunk-size': 'gint64',
201
+ 'GtefFileLoader.file': 'GtefFile',
202
+ 'GtefFileLoader.location': 'GFile',
203
+ 'GtefFileLoader.max-size': 'gint64',
204
+ 'GtefFileMetadata.file': 'GtefFile',
205
+ 'GtefFileSaver.buffer': 'GtkSourceBuffer',
206
+ 'GtefFileSaver.compression-type': 'GtkSourceCompressionType',
207
+ 'GtefFileSaver.file': 'GtefFile',
208
+ 'GtefFileSaver.flags': 'GtefFileSaverFlags',
209
+ 'GtefFileSaver.location': 'GFile',
210
+ 'GtefFileSaver.newline-type': 'GtkSourceNewlineType',
211
+ 'GtefFoldRegion.buffer': 'GtkTextBuffer',
212
+ 'GtefFoldRegion.folded': 'gboolean',
213
+ 'GtefMenuShell.menu-shell': 'GtkMenuShell',
214
+ };
215
+
173
216
  // `<enum GType>.<nick>` -> the kind of value that ARIA slot takes.
174
217
  //
175
218
  // 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/gtef-2",
3
- "version": "5.2.0",
3
+ "version": "5.4.0",
4
4
  "description": "GJS TypeScript type definitions for Gtef-2",
5
5
  "type": "module",
6
6
  "module": "gtef-2.js",
@@ -36,21 +36,21 @@
36
36
  "test": "tsc --project tsconfig.json"
37
37
  },
38
38
  "dependencies": {
39
- "@girs/gjs": "^5.2.0",
40
- "@girs/gtksource-3.0": "^5.2.0",
41
- "@girs/gtk-3.0": "^5.2.0",
42
- "@girs/xlib-2.0": "^5.2.0",
43
- "@girs/gdk-3.0": "^5.2.0",
44
- "@girs/cairo-1.0": "^5.2.0",
45
- "@girs/gobject-2.0": "^5.2.0",
46
- "@girs/glib-2.0": "^5.2.0",
47
- "@girs/pango-1.0": "^5.2.0",
48
- "@girs/harfbuzz-0.0": "^5.2.0",
49
- "@girs/freetype2-2.0": "^5.2.0",
50
- "@girs/gio-2.0": "^5.2.0",
51
- "@girs/gmodule-2.0": "^5.2.0",
52
- "@girs/gdkpixbuf-2.0": "^5.2.0",
53
- "@girs/atk-1.0": "^5.2.0" },
39
+ "@girs/gjs": "^5.4.0",
40
+ "@girs/gtksource-3.0": "^5.4.0",
41
+ "@girs/gtk-3.0": "^5.4.0",
42
+ "@girs/xlib-2.0": "^5.4.0",
43
+ "@girs/gdk-3.0": "^5.4.0",
44
+ "@girs/cairo-1.0": "^5.4.0",
45
+ "@girs/gobject-2.0": "^5.4.0",
46
+ "@girs/glib-2.0": "^5.4.0",
47
+ "@girs/pango-1.0": "^5.4.0",
48
+ "@girs/harfbuzz-0.0": "^5.4.0",
49
+ "@girs/freetype2-2.0": "^5.4.0",
50
+ "@girs/gio-2.0": "^5.4.0",
51
+ "@girs/gmodule-2.0": "^5.4.0",
52
+ "@girs/gdkpixbuf-2.0": "^5.4.0",
53
+ "@girs/atk-1.0": "^5.4.0" },
54
54
  "devDependencies": {
55
55
  "typescript": "*"
56
56
  },