@girs/gtksource-5 4.1.0 → 4.3.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/gtksource-5)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for GtkSource-5, generated from library version 5.20.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.1.0.
8
+ GJS TypeScript type definitions for GtkSource-5, generated from library version 5.21.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.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/gtksource-5
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 GtkSource from '@girs/gtksource-5';
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/gtksource-5` or `@girs/gtksource-5/ambient` in your `tsconfig` or entry point Typescript file:
28
28
 
29
29
  `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/gtksource-5'
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 GtkSource from 'gi://GtkSource?version=5';
@@ -50,7 +50,7 @@ import GtkSource from 'gi://GtkSource?version=5';
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/gtksource-5` or `@girs/gtksource-5/import` in your `tsconfig` or entry point Typescript file:
55
55
 
56
56
  `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/gtksource-5'
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 GtkSource = imports.gi.GtkSource;
@@ -77,7 +77,7 @@ const GtkSource = imports.gi.GtkSource;
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
 
@@ -0,0 +1,339 @@
1
+ /**
2
+ * The GIR-derived widget VOCABULARY for GtkSource-5.
3
+ *
4
+ * GENERATED — do not edit. Provenance: GtkSource-5 — library 5.21.0 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object
5
+ *
6
+ * 10 concrete widgets, 12 declarations, 11 enum nick unions, 2 slot candidates.
7
+ *
8
+ * Module-scoped exports only. There is no `JSX` namespace here, no tag spelling and
9
+ * no `on<Signal>` prop name: those are DIALECT, and every framework answers them
10
+ * differently. The shape to avoid is the GLOBAL AUGMENT — a `declare global` on
11
+ * `React.JSX` collides with every other library on a shared tag — while a
12
+ * module-scoped `JSX` behind a `jsxImportSource` does not. This package is used by
13
+ * projects that want nothing to do with JSX, so it emits neither; a consumer declaring
14
+ * a module-scoped namespace over these names is doing it right.
15
+ *
16
+ * Three things this is and `ConstructorProps` is not: WRITABLE-only (measured on
17
+ * Gtk-4.0, `ConstructorProps` offers 150 read-only properties across 68 classes as
18
+ * settable, and GTK's failure mode for writing one is exit 0), OPTIONAL, and keyed
19
+ * by the name GObject actually REGISTERED — the dashed spelling `g_object_set`,
20
+ * GtkBuilder XML and Blueprint all use.
21
+ *
22
+ * Signal handler types are not re-derived: `X.SignalSignatures`, which this package
23
+ * already emits for every class with the parent chain, every implemented interface
24
+ * and the `notify::` keys folded in, is what `Widgets[G]['signals']` points at.
25
+ */
26
+
27
+ import type Gdk from '@girs/gdk-4.0';
28
+ import type GdkPixbuf from '@girs/gdkpixbuf-2.0';
29
+ import type Gio from '@girs/gio-2.0';
30
+ import type Gtk from '@girs/gtk-4.0';
31
+ import type GtkSource from './gtksource-5.js';
32
+ import type Pango from '@girs/pango-1.0';
33
+ import type { GtkAccessibleConstructOnly, GtkAccessibleProps, GtkAccessibleTextConstructOnly, GtkAccessibleTextProps, GtkActionableConstructOnly, GtkActionableProps, GtkBuildableConstructOnly, GtkBuildableProps, GtkButtonConstructOnly, GtkButtonProps, GtkConstraintTargetConstructOnly, GtkConstraintTargetProps, GtkScrollableConstructOnly, GtkScrollableProps, GtkTextViewConstructOnly, GtkTextViewProps, GtkTextWindowTypeNick, GtkWidgetConstructOnly, GtkWidgetProps } from '@girs/gtk-4.0/surface';
34
+
35
+ // ---------------------------------------------------------------------------
36
+ // Enum nicks — the string vocabulary GObject registered, from GIR's `glib:nick`.
37
+ //
38
+ // Not derived from the member name. Substituting underscores for dashes is not a law:
39
+ // some nicks keep an underscore the substitution would have replaced, and only the
40
+ // attribute knows which. Gtk-4.0 and Adw-1 contradict no derivation at all, which is
41
+ // how a derived nick passes review and breaks elsewhere.
42
+ // Re-measure with `scripts/check-nick-derivation.mjs` in ts-for-gir.
43
+ // ---------------------------------------------------------------------------
44
+
45
+ export type GtkSourceAnnotationStyleNick = 'none' | 'warning' | 'error' | 'accent';
46
+ export type GtkSourceBackgroundPatternTypeNick = 'none' | 'grid';
47
+ export type GtkSourceBracketMatchTypeNick = 'none' | 'out-of-range' | 'not-found' | 'found';
48
+ export type GtkSourceChangeCaseTypeNick = 'lower' | 'upper' | 'toggle' | 'title';
49
+ export type GtkSourceCompletionActivationNick = 'none' | 'interactive' | 'user-requested';
50
+ export type GtkSourceCompletionColumnNick = 'icon' | 'before' | 'typed-text' | 'after' | 'comment' | 'details';
51
+ export type GtkSourceCompressionTypeNick = 'none' | 'gzip';
52
+ export type GtkSourceGutterRendererAlignmentModeNick = 'cell' | 'first' | 'last';
53
+ export type GtkSourceNewlineTypeNick = 'lf' | 'cr' | 'cr-lf';
54
+ export type GtkSourceSmartHomeEndTypeNick = 'disabled' | 'before' | 'after' | 'always';
55
+ export type GtkSourceViewGutterPositionNick = 'lines' | 'marks';
56
+
57
+ // ---------------------------------------------------------------------------
58
+ // Property surfaces — one interface per GIR DECLARATION, mirroring GIR's own
59
+ // inheritance rather than flattening per widget.
60
+ //
61
+ // The interfaces are load-bearing, not tidiness: `GtkBox` declares four properties
62
+ // of its own and `orientation` is not among them — it lives on `Gtk.Orientable`,
63
+ // because GObject installs interface properties on the implementor at runtime while
64
+ // GIR keeps them once, on the interface.
65
+ // ---------------------------------------------------------------------------
66
+
67
+ /** Widget for single cell of completion proposal. */
68
+ export interface GtkSourceCompletionCellProps extends GtkWidgetProps, GtkAccessibleProps, GtkBuildableProps, GtkConstraintTargetProps {
69
+ column?: GtkSourceCompletionColumnNick | GtkSource.CompletionColumn;
70
+ markup?: string;
71
+ paintable?: Gdk.Paintable;
72
+ text?: string;
73
+ widget?: Gtk.Widget | null;
74
+ }
75
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
76
+ export type GtkSourceCompletionCellConstructOnly = GtkWidgetConstructOnly | GtkAccessibleConstructOnly | GtkBuildableConstructOnly | GtkConstraintTargetConstructOnly | 'column';
77
+
78
+ /** Gutter object for [class@View]. */
79
+ export interface GtkSourceGutterProps extends GtkWidgetProps, GtkAccessibleProps, GtkBuildableProps, GtkConstraintTargetProps {
80
+ /** The #GtkSourceView of the gutter. */
81
+ view?: GtkSource.View;
82
+ /** The text window type on which the window is placed. */
83
+ 'window-type'?: GtkTextWindowTypeNick | Gtk.TextWindowType;
84
+ }
85
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
86
+ export type GtkSourceGutterConstructOnly = GtkWidgetConstructOnly | GtkAccessibleConstructOnly | GtkBuildableConstructOnly | GtkConstraintTargetConstructOnly | 'view' | 'window-type';
87
+
88
+ /** Gutter cell renderer. */
89
+ export interface GtkSourceGutterRendererProps extends GtkWidgetProps, GtkAccessibleProps, GtkBuildableProps, GtkConstraintTargetProps {
90
+ /** The alignment mode of the renderer. */
91
+ 'alignment-mode'?: GtkSourceGutterRendererAlignmentModeNick | GtkSource.GutterRendererAlignmentMode;
92
+ /** The horizontal alignment of the renderer. */
93
+ xalign?: number;
94
+ /** The left and right padding of the renderer. */
95
+ xpad?: number;
96
+ /** The vertical alignment of the renderer. */
97
+ yalign?: number;
98
+ /** The top and bottom padding of the renderer. */
99
+ ypad?: number;
100
+ }
101
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
102
+ export type GtkSourceGutterRendererConstructOnly = GtkWidgetConstructOnly | GtkAccessibleConstructOnly | GtkBuildableConstructOnly | GtkConstraintTargetConstructOnly;
103
+
104
+ /** Renders a pixbuf in the gutter. */
105
+ export interface GtkSourceGutterRendererPixbufProps extends GtkSourceGutterRendererProps, GtkAccessibleProps, GtkBuildableProps, GtkConstraintTargetProps {
106
+ gicon?: Gio.Icon;
107
+ 'icon-name'?: string;
108
+ paintable?: Gdk.Paintable | null;
109
+ pixbuf?: GdkPixbuf.Pixbuf;
110
+ }
111
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
112
+ export type GtkSourceGutterRendererPixbufConstructOnly = GtkSourceGutterRendererConstructOnly | GtkAccessibleConstructOnly | GtkBuildableConstructOnly | GtkConstraintTargetConstructOnly;
113
+
114
+ /** Renders text in the gutter. */
115
+ export interface GtkSourceGutterRendererTextProps extends GtkSourceGutterRendererProps, GtkAccessibleProps, GtkBuildableProps, GtkConstraintTargetProps {
116
+ markup?: string;
117
+ text?: string;
118
+ }
119
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
120
+ export type GtkSourceGutterRendererTextConstructOnly = GtkSourceGutterRendererConstructOnly | GtkAccessibleConstructOnly | GtkBuildableConstructOnly | GtkConstraintTargetConstructOnly;
121
+
122
+ /** Display for interactive tooltips. */
123
+ export interface GtkSourceHoverDisplayProps extends GtkWidgetProps, GtkAccessibleProps, GtkBuildableProps, GtkConstraintTargetProps {
124
+ }
125
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
126
+ export type GtkSourceHoverDisplayConstructOnly = GtkWidgetConstructOnly | GtkAccessibleConstructOnly | GtkBuildableConstructOnly | GtkConstraintTargetConstructOnly;
127
+
128
+ /** Widget that displays a map for a specific [class@View]. */
129
+ export interface GtkSourceMapProps extends GtkSourceViewProps, GtkAccessibleProps, GtkAccessibleTextProps, GtkBuildableProps, GtkConstraintTargetProps, GtkScrollableProps {
130
+ 'font-desc'?: Pango.FontDescription;
131
+ view?: GtkSource.View | null;
132
+ }
133
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
134
+ export type GtkSourceMapConstructOnly = GtkSourceViewConstructOnly | GtkAccessibleConstructOnly | GtkAccessibleTextConstructOnly | GtkBuildableConstructOnly | GtkConstraintTargetConstructOnly | GtkScrollableConstructOnly;
135
+
136
+ /** Interface implemented by widgets for choosing style schemes. */
137
+ export interface GtkSourceStyleSchemeChooserProps {
138
+ /** Contains the currently selected style scheme. */
139
+ 'style-scheme'?: GtkSource.StyleScheme;
140
+ }
141
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
142
+ export type GtkSourceStyleSchemeChooserConstructOnly = never;
143
+
144
+ /** A button to launch a style scheme selection dialog. */
145
+ export interface GtkSourceStyleSchemeChooserButtonProps extends GtkButtonProps, GtkAccessibleProps, GtkActionableProps, GtkBuildableProps, GtkConstraintTargetProps, GtkSourceStyleSchemeChooserProps {
146
+ }
147
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
148
+ export type GtkSourceStyleSchemeChooserButtonConstructOnly = GtkButtonConstructOnly | GtkAccessibleConstructOnly | GtkActionableConstructOnly | GtkBuildableConstructOnly | GtkConstraintTargetConstructOnly | GtkSourceStyleSchemeChooserConstructOnly;
149
+
150
+ /** A widget for choosing style schemes. */
151
+ export interface GtkSourceStyleSchemeChooserWidgetProps extends GtkWidgetProps, GtkAccessibleProps, GtkBuildableProps, GtkConstraintTargetProps, GtkSourceStyleSchemeChooserProps {
152
+ }
153
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
154
+ export type GtkSourceStyleSchemeChooserWidgetConstructOnly = GtkWidgetConstructOnly | GtkAccessibleConstructOnly | GtkBuildableConstructOnly | GtkConstraintTargetConstructOnly | GtkSourceStyleSchemeChooserConstructOnly;
155
+
156
+ /** A preview widget for [class@StyleScheme]. */
157
+ export interface GtkSourceStyleSchemePreviewProps extends GtkWidgetProps, GtkAccessibleProps, GtkActionableProps, GtkBuildableProps, GtkConstraintTargetProps {
158
+ scheme?: GtkSource.StyleScheme;
159
+ selected?: boolean;
160
+ }
161
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
162
+ export type GtkSourceStyleSchemePreviewConstructOnly = GtkWidgetConstructOnly | GtkAccessibleConstructOnly | GtkActionableConstructOnly | GtkBuildableConstructOnly | GtkConstraintTargetConstructOnly | 'scheme';
163
+
164
+ /** Subclass of [class@Gtk.TextView]. */
165
+ export interface GtkSourceViewProps extends GtkTextViewProps, GtkAccessibleProps, GtkAccessibleTextProps, GtkBuildableProps, GtkConstraintTargetProps, GtkScrollableProps {
166
+ 'auto-indent'?: boolean;
167
+ /** Draw a specific background pattern on the view. */
168
+ 'background-pattern'?: GtkSourceBackgroundPatternTypeNick | GtkSource.BackgroundPatternType;
169
+ /** The property denotes if snippets should be expanded when the user presses Tab after having typed a word matching the snippets found in [class@SnippetManager]. */
170
+ 'enable-snippets'?: boolean;
171
+ 'highlight-current-line'?: boolean;
172
+ 'indent-on-tab'?: boolean;
173
+ /** Width of an indentation step expressed in number of spaces. */
174
+ 'indent-width'?: number;
175
+ /** The property is a [iface@Indenter] to use to indent as the user types into the [class@View]. */
176
+ indenter?: GtkSource.Indenter | null;
177
+ 'insert-spaces-instead-of-tabs'?: boolean;
178
+ /** Position of the right margin. */
179
+ 'right-margin-position'?: number;
180
+ /** Whether to display line mark pixbufs */
181
+ 'show-line-marks'?: boolean;
182
+ /** Whether to display line numbers */
183
+ 'show-line-numbers'?: boolean;
184
+ /** Whether to display the right margin. */
185
+ 'show-right-margin'?: boolean;
186
+ /** Whether smart Backspace should be used. */
187
+ 'smart-backspace'?: boolean;
188
+ /** Set the behavior of the HOME and END keys. */
189
+ 'smart-home-end'?: GtkSourceSmartHomeEndTypeNick | GtkSource.SmartHomeEndType;
190
+ /** Width of a tab character expressed in number of spaces. */
191
+ 'tab-width'?: number;
192
+ }
193
+ /** Settable only at construction — a renderer must REBUILD, not patch. */
194
+ export type GtkSourceViewConstructOnly = GtkTextViewConstructOnly | GtkAccessibleConstructOnly | GtkAccessibleTextConstructOnly | GtkBuildableConstructOnly | GtkConstraintTargetConstructOnly | GtkScrollableConstructOnly;
195
+
196
+ // ---------------------------------------------------------------------------
197
+ // The GType-keyed widget map.
198
+ //
199
+ // Keyed by GType because that is also the GtkBuilder XML key and the typelib key. A
200
+ // consumer maps GTypes to tags in ITS convention — kebab for JSX intrinsics, Pascal
201
+ // for a Vue `GlobalComponents`, the class itself for a renderer whose element type
202
+ // is the class. None of those is baked in here.
203
+ //
204
+ // `slotCandidates` is a candidate list and never an answer: derived from methods
205
+ // taking exactly one widget argument. The GIR cannot tell adoption from reference —
206
+ // `set_title_widget` parents its argument and `set_activatable_widget` does not, and
207
+ // both are `void f(GtkWidget*)` at `transfer-ownership="none"`. Curation decides;
208
+ // this is what notices when a release adds a candidate.
209
+ // ---------------------------------------------------------------------------
210
+
211
+ export interface Widgets {
212
+ GtkSourceCompletionCell: {
213
+ class: GtkSource.CompletionCell;
214
+ props: GtkSourceCompletionCellProps;
215
+ signals: GtkSource.CompletionCell.SignalSignatures;
216
+ constructOnly: GtkSourceCompletionCellConstructOnly;
217
+ slotCandidates: {
218
+ 'widget': 'set_widget';
219
+ };
220
+ };
221
+ GtkSourceGutter: {
222
+ class: GtkSource.Gutter;
223
+ props: GtkSourceGutterProps;
224
+ signals: GtkSource.Gutter.SignalSignatures;
225
+ constructOnly: GtkSourceGutterConstructOnly;
226
+ slotCandidates: {};
227
+ };
228
+ GtkSourceGutterRendererPixbuf: {
229
+ class: GtkSource.GutterRendererPixbuf;
230
+ props: GtkSourceGutterRendererPixbufProps;
231
+ signals: GtkSource.GutterRendererPixbuf.SignalSignatures;
232
+ constructOnly: GtkSourceGutterRendererPixbufConstructOnly;
233
+ slotCandidates: {};
234
+ };
235
+ GtkSourceGutterRendererText: {
236
+ class: GtkSource.GutterRendererText;
237
+ props: GtkSourceGutterRendererTextProps;
238
+ signals: GtkSource.GutterRendererText.SignalSignatures;
239
+ constructOnly: GtkSourceGutterRendererTextConstructOnly;
240
+ slotCandidates: {};
241
+ };
242
+ GtkSourceHoverDisplay: {
243
+ class: GtkSource.HoverDisplay;
244
+ props: GtkSourceHoverDisplayProps;
245
+ signals: GtkSource.HoverDisplay.SignalSignatures;
246
+ constructOnly: GtkSourceHoverDisplayConstructOnly;
247
+ slotCandidates: {};
248
+ };
249
+ GtkSourceMap: {
250
+ class: GtkSource.Map;
251
+ props: GtkSourceMapProps;
252
+ signals: GtkSource.Map.SignalSignatures;
253
+ constructOnly: GtkSourceMapConstructOnly;
254
+ slotCandidates: {
255
+ 'view': 'set_view';
256
+ };
257
+ };
258
+ GtkSourceStyleSchemeChooserButton: {
259
+ class: GtkSource.StyleSchemeChooserButton;
260
+ props: GtkSourceStyleSchemeChooserButtonProps;
261
+ signals: GtkSource.StyleSchemeChooserButton.SignalSignatures;
262
+ constructOnly: GtkSourceStyleSchemeChooserButtonConstructOnly;
263
+ slotCandidates: {};
264
+ };
265
+ GtkSourceStyleSchemeChooserWidget: {
266
+ class: GtkSource.StyleSchemeChooserWidget;
267
+ props: GtkSourceStyleSchemeChooserWidgetProps;
268
+ signals: GtkSource.StyleSchemeChooserWidget.SignalSignatures;
269
+ constructOnly: GtkSourceStyleSchemeChooserWidgetConstructOnly;
270
+ slotCandidates: {};
271
+ };
272
+ GtkSourceStyleSchemePreview: {
273
+ class: GtkSource.StyleSchemePreview;
274
+ props: GtkSourceStyleSchemePreviewProps;
275
+ signals: GtkSource.StyleSchemePreview.SignalSignatures;
276
+ constructOnly: GtkSourceStyleSchemePreviewConstructOnly;
277
+ slotCandidates: {};
278
+ };
279
+ GtkSourceView: {
280
+ class: GtkSource.View;
281
+ props: GtkSourceViewProps;
282
+ signals: GtkSource.View.SignalSignatures;
283
+ constructOnly: GtkSourceViewConstructOnly;
284
+ slotCandidates: {};
285
+ };
286
+ }
287
+
288
+ /** Every GType this namespace can create. A consumer derives its own tag map. */
289
+ export type WidgetGType = keyof Widgets;
290
+
291
+ /** The writable, optional, GObject-keyed property surface of one GType. */
292
+ export type PropsOf<G extends WidgetGType> = Widgets[G]['props'];
293
+
294
+ /** The signal table this package already emits, reached by GType. */
295
+ export type SignalsOf<G extends WidgetGType> = Widgets[G]['signals'];
296
+
297
+ /** The instance type — what a `ref`-shaped prop should infer. */
298
+ export type InstanceOf<G extends WidgetGType> = Widgets[G]['class'];
299
+
300
+ /** Property names that can only be set at construction. */
301
+ export type ConstructOnlyOf<G extends WidgetGType> = Widgets[G]['constructOnly'];
302
+
303
+ /** Candidate child slots — see the note above; curation decides. */
304
+ export type SlotCandidatesOf<G extends WidgetGType> = keyof Widgets[G]['slotCandidates'];
305
+
306
+ /**
307
+ * The same facts as runtime data, for a consumer that CHECKS them.
308
+ *
309
+ * Types are erased, so a spec that asks the installed GTK whether every property
310
+ * here is a writable ParamSpec, every signal resolvable by `GObject.signal_lookup`
311
+ * and every nick resolvable through an enum lookup cannot read the interfaces
312
+ * above. Emitted headlessly with no GTK present, which is exactly why the checking
313
+ * belongs to the consumer and the DATA belongs here.
314
+ */
315
+ export const SURFACE_PROVENANCE: string;
316
+
317
+ /** Declaration GType -> its own settable properties, as GObject registered them. */
318
+ export const OWN_PROPS: Readonly<Record<string, readonly string[]>>;
319
+
320
+ /** Widget GType -> its own signals. */
321
+ export const OWN_SIGNALS: Readonly<Record<string, readonly string[]>>;
322
+
323
+ /** Widget GType -> every declaration its members come from, self first. */
324
+ export const DECLS: Readonly<Record<string, readonly string[]>>;
325
+
326
+ /** Enum GType -> the nicks this surface offers. */
327
+ export const ENUM_NICKS: Readonly<Record<string, readonly string[]>>;
328
+
329
+ /** Widget GType -> slot name -> the method that may adopt a child there. */
330
+ export const SLOT_CANDIDATES: Readonly<Record<string, Readonly<Record<string, string>>>>;
331
+
332
+ /**
333
+ * `Type.property` -> the release that introduced it.
334
+ *
335
+ * What keeps a runtime cross-check honest across a version gap without an
336
+ * allowlist: a member the installed library lacks is a defect UNLESS the version
337
+ * here is newer than the one running.
338
+ */
339
+ export const SINCE: Readonly<Record<string, string>>;
@@ -0,0 +1,64 @@
1
+ // The widget vocabulary of GtkSource-5 as runtime data.
2
+ //
3
+ // GENERATED — do not edit. Provenance: GtkSource-5 — library 5.21.0 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object
4
+ //
5
+ // The type half of this subpath is the sibling `.d.ts`. This file exists because
6
+ // types are erased: a consumer that wants to ask the installed library whether every
7
+ // name here is real needs values, not declarations.
8
+
9
+ export const SURFACE_PROVENANCE = 'GtkSource-5 — library 5.21.0 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object';
10
+
11
+ export const OWN_PROPS = {
12
+ GtkSourceCompletionCell: ['column', 'markup', 'paintable', 'text', 'widget'],
13
+ GtkSourceGutter: ['view', 'window-type'],
14
+ GtkSourceGutterRenderer: ['alignment-mode', 'xalign', 'xpad', 'yalign', 'ypad'],
15
+ GtkSourceGutterRendererPixbuf: ['gicon', 'icon-name', 'paintable', 'pixbuf'],
16
+ GtkSourceGutterRendererText: ['markup', 'text'],
17
+ GtkSourceMap: ['font-desc', 'view'],
18
+ GtkSourceStyleSchemeChooser: ['style-scheme'],
19
+ GtkSourceStyleSchemePreview: ['scheme', 'selected'],
20
+ GtkSourceView: ['auto-indent', 'background-pattern', 'enable-snippets', 'highlight-current-line', 'indent-on-tab', 'indent-width', 'indenter', 'insert-spaces-instead-of-tabs', 'right-margin-position', 'show-line-marks', 'show-line-numbers', 'show-right-margin', 'smart-backspace', 'smart-home-end', 'tab-width'],
21
+ };
22
+
23
+ export const OWN_SIGNALS = {
24
+ GtkSourceStyleSchemePreview: ['activate'],
25
+ GtkSourceView: ['change-case', 'change-number', 'join-lines', 'line-mark-activated', 'move-lines', 'move-to-matching-bracket', 'move-words', 'push-snippet', 'show-completion', 'smart-home-end'],
26
+ };
27
+
28
+ export const DECLS = {
29
+ GtkSourceCompletionCell: ['GtkSourceCompletionCell', 'GtkWidget', 'GtkAccessible', 'GtkBuildable', 'GtkConstraintTarget'],
30
+ GtkSourceGutter: ['GtkSourceGutter', 'GtkWidget', 'GtkAccessible', 'GtkBuildable', 'GtkConstraintTarget'],
31
+ GtkSourceGutterRendererPixbuf: ['GtkSourceGutterRendererPixbuf', 'GtkSourceGutterRenderer', 'GtkWidget', 'GtkAccessible', 'GtkBuildable', 'GtkConstraintTarget'],
32
+ GtkSourceGutterRendererText: ['GtkSourceGutterRendererText', 'GtkSourceGutterRenderer', 'GtkWidget', 'GtkAccessible', 'GtkBuildable', 'GtkConstraintTarget'],
33
+ GtkSourceHoverDisplay: ['GtkSourceHoverDisplay', 'GtkWidget', 'GtkAccessible', 'GtkBuildable', 'GtkConstraintTarget'],
34
+ GtkSourceMap: ['GtkSourceMap', 'GtkSourceView', 'GtkTextView', 'GtkWidget', 'GtkAccessible', 'GtkAccessibleText', 'GtkBuildable', 'GtkConstraintTarget', 'GtkScrollable'],
35
+ GtkSourceStyleSchemeChooserButton: ['GtkSourceStyleSchemeChooserButton', 'GtkButton', 'GtkWidget', 'GtkAccessible', 'GtkActionable', 'GtkBuildable', 'GtkConstraintTarget', 'GtkSourceStyleSchemeChooser'],
36
+ GtkSourceStyleSchemeChooserWidget: ['GtkSourceStyleSchemeChooserWidget', 'GtkWidget', 'GtkAccessible', 'GtkBuildable', 'GtkConstraintTarget', 'GtkSourceStyleSchemeChooser'],
37
+ GtkSourceStyleSchemePreview: ['GtkSourceStyleSchemePreview', 'GtkWidget', 'GtkAccessible', 'GtkActionable', 'GtkBuildable', 'GtkConstraintTarget'],
38
+ GtkSourceView: ['GtkSourceView', 'GtkTextView', 'GtkWidget', 'GtkAccessible', 'GtkAccessibleText', 'GtkBuildable', 'GtkConstraintTarget', 'GtkScrollable'],
39
+ };
40
+
41
+ export const ENUM_NICKS = {
42
+ GtkSourceAnnotationStyle: ['none', 'warning', 'error', 'accent'],
43
+ GtkSourceBackgroundPatternType: ['none', 'grid'],
44
+ GtkSourceBracketMatchType: ['none', 'out-of-range', 'not-found', 'found'],
45
+ GtkSourceChangeCaseType: ['lower', 'upper', 'toggle', 'title'],
46
+ GtkSourceCompletionActivation: ['none', 'interactive', 'user-requested'],
47
+ GtkSourceCompletionColumn: ['icon', 'before', 'typed-text', 'after', 'comment', 'details'],
48
+ GtkSourceCompressionType: ['none', 'gzip'],
49
+ GtkSourceGutterRendererAlignmentMode: ['cell', 'first', 'last'],
50
+ GtkSourceNewlineType: ['lf', 'cr', 'cr-lf'],
51
+ GtkSourceSmartHomeEndType: ['disabled', 'before', 'after', 'always'],
52
+ GtkSourceViewGutterPosition: ['lines', 'marks'],
53
+ };
54
+
55
+ export const SLOT_CANDIDATES = {
56
+ GtkSourceCompletionCell: {
57
+ 'widget': 'set_widget',
58
+ },
59
+ GtkSourceMap: {
60
+ 'view': 'set_view',
61
+ },
62
+ };
63
+
64
+ export const SINCE = {};
package/gtksource-5.d.ts CHANGED
@@ -2386,7 +2386,7 @@ export namespace GtkSource {
2386
2386
  /**
2387
2387
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
2388
2388
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
2389
- * object has some notion of &#x201C;ID&#x201D; and it makes sense to map the XML id
2389
+ * object has some notion of ID and it makes sense to map the XML id
2390
2390
  * attribute to it.
2391
2391
  * @param id
2392
2392
  * @virtual
@@ -3672,6 +3672,7 @@ export namespace GtkSource {
3672
3672
  "notify::file": (pspec: GObject.ParamSpec) => void;
3673
3673
  "notify::input-stream": (pspec: GObject.ParamSpec) => void;
3674
3674
  "notify::location": (pspec: GObject.ParamSpec) => void;
3675
+ "notify::max-size": (pspec: GObject.ParamSpec) => void;
3675
3676
  }
3676
3677
 
3677
3678
  // Constructor properties interface
@@ -3681,6 +3682,8 @@ export namespace GtkSource {
3681
3682
  input_stream: Gio.InputStream | null;
3682
3683
  inputStream: Gio.InputStream | null;
3683
3684
  location: Gio.File | null;
3685
+ max_size: bigint | number;
3686
+ maxSize: bigint | number;
3684
3687
  }
3685
3688
  }
3686
3689
 
@@ -3745,6 +3748,24 @@ export namespace GtkSource {
3745
3748
  */
3746
3749
  get location(): Gio.File | null;
3747
3750
 
3751
+ /**
3752
+ * The maximum expanded size, in bytes, that the loader will insert into
3753
+ * the buffer. A value of 0 disables the limit.
3754
+ * @since 5.22
3755
+ * @default 1073741824
3756
+ */
3757
+ get max_size(): number;
3758
+ set max_size(val: bigint | number);
3759
+
3760
+ /**
3761
+ * The maximum expanded size, in bytes, that the loader will insert into
3762
+ * the buffer. A value of 0 disables the limit.
3763
+ * @since 5.22
3764
+ * @default 1073741824
3765
+ */
3766
+ get maxSize(): number;
3767
+ set maxSize(val: bigint | number);
3768
+
3748
3769
  /**
3749
3770
  * Compile-time signal type information.
3750
3771
  *
@@ -3807,6 +3828,12 @@ export namespace GtkSource {
3807
3828
  */
3808
3829
  get_location(): Gio.File | null;
3809
3830
 
3831
+ /**
3832
+ * Gets the maximum expanded size that `loader` will insert into the buffer.
3833
+ * @returns the maximum expanded size in bytes, or 0 if the limit is disabled.
3834
+ */
3835
+ get_max_size(): number;
3836
+
3810
3837
  /**
3811
3838
  * @returns the detected newline type.
3812
3839
  */
@@ -3873,6 +3900,15 @@ export namespace GtkSource {
3873
3900
  * @param candidate_encodings a list of {@link GtkSource.Encoding}<!-- -->s.
3874
3901
  */
3875
3902
  set_candidate_encodings(candidate_encodings: Encoding[]): void;
3903
+
3904
+ /**
3905
+ * Sets the maximum expanded size that `loader` will insert into the buffer.
3906
+ *
3907
+ * The limit is checked after decompression, so compressed files are limited by
3908
+ * the size of their uncompressed contents rather than their on-disk size.
3909
+ * @param max_size maximum expanded size in bytes, or 0 to disable the limit.
3910
+ */
3911
+ set_max_size(max_size: bigint | number): void;
3876
3912
  }
3877
3913
 
3878
3914
 
@@ -4609,7 +4645,7 @@ export namespace GtkSource {
4609
4645
  /**
4610
4646
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
4611
4647
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
4612
- * object has some notion of &#x201C;ID&#x201D; and it makes sense to map the XML id
4648
+ * object has some notion of ID and it makes sense to map the XML id
4613
4649
  * attribute to it.
4614
4650
  * @param id
4615
4651
  * @virtual
@@ -5565,7 +5601,7 @@ export namespace GtkSource {
5565
5601
  /**
5566
5602
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
5567
5603
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
5568
- * object has some notion of &#x201C;ID&#x201D; and it makes sense to map the XML id
5604
+ * object has some notion of ID and it makes sense to map the XML id
5569
5605
  * attribute to it.
5570
5606
  * @param id
5571
5607
  * @virtual
@@ -6514,7 +6550,7 @@ export namespace GtkSource {
6514
6550
  /**
6515
6551
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
6516
6552
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
6517
- * object has some notion of &#x201C;ID&#x201D; and it makes sense to map the XML id
6553
+ * object has some notion of ID and it makes sense to map the XML id
6518
6554
  * attribute to it.
6519
6555
  * @param id
6520
6556
  * @virtual
@@ -10707,7 +10743,7 @@ export namespace GtkSource {
10707
10743
  * Usually this function is used when the widget is located (or will be
10708
10744
  * located) within the hierarchy of a {@link Gtk.ApplicationWindow}.
10709
10745
  *
10710
- * Names are of the form &#x201C;win.save&#x201D; or &#x201C;app.quit&#x201D; for actions on the
10746
+ * Names are of the form win.save or app.quit for actions on the
10711
10747
  * containing {@link ApplicationWindow} or its associated {@link Application},
10712
10748
  * respectively. This is the same form used for actions in the {@link Gio.Menu}
10713
10749
  * associated with the window.
@@ -10723,14 +10759,14 @@ export namespace GtkSource {
10723
10759
  * The target value has two purposes. First, it is used as the parameter
10724
10760
  * to activation of the action associated with the {@link Gtk.Actionable} widget.
10725
10761
  * Second, it is used to determine if the widget should be rendered as
10726
- * &#x201C;active&#x201D; &#x2014; the widget is active if the state is equal to the given target.
10762
+ * active the widget is active if the state is equal to the given target.
10727
10763
  *
10728
10764
  * Consider the example of associating a set of buttons with a {@link Gio.Action}
10729
- * with string state in a typical &#x201C;radio button&#x201D; situation. Each button
10765
+ * with string state in a typical radio button situation. Each button
10730
10766
  * will be associated with the same action, but with a different target
10731
10767
  * value for that action. Clicking on a particular button will activate
10732
10768
  * the action with the target of that button, which will typically cause
10733
- * the action&#x2019;s state to change to that value. Since the action&#x2019;s state
10769
+ * the actions state to change to that value. Since the actions state
10734
10770
  * is now equal to the target value of the button, the button will now
10735
10771
  * be rendered as active (and the other buttons, with different targets,
10736
10772
  * rendered inactive).
@@ -10770,7 +10806,7 @@ export namespace GtkSource {
10770
10806
  * Usually this function is used when the widget is located (or will be
10771
10807
  * located) within the hierarchy of a {@link Gtk.ApplicationWindow}.
10772
10808
  *
10773
- * Names are of the form &#x201C;win.save&#x201D; or &#x201C;app.quit&#x201D; for actions on the
10809
+ * Names are of the form win.save or app.quit for actions on the
10774
10810
  * containing {@link ApplicationWindow} or its associated {@link Application},
10775
10811
  * respectively. This is the same form used for actions in the {@link Gio.Menu}
10776
10812
  * associated with the window.
@@ -10787,14 +10823,14 @@ export namespace GtkSource {
10787
10823
  * The target value has two purposes. First, it is used as the parameter
10788
10824
  * to activation of the action associated with the {@link Gtk.Actionable} widget.
10789
10825
  * Second, it is used to determine if the widget should be rendered as
10790
- * &#x201C;active&#x201D; &#x2014; the widget is active if the state is equal to the given target.
10826
+ * active the widget is active if the state is equal to the given target.
10791
10827
  *
10792
10828
  * Consider the example of associating a set of buttons with a {@link Gio.Action}
10793
- * with string state in a typical &#x201C;radio button&#x201D; situation. Each button
10829
+ * with string state in a typical radio button situation. Each button
10794
10830
  * will be associated with the same action, but with a different target
10795
10831
  * value for that action. Clicking on a particular button will activate
10796
10832
  * the action with the target of that button, which will typically cause
10797
- * the action&#x2019;s state to change to that value. Since the action&#x2019;s state
10833
+ * the actions state to change to that value. Since the actions state
10798
10834
  * is now equal to the target value of the button, the button will now
10799
10835
  * be rendered as active (and the other buttons, with different targets,
10800
10836
  * rendered inactive).
@@ -11277,7 +11313,7 @@ export namespace GtkSource {
11277
11313
  /**
11278
11314
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
11279
11315
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
11280
- * object has some notion of &#x201C;ID&#x201D; and it makes sense to map the XML id
11316
+ * object has some notion of ID and it makes sense to map the XML id
11281
11317
  * attribute to it.
11282
11318
  * @param id
11283
11319
  * @virtual
@@ -11873,7 +11909,7 @@ export namespace GtkSource {
11873
11909
  * Usually this function is used when the widget is located (or will be
11874
11910
  * located) within the hierarchy of a {@link Gtk.ApplicationWindow}.
11875
11911
  *
11876
- * Names are of the form &#x201C;win.save&#x201D; or &#x201C;app.quit&#x201D; for actions on the
11912
+ * Names are of the form win.save or app.quit for actions on the
11877
11913
  * containing {@link ApplicationWindow} or its associated {@link Application},
11878
11914
  * respectively. This is the same form used for actions in the {@link Gio.Menu}
11879
11915
  * associated with the window.
@@ -11889,14 +11925,14 @@ export namespace GtkSource {
11889
11925
  * The target value has two purposes. First, it is used as the parameter
11890
11926
  * to activation of the action associated with the {@link Gtk.Actionable} widget.
11891
11927
  * Second, it is used to determine if the widget should be rendered as
11892
- * &#x201C;active&#x201D; &#x2014; the widget is active if the state is equal to the given target.
11928
+ * active the widget is active if the state is equal to the given target.
11893
11929
  *
11894
11930
  * Consider the example of associating a set of buttons with a {@link Gio.Action}
11895
- * with string state in a typical &#x201C;radio button&#x201D; situation. Each button
11931
+ * with string state in a typical radio button situation. Each button
11896
11932
  * will be associated with the same action, but with a different target
11897
11933
  * value for that action. Clicking on a particular button will activate
11898
11934
  * the action with the target of that button, which will typically cause
11899
- * the action&#x2019;s state to change to that value. Since the action&#x2019;s state
11935
+ * the actions state to change to that value. Since the actions state
11900
11936
  * is now equal to the target value of the button, the button will now
11901
11937
  * be rendered as active (and the other buttons, with different targets,
11902
11938
  * rendered inactive).
@@ -11936,7 +11972,7 @@ export namespace GtkSource {
11936
11972
  * Usually this function is used when the widget is located (or will be
11937
11973
  * located) within the hierarchy of a {@link Gtk.ApplicationWindow}.
11938
11974
  *
11939
- * Names are of the form &#x201C;win.save&#x201D; or &#x201C;app.quit&#x201D; for actions on the
11975
+ * Names are of the form win.save or app.quit for actions on the
11940
11976
  * containing {@link ApplicationWindow} or its associated {@link Application},
11941
11977
  * respectively. This is the same form used for actions in the {@link Gio.Menu}
11942
11978
  * associated with the window.
@@ -11953,14 +11989,14 @@ export namespace GtkSource {
11953
11989
  * The target value has two purposes. First, it is used as the parameter
11954
11990
  * to activation of the action associated with the {@link Gtk.Actionable} widget.
11955
11991
  * Second, it is used to determine if the widget should be rendered as
11956
- * &#x201C;active&#x201D; &#x2014; the widget is active if the state is equal to the given target.
11992
+ * active the widget is active if the state is equal to the given target.
11957
11993
  *
11958
11994
  * Consider the example of associating a set of buttons with a {@link Gio.Action}
11959
- * with string state in a typical &#x201C;radio button&#x201D; situation. Each button
11995
+ * with string state in a typical radio button situation. Each button
11960
11996
  * will be associated with the same action, but with a different target
11961
11997
  * value for that action. Clicking on a particular button will activate
11962
11998
  * the action with the target of that button, which will typically cause
11963
- * the action&#x2019;s state to change to that value. Since the action&#x2019;s state
11999
+ * the actions state to change to that value. Since the actions state
11964
12000
  * is now equal to the target value of the button, the button will now
11965
12001
  * be rendered as active (and the other buttons, with different targets,
11966
12002
  * rendered inactive).
@@ -12060,7 +12096,7 @@ export namespace GtkSource {
12060
12096
  /**
12061
12097
  * Stores the id attribute given in the {@link Gtk.Builder} UI definition.
12062
12098
  * {@link Gtk.Widget} stores the name as object data. Implement this method if your
12063
- * object has some notion of &#x201C;ID&#x201D; and it makes sense to map the XML id
12099
+ * object has some notion of ID and it makes sense to map the XML id
12064
12100
  * attribute to it.
12065
12101
  * @param id
12066
12102
  * @virtual
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@girs/gtksource-5",
3
- "version": "4.1.0",
4
- "libraryVersion": "5.20.0",
5
- "description": "GJS TypeScript type definitions for GtkSource-5, generated from library version 5.20.0",
3
+ "version": "4.3.0",
4
+ "libraryVersion": "5.21.0",
5
+ "description": "GJS TypeScript type definitions for GtkSource-5, generated from library version 5.21.0",
6
6
  "type": "module",
7
7
  "module": "gtksource-5.js",
8
8
  "main": "gtksource-5.js",
@@ -17,6 +17,11 @@
17
17
  "import": "./gtksource-5-import.js",
18
18
  "default": "./gtksource-5-import.js"
19
19
  },
20
+ "./surface": {
21
+ "types": "./gtksource-5-surface.d.ts",
22
+ "import": "./gtksource-5-surface.js",
23
+ "default": "./gtksource-5-surface.js"
24
+ },
20
25
  "./gtksource-5": {
21
26
  "types": "./gtksource-5.d.ts",
22
27
  "import": "./gtksource-5.js",
@@ -32,21 +37,21 @@
32
37
  "test": "tsc --project tsconfig.json"
33
38
  },
34
39
  "dependencies": {
35
- "@girs/gjs": "^4.1.0",
36
- "@girs/gtk-4.0": "^4.1.0",
37
- "@girs/gsk-4.0": "^4.1.0",
38
- "@girs/graphene-1.0": "^4.1.0",
39
- "@girs/gobject-2.0": "^4.1.0",
40
- "@girs/glib-2.0": "^4.1.0",
41
- "@girs/gdk-4.0": "^4.1.0",
42
- "@girs/cairo-1.0": "^4.1.0",
43
- "@girs/pangocairo-1.0": "^4.1.0",
44
- "@girs/pango-1.0": "^4.1.0",
45
- "@girs/harfbuzz-0.0": "^4.1.0",
46
- "@girs/freetype2-2.0": "^4.1.0",
47
- "@girs/gio-2.0": "^4.1.0",
48
- "@girs/gmodule-2.0": "^4.1.0",
49
- "@girs/gdkpixbuf-2.0": "^4.1.0" },
40
+ "@girs/gjs": "^4.3.0",
41
+ "@girs/gtk-4.0": "^4.3.0",
42
+ "@girs/gsk-4.0": "^4.3.0",
43
+ "@girs/graphene-1.0": "^4.3.0",
44
+ "@girs/gobject-2.0": "^4.3.0",
45
+ "@girs/glib-2.0": "^4.3.0",
46
+ "@girs/gdk-4.0": "^4.3.0",
47
+ "@girs/cairo-1.0": "^4.3.0",
48
+ "@girs/pangocairo-1.0": "^4.3.0",
49
+ "@girs/pango-1.0": "^4.3.0",
50
+ "@girs/harfbuzz-0.0": "^4.3.0",
51
+ "@girs/freetype2-2.0": "^4.3.0",
52
+ "@girs/gio-2.0": "^4.3.0",
53
+ "@girs/gmodule-2.0": "^4.3.0",
54
+ "@girs/gdkpixbuf-2.0": "^4.3.0" },
50
55
  "devDependencies": {
51
56
  "typescript": "*"
52
57
  },
package/tsconfig.json CHANGED
@@ -65,7 +65,7 @@
65
65
  ]
66
66
  }
67
67
  },
68
- "include": ["./gtksource-5.d.ts"]
68
+ "include": ["./gtksource-5.d.ts","./gtksource-5-surface.d.ts"]
69
69
  }
70
70
 
71
71