@girs/bamf-3 3.0.0-3.2.6 → 3.0.0-3.2.7

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) v3.2.6.
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) v3.2.7.
9
9
 
10
10
 
11
11
  ## Install
package/bamf-3.d.cts CHANGED
@@ -42,29 +42,29 @@ export enum WindowType {
42
42
  SPLASHSCREEN,
43
43
  UNKNOWN,
44
44
  }
45
- export const APPLICATION_SIGNAL_DESKTOP_FILE_UPDATED: string | null
46
- export const APPLICATION_SIGNAL_WINDOW_ADDED: string | null
47
- export const APPLICATION_SIGNAL_WINDOW_REMOVED: string | null
48
- export const MATCHER_SIGNAL_ACTIVE_APPLICATION_CHANGED: string | null
49
- export const MATCHER_SIGNAL_ACTIVE_WINDOW_CHANGED: string | null
50
- export const MATCHER_SIGNAL_STACKING_ORDER_CHANGED: string | null
51
- export const MATCHER_SIGNAL_VIEW_CLOSED: string | null
52
- export const MATCHER_SIGNAL_VIEW_OPENED: string | null
53
- export const VIEW_SIGNAL_ACTIVE_CHANGED: string | null
54
- export const VIEW_SIGNAL_CHILD_ADDED: string | null
55
- export const VIEW_SIGNAL_CHILD_MOVED: string | null
56
- export const VIEW_SIGNAL_CHILD_REMOVED: string | null
57
- export const VIEW_SIGNAL_CLOSED: string | null
58
- export const VIEW_SIGNAL_ICON_CHANGED: string | null
59
- export const VIEW_SIGNAL_NAME_CHANGED: string | null
60
- export const VIEW_SIGNAL_RUNNING_CHANGED: string | null
61
- export const VIEW_SIGNAL_STARTING_CHANGED: string | null
62
- export const VIEW_SIGNAL_URGENT_CHANGED: string | null
63
- export const VIEW_SIGNAL_USER_VISIBLE_CHANGED: string | null
64
- export const WINDOW_SIGNAL_MAXIMIZED_CHANGED: string | null
65
- export const WINDOW_SIGNAL_MONITOR_CHANGED: string | null
45
+ export const APPLICATION_SIGNAL_DESKTOP_FILE_UPDATED: string
46
+ export const APPLICATION_SIGNAL_WINDOW_ADDED: string
47
+ export const APPLICATION_SIGNAL_WINDOW_REMOVED: string
48
+ export const MATCHER_SIGNAL_ACTIVE_APPLICATION_CHANGED: string
49
+ export const MATCHER_SIGNAL_ACTIVE_WINDOW_CHANGED: string
50
+ export const MATCHER_SIGNAL_STACKING_ORDER_CHANGED: string
51
+ export const MATCHER_SIGNAL_VIEW_CLOSED: string
52
+ export const MATCHER_SIGNAL_VIEW_OPENED: string
53
+ export const VIEW_SIGNAL_ACTIVE_CHANGED: string
54
+ export const VIEW_SIGNAL_CHILD_ADDED: string
55
+ export const VIEW_SIGNAL_CHILD_MOVED: string
56
+ export const VIEW_SIGNAL_CHILD_REMOVED: string
57
+ export const VIEW_SIGNAL_CLOSED: string
58
+ export const VIEW_SIGNAL_ICON_CHANGED: string
59
+ export const VIEW_SIGNAL_NAME_CHANGED: string
60
+ export const VIEW_SIGNAL_RUNNING_CHANGED: string
61
+ export const VIEW_SIGNAL_STARTING_CHANGED: string
62
+ export const VIEW_SIGNAL_URGENT_CHANGED: string
63
+ export const VIEW_SIGNAL_USER_VISIBLE_CHANGED: string
64
+ export const WINDOW_SIGNAL_MAXIMIZED_CHANGED: string
65
+ export const WINDOW_SIGNAL_MONITOR_CHANGED: string
66
66
  export interface TabPreviewReadyCallback {
67
- (self: Tab, preview_data: string | null): void
67
+ (self: Tab, preview_data: string): void
68
68
  }
69
69
  export module Application {
70
70
 
@@ -113,13 +113,13 @@ export interface Application {
113
113
  * @returns %TRUE if found, %FALSE otherwise.
114
114
  */
115
115
  get_application_menu(): [ /* returnType */ boolean, /* name */ string | null, /* object_path */ string | null ]
116
- get_application_type(): string | null
116
+ get_application_type(): string
117
117
  /**
118
118
  * Used to fetch the path to the .desktop file associated with the passed application. If
119
119
  * none exists, the result is NULL.
120
120
  * @returns A string representing the path to the desktop file.
121
121
  */
122
- get_desktop_file(): string | null
122
+ get_desktop_file(): string
123
123
  get_focusable_child(): View
124
124
  /**
125
125
  * Used to discover whether the application wants menu stubs shown.
@@ -214,8 +214,8 @@ export interface Control {
214
214
  // Owm methods of Bamf-3.Bamf.Control
215
215
 
216
216
  create_local_desktop_file(application: Application): void
217
- insert_desktop_file(desktop_file: string | null): void
218
- register_application_for_pid(desktop_file: string | null, pid: number): void
217
+ insert_desktop_file(desktop_file: string): void
218
+ register_application_for_pid(desktop_file: string, pid: number): void
219
219
  set_approver_behavior(behavior: number): void
220
220
 
221
221
  // Class property signals of Bamf-3.Bamf.Control
@@ -296,7 +296,7 @@ export interface Matcher {
296
296
 
297
297
  // Owm methods of Bamf-3.Bamf.Matcher
298
298
 
299
- application_is_running(desktop_file: string | null): boolean
299
+ application_is_running(desktop_file: string): boolean
300
300
  /**
301
301
  * Used to fetch the active #BamfApplication.
302
302
  * @returns The active #BamfApplication.
@@ -307,7 +307,7 @@ export interface Matcher {
307
307
  * @returns The active #BamfWindow.
308
308
  */
309
309
  get_active_window(): Window
310
- get_application_for_desktop_file(desktop_file_path: string | null, create_if_not_found: boolean): Application
310
+ get_application_for_desktop_file(desktop_file_path: string, create_if_not_found: boolean): Application
311
311
  /**
312
312
  * Used to fetch the #BamfApplication containing the passed window.
313
313
  * @param window The window to look for
@@ -362,7 +362,7 @@ export interface Matcher {
362
362
  * @param desktop_file
363
363
  * @returns A list of xids.
364
364
  */
365
- get_xids_for_application(desktop_file: string | null): number[]
365
+ get_xids_for_application(desktop_file: string): number[]
366
366
  /**
367
367
  * Used to effect how bamf performs matching. Desktop files passed to this method will
368
368
  * be prefered by bamf to system desktop files.
@@ -450,9 +450,9 @@ export interface Tab {
450
450
  * Returns the desktop file for the tab.
451
451
  * @returns The tab desktop id or %NULL if not set or available. Do not free the returned value, it belongs to @self.
452
452
  */
453
- get_desktop_name(): string | null
453
+ get_desktop_name(): string
454
454
  get_is_foreground_tab(): boolean
455
- get_location(): string | null
455
+ get_location(): string
456
456
  /**
457
457
  * The desktop file for the tab.
458
458
  * @returns The tab parent window XID id or 0 if not set or available.
@@ -472,9 +472,9 @@ export interface Tab {
472
472
  * @virtual
473
473
  * @returns The tab desktop id or %NULL if not set or available. Do not free the returned value, it belongs to @self.
474
474
  */
475
- vfunc_get_desktop_name(): string | null
475
+ vfunc_get_desktop_name(): string
476
476
  vfunc_get_is_foreground_tab(): boolean
477
- vfunc_get_location(): string | null
477
+ vfunc_get_location(): string
478
478
  /**
479
479
  * The desktop file for the tab.
480
480
  * @virtual
@@ -659,7 +659,7 @@ export interface View {
659
659
  * The view type of a window is a short string used to represent all views of the same class. These
660
660
  * descriptions should not be used to do casting as they are not considered stable.
661
661
  */
662
- get_view_type(): string | null
662
+ get_view_type(): string
663
663
  has_child(child: View): boolean
664
664
  /**
665
665
  * Determines if the view is currently active and focused by the user. Useful for an active window indicator.
@@ -739,7 +739,7 @@ export interface View {
739
739
  vfunc_is_user_visible(): boolean
740
740
  vfunc_name_changed(old_name: string | null, new_name: string | null): void
741
741
  vfunc_running_changed(running: boolean): void
742
- vfunc_set_path(path: string | null): void
742
+ vfunc_set_path(path: string): void
743
743
  vfunc_set_sticky(value: boolean): void
744
744
  vfunc_starting_changed(starting: boolean): void
745
745
  vfunc_urgent_changed(urgent: boolean): void
@@ -749,7 +749,7 @@ export interface View {
749
749
  * descriptions should not be used to do casting as they are not considered stable.
750
750
  * @virtual
751
751
  */
752
- vfunc_view_type(): string | null
752
+ vfunc_view_type(): string
753
753
 
754
754
  // Own signals of Bamf-3.Bamf.View
755
755
 
@@ -864,7 +864,7 @@ export interface Window {
864
864
  get_monitor(): number
865
865
  get_pid(): number
866
866
  get_transient(): Window
867
- get_utf8_prop(prop: string | null): string | null
867
+ get_utf8_prop(prop: string): string | null
868
868
  get_window_type(): WindowType
869
869
  get_xid(): number
870
870
  last_active(): number
@@ -875,7 +875,7 @@ export interface Window {
875
875
  vfunc_get_monitor(): number
876
876
  vfunc_get_pid(): number
877
877
  vfunc_get_transient(): Window
878
- vfunc_get_utf8_prop(prop: string | null): string | null
878
+ vfunc_get_utf8_prop(prop: string): string | null
879
879
  vfunc_get_window_type(): WindowType
880
880
  vfunc_get_xid(): number
881
881
  vfunc_last_active(): number
@@ -1008,8 +1008,8 @@ export interface TabClass {
1008
1008
  // Own fields of Bamf-3.Bamf.TabClass
1009
1009
 
1010
1010
  parent_class: ViewClass
1011
- get_desktop_name: (self: Tab) => string | null
1012
- get_location: (self: Tab) => string | null
1011
+ get_desktop_name: (self: Tab) => string
1012
+ get_location: (self: Tab) => string
1013
1013
  get_xid: (self: Tab) => number
1014
1014
  get_is_foreground_tab: (self: Tab) => boolean
1015
1015
  }
@@ -1043,8 +1043,8 @@ export interface ViewClass {
1043
1043
  is_user_visible: (view: View) => boolean
1044
1044
  get_name: (view: View) => string | null
1045
1045
  get_icon: (view: View) => string | null
1046
- view_type: (view: View) => string | null
1047
- set_path: (view: View, path: string | null) => void
1046
+ view_type: (view: View) => string
1047
+ set_path: (view: View, path: string) => void
1048
1048
  set_sticky: (view: View, value: boolean) => void
1049
1049
  click_behavior: (view: View) => ClickBehavior
1050
1050
  active_changed: (view: View, active: boolean) => void
@@ -1088,7 +1088,7 @@ export interface WindowClass {
1088
1088
  get_xid: (self: Window) => number
1089
1089
  get_pid: (self: Window) => number
1090
1090
  get_monitor: (self: Window) => number
1091
- get_utf8_prop: (self: Window, prop: string | null) => string | null
1091
+ get_utf8_prop: (self: Window, prop: string) => string | null
1092
1092
  maximized: (self: Window) => WindowMaximizationType
1093
1093
  last_active: (self: Window) => number
1094
1094
  monitor_changed: (window: Window, old_value: number, new_value: number) => void
package/bamf-3.d.ts CHANGED
@@ -44,29 +44,29 @@ enum WindowType {
44
44
  SPLASHSCREEN,
45
45
  UNKNOWN,
46
46
  }
47
- const APPLICATION_SIGNAL_DESKTOP_FILE_UPDATED: string | null
48
- const APPLICATION_SIGNAL_WINDOW_ADDED: string | null
49
- const APPLICATION_SIGNAL_WINDOW_REMOVED: string | null
50
- const MATCHER_SIGNAL_ACTIVE_APPLICATION_CHANGED: string | null
51
- const MATCHER_SIGNAL_ACTIVE_WINDOW_CHANGED: string | null
52
- const MATCHER_SIGNAL_STACKING_ORDER_CHANGED: string | null
53
- const MATCHER_SIGNAL_VIEW_CLOSED: string | null
54
- const MATCHER_SIGNAL_VIEW_OPENED: string | null
55
- const VIEW_SIGNAL_ACTIVE_CHANGED: string | null
56
- const VIEW_SIGNAL_CHILD_ADDED: string | null
57
- const VIEW_SIGNAL_CHILD_MOVED: string | null
58
- const VIEW_SIGNAL_CHILD_REMOVED: string | null
59
- const VIEW_SIGNAL_CLOSED: string | null
60
- const VIEW_SIGNAL_ICON_CHANGED: string | null
61
- const VIEW_SIGNAL_NAME_CHANGED: string | null
62
- const VIEW_SIGNAL_RUNNING_CHANGED: string | null
63
- const VIEW_SIGNAL_STARTING_CHANGED: string | null
64
- const VIEW_SIGNAL_URGENT_CHANGED: string | null
65
- const VIEW_SIGNAL_USER_VISIBLE_CHANGED: string | null
66
- const WINDOW_SIGNAL_MAXIMIZED_CHANGED: string | null
67
- const WINDOW_SIGNAL_MONITOR_CHANGED: string | null
47
+ const APPLICATION_SIGNAL_DESKTOP_FILE_UPDATED: string
48
+ const APPLICATION_SIGNAL_WINDOW_ADDED: string
49
+ const APPLICATION_SIGNAL_WINDOW_REMOVED: string
50
+ const MATCHER_SIGNAL_ACTIVE_APPLICATION_CHANGED: string
51
+ const MATCHER_SIGNAL_ACTIVE_WINDOW_CHANGED: string
52
+ const MATCHER_SIGNAL_STACKING_ORDER_CHANGED: string
53
+ const MATCHER_SIGNAL_VIEW_CLOSED: string
54
+ const MATCHER_SIGNAL_VIEW_OPENED: string
55
+ const VIEW_SIGNAL_ACTIVE_CHANGED: string
56
+ const VIEW_SIGNAL_CHILD_ADDED: string
57
+ const VIEW_SIGNAL_CHILD_MOVED: string
58
+ const VIEW_SIGNAL_CHILD_REMOVED: string
59
+ const VIEW_SIGNAL_CLOSED: string
60
+ const VIEW_SIGNAL_ICON_CHANGED: string
61
+ const VIEW_SIGNAL_NAME_CHANGED: string
62
+ const VIEW_SIGNAL_RUNNING_CHANGED: string
63
+ const VIEW_SIGNAL_STARTING_CHANGED: string
64
+ const VIEW_SIGNAL_URGENT_CHANGED: string
65
+ const VIEW_SIGNAL_USER_VISIBLE_CHANGED: string
66
+ const WINDOW_SIGNAL_MAXIMIZED_CHANGED: string
67
+ const WINDOW_SIGNAL_MONITOR_CHANGED: string
68
68
  interface TabPreviewReadyCallback {
69
- (self: Tab, preview_data: string | null): void
69
+ (self: Tab, preview_data: string): void
70
70
  }
71
71
  module Application {
72
72
 
@@ -115,13 +115,13 @@ interface Application {
115
115
  * @returns %TRUE if found, %FALSE otherwise.
116
116
  */
117
117
  get_application_menu(): [ /* returnType */ boolean, /* name */ string | null, /* object_path */ string | null ]
118
- get_application_type(): string | null
118
+ get_application_type(): string
119
119
  /**
120
120
  * Used to fetch the path to the .desktop file associated with the passed application. If
121
121
  * none exists, the result is NULL.
122
122
  * @returns A string representing the path to the desktop file.
123
123
  */
124
- get_desktop_file(): string | null
124
+ get_desktop_file(): string
125
125
  get_focusable_child(): View
126
126
  /**
127
127
  * Used to discover whether the application wants menu stubs shown.
@@ -216,8 +216,8 @@ interface Control {
216
216
  // Owm methods of Bamf-3.Bamf.Control
217
217
 
218
218
  create_local_desktop_file(application: Application): void
219
- insert_desktop_file(desktop_file: string | null): void
220
- register_application_for_pid(desktop_file: string | null, pid: number): void
219
+ insert_desktop_file(desktop_file: string): void
220
+ register_application_for_pid(desktop_file: string, pid: number): void
221
221
  set_approver_behavior(behavior: number): void
222
222
 
223
223
  // Class property signals of Bamf-3.Bamf.Control
@@ -298,7 +298,7 @@ interface Matcher {
298
298
 
299
299
  // Owm methods of Bamf-3.Bamf.Matcher
300
300
 
301
- application_is_running(desktop_file: string | null): boolean
301
+ application_is_running(desktop_file: string): boolean
302
302
  /**
303
303
  * Used to fetch the active #BamfApplication.
304
304
  * @returns The active #BamfApplication.
@@ -309,7 +309,7 @@ interface Matcher {
309
309
  * @returns The active #BamfWindow.
310
310
  */
311
311
  get_active_window(): Window
312
- get_application_for_desktop_file(desktop_file_path: string | null, create_if_not_found: boolean): Application
312
+ get_application_for_desktop_file(desktop_file_path: string, create_if_not_found: boolean): Application
313
313
  /**
314
314
  * Used to fetch the #BamfApplication containing the passed window.
315
315
  * @param window The window to look for
@@ -364,7 +364,7 @@ interface Matcher {
364
364
  * @param desktop_file
365
365
  * @returns A list of xids.
366
366
  */
367
- get_xids_for_application(desktop_file: string | null): number[]
367
+ get_xids_for_application(desktop_file: string): number[]
368
368
  /**
369
369
  * Used to effect how bamf performs matching. Desktop files passed to this method will
370
370
  * be prefered by bamf to system desktop files.
@@ -452,9 +452,9 @@ interface Tab {
452
452
  * Returns the desktop file for the tab.
453
453
  * @returns The tab desktop id or %NULL if not set or available. Do not free the returned value, it belongs to @self.
454
454
  */
455
- get_desktop_name(): string | null
455
+ get_desktop_name(): string
456
456
  get_is_foreground_tab(): boolean
457
- get_location(): string | null
457
+ get_location(): string
458
458
  /**
459
459
  * The desktop file for the tab.
460
460
  * @returns The tab parent window XID id or 0 if not set or available.
@@ -474,9 +474,9 @@ interface Tab {
474
474
  * @virtual
475
475
  * @returns The tab desktop id or %NULL if not set or available. Do not free the returned value, it belongs to @self.
476
476
  */
477
- vfunc_get_desktop_name(): string | null
477
+ vfunc_get_desktop_name(): string
478
478
  vfunc_get_is_foreground_tab(): boolean
479
- vfunc_get_location(): string | null
479
+ vfunc_get_location(): string
480
480
  /**
481
481
  * The desktop file for the tab.
482
482
  * @virtual
@@ -661,7 +661,7 @@ interface View {
661
661
  * The view type of a window is a short string used to represent all views of the same class. These
662
662
  * descriptions should not be used to do casting as they are not considered stable.
663
663
  */
664
- get_view_type(): string | null
664
+ get_view_type(): string
665
665
  has_child(child: View): boolean
666
666
  /**
667
667
  * Determines if the view is currently active and focused by the user. Useful for an active window indicator.
@@ -741,7 +741,7 @@ interface View {
741
741
  vfunc_is_user_visible(): boolean
742
742
  vfunc_name_changed(old_name: string | null, new_name: string | null): void
743
743
  vfunc_running_changed(running: boolean): void
744
- vfunc_set_path(path: string | null): void
744
+ vfunc_set_path(path: string): void
745
745
  vfunc_set_sticky(value: boolean): void
746
746
  vfunc_starting_changed(starting: boolean): void
747
747
  vfunc_urgent_changed(urgent: boolean): void
@@ -751,7 +751,7 @@ interface View {
751
751
  * descriptions should not be used to do casting as they are not considered stable.
752
752
  * @virtual
753
753
  */
754
- vfunc_view_type(): string | null
754
+ vfunc_view_type(): string
755
755
 
756
756
  // Own signals of Bamf-3.Bamf.View
757
757
 
@@ -866,7 +866,7 @@ interface Window {
866
866
  get_monitor(): number
867
867
  get_pid(): number
868
868
  get_transient(): Window
869
- get_utf8_prop(prop: string | null): string | null
869
+ get_utf8_prop(prop: string): string | null
870
870
  get_window_type(): WindowType
871
871
  get_xid(): number
872
872
  last_active(): number
@@ -877,7 +877,7 @@ interface Window {
877
877
  vfunc_get_monitor(): number
878
878
  vfunc_get_pid(): number
879
879
  vfunc_get_transient(): Window
880
- vfunc_get_utf8_prop(prop: string | null): string | null
880
+ vfunc_get_utf8_prop(prop: string): string | null
881
881
  vfunc_get_window_type(): WindowType
882
882
  vfunc_get_xid(): number
883
883
  vfunc_last_active(): number
@@ -1010,8 +1010,8 @@ interface TabClass {
1010
1010
  // Own fields of Bamf-3.Bamf.TabClass
1011
1011
 
1012
1012
  parent_class: ViewClass
1013
- get_desktop_name: (self: Tab) => string | null
1014
- get_location: (self: Tab) => string | null
1013
+ get_desktop_name: (self: Tab) => string
1014
+ get_location: (self: Tab) => string
1015
1015
  get_xid: (self: Tab) => number
1016
1016
  get_is_foreground_tab: (self: Tab) => boolean
1017
1017
  }
@@ -1045,8 +1045,8 @@ interface ViewClass {
1045
1045
  is_user_visible: (view: View) => boolean
1046
1046
  get_name: (view: View) => string | null
1047
1047
  get_icon: (view: View) => string | null
1048
- view_type: (view: View) => string | null
1049
- set_path: (view: View, path: string | null) => void
1048
+ view_type: (view: View) => string
1049
+ set_path: (view: View, path: string) => void
1050
1050
  set_sticky: (view: View, value: boolean) => void
1051
1051
  click_behavior: (view: View) => ClickBehavior
1052
1052
  active_changed: (view: View, active: boolean) => void
@@ -1090,7 +1090,7 @@ interface WindowClass {
1090
1090
  get_xid: (self: Window) => number
1091
1091
  get_pid: (self: Window) => number
1092
1092
  get_monitor: (self: Window) => number
1093
- get_utf8_prop: (self: Window, prop: string | null) => string | null
1093
+ get_utf8_prop: (self: Window, prop: string) => string | null
1094
1094
  maximized: (self: Window) => WindowMaximizationType
1095
1095
  last_active: (self: Window) => number
1096
1096
  monitor_changed: (window: Window, old_value: number, new_value: number) => void
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/bamf-3",
3
- "version": "3.0.0-3.2.6",
3
+ "version": "3.0.0-3.2.7",
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",
@@ -25,9 +25,9 @@
25
25
  "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit bamf-3.d.cts"
26
26
  },
27
27
  "dependencies": {
28
- "@girs/gjs": "^3.2.6",
29
- "@girs/glib-2.0": "^2.78.0-3.2.6",
30
- "@girs/gobject-2.0": "^2.78.0-3.2.6"
28
+ "@girs/gjs": "^3.2.7",
29
+ "@girs/glib-2.0": "^2.78.0-3.2.7",
30
+ "@girs/gobject-2.0": "^2.78.0-3.2.7"
31
31
  },
32
32
  "devDependencies": {
33
33
  "typescript": "*"