@girs/bamf-3 3.0.0-4.0.0-beta.39 → 3.0.0-4.0.0-beta.41

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,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/bamf-3)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Bamf-3, generated from library version 3.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.39.
8
+ GJS TypeScript type definitions for Bamf-3, generated from library version 3.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.41.
9
9
 
10
10
  ## Install
11
11
 
package/bamf-3.d.ts CHANGED
@@ -18,10 +18,9 @@ export namespace Bamf {
18
18
  * Bamf-3
19
19
  */
20
20
 
21
- export namespace ClickBehavior {
22
- export const $gtype: GObject.GType<ClickBehavior>;
23
- }
24
-
21
+ /**
22
+ * @gir-type Enum
23
+ */
25
24
  enum ClickBehavior {
26
25
  NONE,
27
26
  OPEN,
@@ -33,10 +32,9 @@ export namespace Bamf {
33
32
  PICKER,
34
33
  }
35
34
 
36
- export namespace WindowMaximizationType {
37
- export const $gtype: GObject.GType<WindowMaximizationType>;
38
- }
39
-
35
+ /**
36
+ * @gir-type Enum
37
+ */
40
38
  enum WindowMaximizationType {
41
39
  FLOATING,
42
40
  HORIZONTAL_MAXIMIZED,
@@ -44,10 +42,9 @@ export namespace Bamf {
44
42
  MAXIMIZED,
45
43
  }
46
44
 
47
- export namespace WindowType {
48
- export const $gtype: GObject.GType<WindowType>;
49
- }
50
-
45
+ /**
46
+ * @gir-type Enum
47
+ */
51
48
  enum WindowType {
52
49
  NORMAL,
53
50
  DESKTOP,
@@ -59,6 +56,7 @@ export namespace Bamf {
59
56
  SPLASHSCREEN,
60
57
  UNKNOWN,
61
58
  }
59
+
62
60
  const APPLICATION_SIGNAL_DESKTOP_FILE_UPDATED: string;
63
61
  const APPLICATION_SIGNAL_WINDOW_ADDED: string;
64
62
  const APPLICATION_SIGNAL_WINDOW_REMOVED: string;
@@ -80,14 +78,26 @@ export namespace Bamf {
80
78
  const VIEW_SIGNAL_USER_VISIBLE_CHANGED: string;
81
79
  const WINDOW_SIGNAL_MAXIMIZED_CHANGED: string;
82
80
  const WINDOW_SIGNAL_MONITOR_CHANGED: string;
81
+ /**
82
+ * @gir-type Callback
83
+ */
83
84
  interface TabPreviewReadyCallback {
84
85
  (self: Tab, preview_data: string): void;
85
86
  }
86
87
  namespace Application {
87
88
  // Signal signatures
88
89
  interface SignalSignatures extends View.SignalSignatures {
90
+ /**
91
+ * @signal
92
+ */
89
93
  'desktop-file-updated': (arg0: string) => void;
94
+ /**
95
+ * @signal
96
+ */
90
97
  'window-added': (arg0: Window) => void;
98
+ /**
99
+ * @signal
100
+ */
91
101
  'window-removed': (arg0: Window) => void;
92
102
  'notify::active': (pspec: GObject.ParamSpec) => void;
93
103
  'notify::path': (pspec: GObject.ParamSpec) => void;
@@ -102,6 +112,9 @@ export namespace Bamf {
102
112
  interface ConstructorProps extends View.ConstructorProps {}
103
113
  }
104
114
 
115
+ /**
116
+ * @gir-type Class
117
+ */
105
118
  class Application extends View {
106
119
  static $gtype: GObject.GType<Application>;
107
120
 
@@ -122,16 +135,19 @@ export namespace Bamf {
122
135
 
123
136
  // Signals
124
137
 
138
+ /** @signal */
125
139
  connect<K extends keyof Application.SignalSignatures>(
126
140
  signal: K,
127
141
  callback: GObject.SignalCallback<this, Application.SignalSignatures[K]>,
128
142
  ): number;
129
143
  connect(signal: string, callback: (...args: any[]) => any): number;
144
+ /** @signal */
130
145
  connect_after<K extends keyof Application.SignalSignatures>(
131
146
  signal: K,
132
147
  callback: GObject.SignalCallback<this, Application.SignalSignatures[K]>,
133
148
  ): number;
134
149
  connect_after(signal: string, callback: (...args: any[]) => any): number;
150
+ /** @signal */
135
151
  emit<K extends keyof Application.SignalSignatures>(
136
152
  signal: K,
137
153
  ...args: GObject.GjsParameters<Application.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
@@ -142,7 +158,7 @@ export namespace Bamf {
142
158
 
143
159
  /**
144
160
  * Used to fetch the bus name and the object path of the remote application menu.
145
- * @returns %TRUE if found, %FALSE otherwise.
161
+ * @returns `true` if found, `false` otherwise.
146
162
  */
147
163
  get_application_menu(): [boolean, string, string];
148
164
  get_application_type(): string;
@@ -152,26 +168,32 @@ export namespace Bamf {
152
168
  * @returns A string representing the path to the desktop file.
153
169
  */
154
170
  get_desktop_file(): string;
171
+ /**
172
+ * @returns The focusable child for this application.
173
+ */
155
174
  get_focusable_child(): View;
156
175
  /**
157
176
  * Used to discover whether the application wants menu stubs shown.
158
177
  * @returns Whether the stubs should be shown.
159
178
  */
160
179
  get_show_menu_stubs(): boolean;
180
+ /**
181
+ * @returns A string array containing the supported mime-types.
182
+ */
161
183
  get_supported_mime_types(): string[];
162
184
  /**
163
185
  * Used to fetch the application contains a Window with given `xid`.
164
186
  * @param xid an X11 Window ID
165
- * @returns a #BamfWindow for the passed @xid or %NULL if not found.
187
+ * @returns a {@link Bamf.Window} for the passed `xid` or `null` if not found.
166
188
  */
167
189
  get_window_for_xid(xid: number): Window;
168
190
  /**
169
- * Used to fetch all #BamfWindow's associated with the passed #BamfApplication.
170
- * @returns A list of #BamfWindow's.
191
+ * Used to fetch all {@link Bamf.Window}'s associated with the passed {@link Bamf.Application}.
192
+ * @returns A list of {@link Bamf.Window}'s.
171
193
  */
172
194
  get_windows(): Window[];
173
195
  /**
174
- * Used to fetch all #BamfWindow's xids associated with the passed #BamfApplication.
196
+ * Used to fetch all {@link Bamf.Window}'s xids associated with the passed {@link Bamf.Application}.
175
197
  * @returns An array of xids.
176
198
  */
177
199
  get_xids(): number[];
@@ -186,6 +208,9 @@ export namespace Bamf {
186
208
  interface ConstructorProps extends GObject.Object.ConstructorProps {}
187
209
  }
188
210
 
211
+ /**
212
+ * @gir-type Class
213
+ */
189
214
  class Control extends GObject.Object {
190
215
  static $gtype: GObject.GType<Control>;
191
216
 
@@ -206,16 +231,19 @@ export namespace Bamf {
206
231
 
207
232
  // Signals
208
233
 
234
+ /** @signal */
209
235
  connect<K extends keyof Control.SignalSignatures>(
210
236
  signal: K,
211
237
  callback: GObject.SignalCallback<this, Control.SignalSignatures[K]>,
212
238
  ): number;
213
239
  connect(signal: string, callback: (...args: any[]) => any): number;
240
+ /** @signal */
214
241
  connect_after<K extends keyof Control.SignalSignatures>(
215
242
  signal: K,
216
243
  callback: GObject.SignalCallback<this, Control.SignalSignatures[K]>,
217
244
  ): number;
218
245
  connect_after(signal: string, callback: (...args: any[]) => any): number;
246
+ /** @signal */
219
247
  emit<K extends keyof Control.SignalSignatures>(
220
248
  signal: K,
221
249
  ...args: GObject.GjsParameters<Control.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
@@ -228,19 +256,47 @@ export namespace Bamf {
228
256
 
229
257
  // Methods
230
258
 
259
+ /**
260
+ * @param application
261
+ */
231
262
  create_local_desktop_file(application: Application): void;
263
+ /**
264
+ * @param desktop_file
265
+ */
232
266
  insert_desktop_file(desktop_file: string): void;
267
+ /**
268
+ * @param desktop_file
269
+ * @param pid
270
+ */
233
271
  register_application_for_pid(desktop_file: string, pid: number): void;
272
+ /**
273
+ * @param behavior
274
+ */
234
275
  set_approver_behavior(behavior: number): void;
235
276
  }
236
277
 
237
278
  namespace Matcher {
238
279
  // Signal signatures
239
280
  interface SignalSignatures extends GObject.Object.SignalSignatures {
281
+ /**
282
+ * @signal
283
+ */
240
284
  'active-application-changed': (arg0: Application, arg1: Application) => void;
285
+ /**
286
+ * @signal
287
+ */
241
288
  'active-window-changed': (arg0: Window, arg1: Window) => void;
289
+ /**
290
+ * @signal
291
+ */
242
292
  'stacking-order-changed': () => void;
293
+ /**
294
+ * @signal
295
+ */
243
296
  'view-closed': (arg0: View) => void;
297
+ /**
298
+ * @signal
299
+ */
244
300
  'view-opened': (arg0: View) => void;
245
301
  }
246
302
 
@@ -249,6 +305,9 @@ export namespace Bamf {
249
305
  interface ConstructorProps extends GObject.Object.ConstructorProps {}
250
306
  }
251
307
 
308
+ /**
309
+ * @gir-type Class
310
+ */
252
311
  class Matcher extends GObject.Object {
253
312
  static $gtype: GObject.GType<Matcher>;
254
313
 
@@ -269,16 +328,19 @@ export namespace Bamf {
269
328
 
270
329
  // Signals
271
330
 
331
+ /** @signal */
272
332
  connect<K extends keyof Matcher.SignalSignatures>(
273
333
  signal: K,
274
334
  callback: GObject.SignalCallback<this, Matcher.SignalSignatures[K]>,
275
335
  ): number;
276
336
  connect(signal: string, callback: (...args: any[]) => any): number;
337
+ /** @signal */
277
338
  connect_after<K extends keyof Matcher.SignalSignatures>(
278
339
  signal: K,
279
340
  callback: GObject.SignalCallback<this, Matcher.SignalSignatures[K]>,
280
341
  ): number;
281
342
  connect_after(signal: string, callback: (...args: any[]) => any): number;
343
+ /** @signal */
282
344
  emit<K extends keyof Matcher.SignalSignatures>(
283
345
  signal: K,
284
346
  ...args: GObject.GjsParameters<Matcher.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
@@ -294,52 +356,60 @@ export namespace Bamf {
294
356
 
295
357
  // Methods
296
358
 
359
+ /**
360
+ * @param desktop_file
361
+ */
297
362
  application_is_running(desktop_file: string): boolean;
298
363
  /**
299
- * Used to fetch the active #BamfApplication.
300
- * @returns The active #BamfApplication.
364
+ * Used to fetch the active {@link Bamf.Application}.
365
+ * @returns The active {@link Bamf.Application}.
301
366
  */
302
367
  get_active_application(): Application;
303
368
  /**
304
- * Used to fetch the active #BamfWindow.
305
- * @returns The active #BamfWindow.
369
+ * Used to fetch the active {@link Bamf.Window}.
370
+ * @returns The active {@link Bamf.Window}.
306
371
  */
307
372
  get_active_window(): Window;
373
+ /**
374
+ * @param desktop_file_path Path to the desktop file
375
+ * @param create_if_not_found Create a {@link Bamf.Application} if one isn't found
376
+ * @returns A {@link Bamf.Application} for given desktop file.
377
+ */
308
378
  get_application_for_desktop_file(desktop_file_path: string, create_if_not_found: boolean): Application;
309
379
  /**
310
- * Used to fetch the #BamfApplication containing the passed window.
380
+ * Used to fetch the {@link Bamf.Application} containing the passed window.
311
381
  * @param window The window to look for
312
- * @returns The #BamfApplication representing the xid passed, or NULL if none exists.
382
+ * @returns The {@link Bamf.Application} representing the xid passed, or NULL if none exists.
313
383
  */
314
384
  get_application_for_window(window: Window): Application;
315
385
  /**
316
- * Used to fetch the #BamfApplication containing the passed xid.
386
+ * Used to fetch the {@link Bamf.Application} containing the passed xid.
317
387
  * @param xid The XID to search for
318
- * @returns The #BamfApplication representing the xid passed, or NULL if none exists.
388
+ * @returns The {@link Bamf.Application} representing the xid passed, or NULL if none exists.
319
389
  */
320
390
  get_application_for_xid(xid: number): Application;
321
391
  /**
322
- * Used to fetch all #BamfApplication's running or not. Application authors who wish to only
392
+ * Used to fetch all {@link Bamf.Application}'s running or not. Application authors who wish to only
323
393
  * see running applications should use bamf_matcher_get_running_applications instead. The reason
324
394
  * this method is needed is bamf will occasionally track applications which are not currently
325
395
  * running for nefarious purposes.
326
- * @returns A list of #BamfApplication's.
396
+ * @returns A list of {@link Bamf.Application}'s.
327
397
  */
328
398
  get_applications(): Application[];
329
399
  /**
330
- * Used to fetch all #BamfApplication's which are running.
331
- * @returns A list of #BamfApplication's.
400
+ * Used to fetch all {@link Bamf.Application}'s which are running.
401
+ * @returns A list of {@link Bamf.Application}'s.
332
402
  */
333
403
  get_running_applications(): Application[];
334
404
  /**
335
- * Used to fetch all #BamfView's representing tabs. Currently unused.
336
- * @returns A list of #BamfTab's.
405
+ * Used to fetch all {@link Bamf.View}'s representing tabs. Currently unused.
406
+ * @returns A list of {@link Bamf.Tab}'s.
337
407
  */
338
408
  get_tabs(): Tab[];
339
409
  /**
340
- * Used to fetch the #BamfWindow that wraps the given `window`.
410
+ * Used to fetch the {@link Bamf.Window} that wraps the given `window`.
341
411
  * @param xid The X11 Window ID to search for
342
- * @returns The #BamfWindow representing the xid passed, or NULL if none exists.
412
+ * @returns The {@link Bamf.Window} representing the xid passed, or NULL if none exists.
343
413
  */
344
414
  get_window_for_xid(xid: number): Window;
345
415
  /**
@@ -347,12 +417,12 @@ export namespace Bamf {
347
417
  * in stacking bottom-to-top order. If the `monitor` is set to a negative value,
348
418
  * then it fetches all the available windows in all monitors.
349
419
  * @param monitor the monitor you want the stack from, negative value to get all
350
- * @returns A list of #BamfWindow's.
420
+ * @returns A list of {@link Bamf.Window}'s.
351
421
  */
352
422
  get_window_stack_for_monitor(monitor: number): Window[];
353
423
  /**
354
424
  * Used to fetch all windows that BAMF knows about.
355
- * @returns A list of #BamfWindow's.
425
+ * @returns A list of {@link Bamf.Window}'s.
356
426
  */
357
427
  get_windows(): Window[];
358
428
  /**
@@ -396,16 +466,37 @@ export namespace Bamf {
396
466
  }
397
467
  }
398
468
 
469
+ /**
470
+ * @gir-type Class
471
+ */
399
472
  class Tab extends View {
400
473
  static $gtype: GObject.GType<Tab>;
401
474
 
402
475
  // Properties
403
476
 
477
+ /**
478
+ * @read-only
479
+ */
404
480
  get desktop_id(): string;
481
+ /**
482
+ * @read-only
483
+ */
405
484
  get desktopId(): string;
485
+ /**
486
+ * @read-only
487
+ */
406
488
  get is_foreground_tab(): boolean;
489
+ /**
490
+ * @read-only
491
+ */
407
492
  get isForegroundTab(): boolean;
493
+ /**
494
+ * @read-only
495
+ */
408
496
  get location(): string;
497
+ /**
498
+ * @read-only
499
+ */
409
500
  get xid(): number;
410
501
 
411
502
  /**
@@ -425,16 +516,19 @@ export namespace Bamf {
425
516
 
426
517
  // Signals
427
518
 
519
+ /** @signal */
428
520
  connect<K extends keyof Tab.SignalSignatures>(
429
521
  signal: K,
430
522
  callback: GObject.SignalCallback<this, Tab.SignalSignatures[K]>,
431
523
  ): number;
432
524
  connect(signal: string, callback: (...args: any[]) => any): number;
525
+ /** @signal */
433
526
  connect_after<K extends keyof Tab.SignalSignatures>(
434
527
  signal: K,
435
528
  callback: GObject.SignalCallback<this, Tab.SignalSignatures[K]>,
436
529
  ): number;
437
530
  connect_after(signal: string, callback: (...args: any[]) => any): number;
531
+ /** @signal */
438
532
  emit<K extends keyof Tab.SignalSignatures>(
439
533
  signal: K,
440
534
  ...args: GObject.GjsParameters<Tab.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
@@ -445,12 +539,20 @@ export namespace Bamf {
445
539
 
446
540
  /**
447
541
  * Returns the desktop file for the tab.
542
+ * @virtual
448
543
  */
449
544
  vfunc_get_desktop_name(): string;
545
+ /**
546
+ * @virtual
547
+ */
450
548
  vfunc_get_is_foreground_tab(): boolean;
549
+ /**
550
+ * @virtual
551
+ */
451
552
  vfunc_get_location(): string;
452
553
  /**
453
554
  * The desktop file for the tab.
555
+ * @virtual
454
556
  */
455
557
  vfunc_get_xid(): number;
456
558
 
@@ -458,14 +560,17 @@ export namespace Bamf {
458
560
 
459
561
  /**
460
562
  * Closes the selected `self` tab.
461
- * @returns %TRUE if success, %FALSE otherwise.
563
+ * @returns `true` if success, `false` otherwise.
462
564
  */
463
565
  close(): boolean;
464
566
  /**
465
567
  * Returns the desktop file for the tab.
466
- * @returns The tab desktop id or %NULL if not set or available. Do not free the returned value, it belongs to @self.
568
+ * @returns The tab desktop id or `null` if not set or available. Do not free the returned value, it belongs to `self`.
467
569
  */
468
570
  get_desktop_name(): string;
571
+ /**
572
+ * @returns `true` if the tab is the active one on parent window XID, `false` otherwise.
573
+ */
469
574
  get_is_foreground_tab(): boolean;
470
575
  get_location(): string;
471
576
  /**
@@ -475,25 +580,70 @@ export namespace Bamf {
475
580
  get_xid(): number;
476
581
  /**
477
582
  * Selects the `self` tab in the parent window.
478
- * @returns %TRUE if success, %FALSE otherwise.
583
+ * @returns `true` if success, `false` otherwise.
479
584
  */
480
585
  raise(): boolean;
586
+ /**
587
+ * @param callback a callback function to call when the result is ready
588
+ */
481
589
  request_preview(callback: TabPreviewReadyCallback): void;
482
590
  }
483
591
 
484
592
  namespace View {
485
593
  // Signal signatures
486
594
  interface SignalSignatures extends GObject.InitiallyUnowned.SignalSignatures {
595
+ /**
596
+ * @signal
597
+ * @run-first
598
+ */
487
599
  'active-changed': (arg0: boolean) => void;
600
+ /**
601
+ * @signal
602
+ * @run-first
603
+ */
488
604
  'child-added': (arg0: View) => void;
605
+ /**
606
+ * @signal
607
+ * @run-first
608
+ */
489
609
  'child-moved': (arg0: View) => void;
610
+ /**
611
+ * @signal
612
+ * @run-first
613
+ */
490
614
  'child-removed': (arg0: View) => void;
615
+ /**
616
+ * @signal
617
+ * @run-last
618
+ */
491
619
  closed: () => void;
620
+ /**
621
+ * @signal
622
+ */
492
623
  'icon-changed': (arg0: string) => void;
624
+ /**
625
+ * @signal
626
+ */
493
627
  'name-changed': (arg0: string, arg1: string) => void;
628
+ /**
629
+ * @signal
630
+ * @run-first
631
+ */
494
632
  'running-changed': (arg0: boolean) => void;
633
+ /**
634
+ * @signal
635
+ * @run-first
636
+ */
495
637
  'starting-changed': (arg0: boolean) => void;
638
+ /**
639
+ * @signal
640
+ * @run-first
641
+ */
496
642
  'urgent-changed': (arg0: boolean) => void;
643
+ /**
644
+ * @signal
645
+ * @run-first
646
+ */
497
647
  'user-visible-changed': (arg0: boolean) => void;
498
648
  'notify::active': (pspec: GObject.ParamSpec) => void;
499
649
  'notify::path': (pspec: GObject.ParamSpec) => void;
@@ -516,17 +666,41 @@ export namespace Bamf {
516
666
  }
517
667
  }
518
668
 
669
+ /**
670
+ * @gir-type Class
671
+ */
519
672
  class View extends GObject.InitiallyUnowned {
520
673
  static $gtype: GObject.GType<View>;
521
674
 
522
675
  // Properties
523
676
 
677
+ /**
678
+ * @read-only
679
+ */
524
680
  get active(): boolean;
681
+ /**
682
+ * @read-only
683
+ */
525
684
  get path(): string;
685
+ /**
686
+ * @read-only
687
+ */
526
688
  get running(): boolean;
689
+ /**
690
+ * @read-only
691
+ */
527
692
  get starting(): boolean;
693
+ /**
694
+ * @read-only
695
+ */
528
696
  get urgent(): boolean;
697
+ /**
698
+ * @read-only
699
+ */
529
700
  get user_visible(): boolean;
701
+ /**
702
+ * @read-only
703
+ */
530
704
  get userVisible(): boolean;
531
705
 
532
706
  /**
@@ -546,16 +720,19 @@ export namespace Bamf {
546
720
 
547
721
  // Signals
548
722
 
723
+ /** @signal */
549
724
  connect<K extends keyof View.SignalSignatures>(
550
725
  signal: K,
551
726
  callback: GObject.SignalCallback<this, View.SignalSignatures[K]>,
552
727
  ): number;
553
728
  connect(signal: string, callback: (...args: any[]) => any): number;
729
+ /** @signal */
554
730
  connect_after<K extends keyof View.SignalSignatures>(
555
731
  signal: K,
556
732
  callback: GObject.SignalCallback<this, View.SignalSignatures[K]>,
557
733
  ): number;
558
734
  connect_after(signal: string, callback: (...args: any[]) => any): number;
735
+ /** @signal */
559
736
  emit<K extends keyof View.SignalSignatures>(
560
737
  signal: K,
561
738
  ...args: GObject.GjsParameters<View.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
@@ -564,52 +741,118 @@ export namespace Bamf {
564
741
 
565
742
  // Virtual methods
566
743
 
744
+ /**
745
+ * @param active
746
+ * @virtual
747
+ */
567
748
  vfunc_active_changed(active: boolean): void;
749
+ /**
750
+ * @param child
751
+ * @virtual
752
+ */
568
753
  vfunc_child_added(child: View): void;
754
+ /**
755
+ * @param child
756
+ * @virtual
757
+ */
569
758
  vfunc_child_moved(child: View): void;
759
+ /**
760
+ * @param child
761
+ * @virtual
762
+ */
570
763
  vfunc_child_removed(child: View): void;
764
+ /**
765
+ * @virtual
766
+ */
571
767
  vfunc_click_behavior(): ClickBehavior;
768
+ /**
769
+ * @virtual
770
+ */
572
771
  vfunc_closed(): void;
573
772
  /**
574
773
  * Note: Makes sever dbus calls the first time this is called on a view. Dbus messaging is reduced afterwards.
774
+ * @virtual
575
775
  */
576
776
  vfunc_get_children(): View[];
577
777
  /**
578
778
  * Gets the icon of a view. This icon is used to visually represent the view.
779
+ * @virtual
579
780
  */
580
781
  vfunc_get_icon(): string;
581
782
  /**
582
783
  * Gets the name of a view. This name is a short name best used to represent the view with text.
784
+ * @virtual
583
785
  */
584
786
  vfunc_get_name(): string;
787
+ /**
788
+ * @param icon
789
+ * @virtual
790
+ */
585
791
  vfunc_icon_changed(icon: string): void;
586
792
  /**
587
793
  * Determines if the view is currently active and focused by the user. Useful for an active window indicator.
794
+ * @virtual
588
795
  */
589
796
  vfunc_is_active(): boolean;
590
797
  /**
591
798
  * Determines if the view is currently running. Useful for a running window indicator.
799
+ * @virtual
592
800
  */
593
801
  vfunc_is_running(): boolean;
594
802
  /**
595
803
  * Determines if the view is currently starting. Useful for the startup animation.
804
+ * @virtual
596
805
  */
597
806
  vfunc_is_starting(): boolean;
598
807
  /**
599
808
  * Determines if the view is currently requiring attention. Useful for a running window indicator.
809
+ * @virtual
600
810
  */
601
811
  vfunc_is_urgent(): boolean;
812
+ /**
813
+ * @virtual
814
+ */
602
815
  vfunc_is_user_visible(): boolean;
816
+ /**
817
+ * @param old_name
818
+ * @param new_name
819
+ * @virtual
820
+ */
603
821
  vfunc_name_changed(old_name: string, new_name: string): void;
822
+ /**
823
+ * @param running
824
+ * @virtual
825
+ */
604
826
  vfunc_running_changed(running: boolean): void;
827
+ /**
828
+ * @param path
829
+ * @virtual
830
+ */
605
831
  vfunc_set_path(path: string): void;
832
+ /**
833
+ * @param value
834
+ * @virtual
835
+ */
606
836
  vfunc_set_sticky(value: boolean): void;
837
+ /**
838
+ * @param starting
839
+ * @virtual
840
+ */
607
841
  vfunc_starting_changed(starting: boolean): void;
842
+ /**
843
+ * @param urgent
844
+ * @virtual
845
+ */
608
846
  vfunc_urgent_changed(urgent: boolean): void;
847
+ /**
848
+ * @param user_visible
849
+ * @virtual
850
+ */
609
851
  vfunc_user_visible_changed(user_visible: boolean): void;
610
852
  /**
611
853
  * The view type of a window is a short string used to represent all views of the same class. These
612
854
  * descriptions should not be used to do casting as they are not considered stable.
855
+ * @virtual
613
856
  */
614
857
  vfunc_view_type(): string;
615
858
 
@@ -617,7 +860,7 @@ export namespace Bamf {
617
860
 
618
861
  /**
619
862
  * Note: Makes sever dbus calls the first time this is called on a view. Dbus messaging is reduced afterwards.
620
- * @returns Returns a list of #BamfView which must be freed after usage. Elements of the list are owned by bamf and should not be unreffed.
863
+ * @returns Returns a list of {@link Bamf.View} which must be freed after usage. Elements of the list are owned by bamf and should not be unreffed.
621
864
  */
622
865
  get_children(): View[];
623
866
  get_click_suggestion(): ClickBehavior;
@@ -634,6 +877,10 @@ export namespace Bamf {
634
877
  * descriptions should not be used to do casting as they are not considered stable.
635
878
  */
636
879
  get_view_type(): string;
880
+ /**
881
+ * @param child
882
+ * @returns `true` whether the {@link Bamf.View} `view` has the specified `child`.
883
+ */
637
884
  has_child(child: View): boolean;
638
885
  /**
639
886
  * Determines if the view is currently active and focused by the user. Useful for an active window indicator.
@@ -656,20 +903,34 @@ export namespace Bamf {
656
903
  * Determines if the view is currently requiring attention. Useful for a running window indicator.
657
904
  */
658
905
  is_urgent(): boolean;
906
+ /**
907
+ * @returns a boolean useful for determining if a particular view is "user visible". User visible is a concept relating to whether or not a window should be shown in a launcher tasklist.
908
+ */
659
909
  is_user_visible(): boolean;
660
910
  /**
661
911
  * Note: Makes sever dbus calls the first time this is called on a view.
662
912
  * Dbus messaging is reduced afterwards.
663
- * @returns Returns a list of #BamfView which is owned by the #BamfView and should not freed or modified after usage.
913
+ * @returns Returns a list of {@link Bamf.View} which is owned by the {@link Bamf.View} and should not freed or modified after usage.
664
914
  */
665
915
  peek_children(): View[];
916
+ /**
917
+ * @param value
918
+ */
666
919
  set_sticky(value: boolean): void;
667
920
  }
668
921
 
669
922
  namespace Window {
670
923
  // Signal signatures
671
924
  interface SignalSignatures extends View.SignalSignatures {
925
+ /**
926
+ * @signal
927
+ * @run-first
928
+ */
672
929
  'maximized-changed': (arg0: number, arg1: number) => void;
930
+ /**
931
+ * @signal
932
+ * @run-first
933
+ */
673
934
  'monitor-changed': (arg0: number, arg1: number) => void;
674
935
  'notify::active': (pspec: GObject.ParamSpec) => void;
675
936
  'notify::path': (pspec: GObject.ParamSpec) => void;
@@ -684,6 +945,9 @@ export namespace Bamf {
684
945
  interface ConstructorProps extends View.ConstructorProps {}
685
946
  }
686
947
 
948
+ /**
949
+ * @gir-type Class
950
+ */
687
951
  class Window extends View {
688
952
  static $gtype: GObject.GType<Window>;
689
953
 
@@ -704,16 +968,19 @@ export namespace Bamf {
704
968
 
705
969
  // Signals
706
970
 
971
+ /** @signal */
707
972
  connect<K extends keyof Window.SignalSignatures>(
708
973
  signal: K,
709
974
  callback: GObject.SignalCallback<this, Window.SignalSignatures[K]>,
710
975
  ): number;
711
976
  connect(signal: string, callback: (...args: any[]) => any): number;
977
+ /** @signal */
712
978
  connect_after<K extends keyof Window.SignalSignatures>(
713
979
  signal: K,
714
980
  callback: GObject.SignalCallback<this, Window.SignalSignatures[K]>,
715
981
  ): number;
716
982
  connect_after(signal: string, callback: (...args: any[]) => any): number;
983
+ /** @signal */
717
984
  emit<K extends keyof Window.SignalSignatures>(
718
985
  signal: K,
719
986
  ...args: GObject.GjsParameters<Window.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
@@ -722,22 +989,63 @@ export namespace Bamf {
722
989
 
723
990
  // Virtual methods
724
991
 
992
+ /**
993
+ * @virtual
994
+ */
725
995
  vfunc_get_monitor(): number;
996
+ /**
997
+ * @virtual
998
+ */
726
999
  vfunc_get_pid(): number;
727
- vfunc_get_transient(): Window;
1000
+ /**
1001
+ * @virtual
1002
+ */
1003
+ vfunc_get_transient(): Window | null;
1004
+ /**
1005
+ * @param prop
1006
+ * @virtual
1007
+ */
728
1008
  vfunc_get_utf8_prop(prop: string): string;
1009
+ /**
1010
+ * @virtual
1011
+ */
729
1012
  vfunc_get_window_type(): WindowType;
1013
+ /**
1014
+ * @virtual
1015
+ */
730
1016
  vfunc_get_xid(): number;
1017
+ /**
1018
+ * @virtual
1019
+ */
731
1020
  vfunc_last_active(): number;
1021
+ /**
1022
+ * @virtual
1023
+ */
732
1024
  vfunc_maximized(): WindowMaximizationType;
1025
+ /**
1026
+ * @param old_value
1027
+ * @param new_value
1028
+ * @virtual
1029
+ */
733
1030
  vfunc_maximized_changed(old_value: number, new_value: number): void;
1031
+ /**
1032
+ * @param old_value
1033
+ * @param new_value
1034
+ * @virtual
1035
+ */
734
1036
  vfunc_monitor_changed(old_value: number, new_value: number): void;
735
1037
 
736
1038
  // Methods
737
1039
 
738
1040
  get_monitor(): number;
739
1041
  get_pid(): number;
740
- get_transient(): Window;
1042
+ /**
1043
+ * @returns A transient for this {@link Bamf.Window}.
1044
+ */
1045
+ get_transient(): Window | null;
1046
+ /**
1047
+ * @param prop
1048
+ */
741
1049
  get_utf8_prop(prop: string): string;
742
1050
  get_window_type(): WindowType;
743
1051
  get_xid(): number;
@@ -745,36 +1053,44 @@ export namespace Bamf {
745
1053
  maximized(): WindowMaximizationType;
746
1054
  }
747
1055
 
1056
+ /**
1057
+ * @gir-type Alias
1058
+ */
748
1059
  type ApplicationClass = typeof Application;
749
- abstract class ApplicationPrivate {
750
- static $gtype: GObject.GType<ApplicationPrivate>;
751
- }
752
-
1060
+ /**
1061
+ * @gir-type Alias
1062
+ */
753
1063
  type ControlClass = typeof Control;
1064
+ /**
1065
+ * @gir-type Struct
1066
+ */
754
1067
  abstract class ControlPrivate {
755
1068
  static $gtype: GObject.GType<ControlPrivate>;
756
1069
  }
757
1070
 
1071
+ /**
1072
+ * @gir-type Alias
1073
+ */
758
1074
  type MatcherClass = typeof Matcher;
1075
+ /**
1076
+ * @gir-type Struct
1077
+ */
759
1078
  abstract class MatcherPrivate {
760
1079
  static $gtype: GObject.GType<MatcherPrivate>;
761
1080
  }
762
1081
 
1082
+ /**
1083
+ * @gir-type Alias
1084
+ */
763
1085
  type TabClass = typeof Tab;
764
- abstract class TabPrivate {
765
- static $gtype: GObject.GType<TabPrivate>;
766
- }
767
-
1086
+ /**
1087
+ * @gir-type Alias
1088
+ */
768
1089
  type ViewClass = typeof View;
769
- abstract class ViewPrivate {
770
- static $gtype: GObject.GType<ViewPrivate>;
771
- }
772
-
1090
+ /**
1091
+ * @gir-type Alias
1092
+ */
773
1093
  type WindowClass = typeof Window;
774
- abstract class WindowPrivate {
775
- static $gtype: GObject.GType<WindowPrivate>;
776
- }
777
-
778
1094
  /**
779
1095
  * Name of the imported GIR library
780
1096
  * `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/bamf-3",
3
- "version": "3.0.0-4.0.0-beta.39",
3
+ "version": "3.0.0-4.0.0-beta.41",
4
4
  "description": "GJS TypeScript type definitions for Bamf-3, generated from library version 3.0.0",
5
5
  "type": "module",
6
6
  "module": "bamf-3.js",
@@ -31,9 +31,9 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gjs": "4.0.0-beta.39",
35
- "@girs/gobject-2.0": "2.86.4-4.0.0-beta.39",
36
- "@girs/glib-2.0": "2.86.4-4.0.0-beta.39" },
34
+ "@girs/gjs": "4.0.0-beta.41",
35
+ "@girs/gobject-2.0": "2.88.0-4.0.0-beta.41",
36
+ "@girs/glib-2.0": "2.88.0-4.0.0-beta.41" },
37
37
  "devDependencies": {
38
38
  "typescript": "*"
39
39
  },
package/tsconfig.json CHANGED
@@ -17,7 +17,18 @@
17
17
  "inlineSources": false,
18
18
  "newLine": "LF",
19
19
  // Show diagnostics
20
- "diagnostics": true
20
+ "diagnostics": true,
21
+ "paths": {
22
+ "@girs/gobject-2.0": [
23
+ "../gobject-2.0/index.d.ts"
24
+ ],
25
+ "@girs/glib-2.0": [
26
+ "../glib-2.0/index.d.ts"
27
+ ],
28
+ "@girs/gjs": [
29
+ "../gjs/index.d.ts"
30
+ ]
31
+ }
21
32
  },
22
33
  "include": ["./bamf-3.d.ts"]
23
34
  }
package/typedoc.json CHANGED
@@ -2,6 +2,8 @@
2
2
  "entryPoints": ["./bamf-3.d.ts"],
3
3
  "readme": "./README.md",
4
4
  "name": "Bamf-3",
5
- "tsconfig": "./tsconfig.json"
5
+ "tsconfig": "./tsconfig.json",
6
+ "skipErrorChecking": true,
7
+ "highlightLanguages": ["typescript", "javascript", "c", "cpp", "xml", "bash", "json", "css"]
6
8
  }
7
9