Skip to content

Commit ff64e4b

Browse files
committed
use namespace and "export interface ConstructorProperties" everywhere, where I used an other Name
1 parent 5229b0a commit ff64e4b

File tree

4 files changed

+111
-78
lines changed

4 files changed

+111
-78
lines changed

packages/gnome-shell/src/ui/dialog.d.ts

+10-9
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ export interface ButtonInfo {
1515
* @version 46
1616
*/
1717
export class Dialog extends St.Widget {
18-
1918
protected _parentActor: St.Widget;
2019
protected _dialog: St.BoxLayout;
2120
protected _initialKeyFocus: St.Widget;
@@ -35,20 +34,24 @@ export class Dialog extends St.Widget {
3534
protected _setInitialKeyFocus(actor: St.Widget): void;
3635
}
3736

38-
export interface MessageDialogContentProps extends St.BoxLayout.ConstructorProperties {
39-
title?: string;
40-
description?: string;
37+
/**
38+
* @version 46
39+
*/
40+
export namespace MessageDialogContent {
41+
export interface ConstructorProperties extends St.BoxLayout.ConstructorProperties {
42+
title?: string;
43+
description?: string;
44+
}
4145
}
42-
4346
/**
4447
* @version 46
4548
*/
4649
export class MessageDialogContent extends St.BoxLayout {
4750
public title: string;
4851
public description: string;
4952

50-
constructor(params: MessageDialogContentProps);
51-
public _init(params: MessageDialogContentProps): void;
53+
constructor(params: MessageDialogContent.ConstructorProperties);
54+
public _init(params: MessageDialogContent.ConstructorProperties): void;
5255

5356
protected _onDestroy(): void;
5457
protected _updateTitleStyle(): void | false;
@@ -62,7 +65,6 @@ export interface ListSectionProps extends St.BoxLayout.ConstructorProperties {
6265
* @version 46
6366
*/
6467
export class ListSection extends St.BoxLayout {
65-
6668
protected _listScrollView: St.ScrollView;
6769
protected _title: St.Label;
6870

@@ -84,7 +86,6 @@ export interface ListSectionItemProps extends St.BoxLayout.ConstructorProperties
8486
* @version 46
8587
*/
8688
export class ListSectionItem extends St.BoxLayout {
87-
8889
protected _iconActorBin: St.Bin;
8990
protected _title: St.Label;
9091

packages/gnome-shell/src/ui/layout.d.ts

+58-29
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,22 @@ export interface Geometry {
2020
width: number;
2121
height: number;
2222
}
23+
/**
24+
* @version 46
25+
*/
2326

24-
export interface MonitorConstraintProps extends Clutter.Constraint.ConstructorProperties {
25-
primary?: boolean;
26-
index?: number;
27-
workArea?: boolean;
27+
export namespace MonitorConstraint {
28+
export interface ConstructorProperties extends Clutter.Constraint.ConstructorProperties {
29+
primary?: boolean;
30+
index?: number;
31+
workArea?: boolean;
32+
}
2833
}
2934

3035
/**
3136
* @version 46
3237
*/
3338
export class MonitorConstraint extends Clutter.Constraint {
34-
3539
protected _primary: boolean;
3640
protected _index: number;
3741
protected _workArea: boolean;
@@ -40,19 +44,17 @@ export class MonitorConstraint extends Clutter.Constraint {
4044
public index: number;
4145
public workArea: boolean;
4246

43-
constructor(props: MonitorConstraintProps);
44-
public _init(props: MonitorConstraintProps): void;
47+
constructor(props: MonitorConstraint.ConstructorProperties);
48+
public _init(props: MonitorConstraint.ConstructorProperties): void;
4549

4650
public vfunc_set_actor(actor: Clutter.Actor): void;
4751
public vfunc_update_allocation(actor: Clutter.Actor, actorBox: Clutter.ActorBox): void;
4852
}
4953

50-
5154
/**
5255
* @version 46
5356
*/
5457
declare class Monitor {
55-
5658
public index: number;
5759
public geometryScale: number;
5860
public x: number;
@@ -90,7 +92,6 @@ declare class ScreenTransition extends Clutter.Actor {
9092
* overview.
9193
*/
9294
declare class HotCorner extends Clutter.Actor {
93-
9495
protected _entered: boolean;
9596
protected _monitor: Monitor;
9697
protected _x: number;
@@ -114,13 +115,16 @@ declare class HotCorner extends Clutter.Actor {
114115
}
115116

116117
export class LayoutManager extends GObject.Object {
117-
118118
protected _rtl: boolean;
119119
protected _keyboardIndex: number;
120120
protected _rightPanelBarrier: Meta.Barrier | null;
121121
protected _inOverview: boolean;
122122
protected _updateRegionIdle: number;
123-
protected _trackedActors: { trackFullscreen: boolean; affectsStruts: boolean; affectsInputRegion: boolean; }[];
123+
protected _trackedActors: {
124+
trackFullscreen: boolean;
125+
affectsStruts: boolean;
126+
affectsInputRegion: boolean;
127+
}[];
124128
protected _keyboardHeightNotifyId: number;
125129
protected _backgroundGroup: Meta.BackgroundGroup;
126130
protected _interfaceSettings: Gio.Settings;
@@ -165,12 +169,12 @@ export class LayoutManager extends GObject.Object {
165169
* function before you show the menu to ensure it is at the right
166170
* position and has the right size.
167171
* @param x
168-
* @param y
169-
* @param width
170-
* @param height
172+
* @param y
173+
* @param width
174+
* @param height
171175
*/
172176
public setDummyCursorGeometry(x: number, y: number, width: number, height: number): void;
173-
177+
174178
/**
175179
* Adds `actor` to the chrome, and (unless `affectsInputRegion` in
176180
* `params` is `false`) extends the input region to include it.
@@ -190,27 +194,48 @@ export class LayoutManager extends GObject.Object {
190194
* @param actor An actor to add to the chrome
191195
* @param params Additional params
192196
*/
193-
public addChrome(actor: Clutter.Actor, params?: { affectsStruts?: boolean; affectsInputRegion?: boolean; trackFullscreen?: boolean; }): void;
197+
public addChrome(
198+
actor: Clutter.Actor,
199+
params?: {
200+
affectsStruts?: boolean;
201+
affectsInputRegion?: boolean;
202+
trackFullscreen?: boolean;
203+
}
204+
): void;
194205

195206
/**
196207
* Like {@link addChrome()}, but adds `actor` above all windows, including popups.
197208
* @param actor An actor to add to the chrome
198209
* @param params Additional params
199210
*/
200-
public addTopChrome(actor: Clutter.Actor, params?: { affectsStruts?: boolean; affectsInputRegion?: boolean; trackFullscreen?: boolean; }): void;
201-
211+
public addTopChrome(
212+
actor: Clutter.Actor,
213+
params?: {
214+
affectsStruts?: boolean;
215+
affectsInputRegion?: boolean;
216+
trackFullscreen?: boolean;
217+
}
218+
): void;
219+
202220
/**
203221
* Tells the chrome to track `actor`. This can be used to extend the
204222
* struts or input region to cover specific children.
205-
*
223+
*
206224
* `params` can have any of the same values as in {@link addChrome()},
207225
* though some possibilities don't make sense. By default, `actor` has
208226
* the same params as its chrome ancestor.
209-
*
227+
*
210228
* @param actor a descendant of the chrome to begin tracking
211229
* @param params parameters describing how to track `actor`
212230
*/
213-
public trackChrome(actor: Clutter.Actor, params?: { affectsStruts?: boolean; affectsInputRegion?: boolean; trackFullscreen?: boolean; }): void;
231+
public trackChrome(
232+
actor: Clutter.Actor,
233+
params?: {
234+
affectsStruts?: boolean;
235+
affectsInputRegion?: boolean;
236+
trackFullscreen?: boolean;
237+
}
238+
): void;
214239

215240
/**
216241
* Undoes the effect of {@link trackChrome()}
@@ -230,15 +255,14 @@ export class LayoutManager extends GObject.Object {
230255
/**
231256
* This call guarantees that we return some monitor to simplify usage of it
232257
* In practice all tracked actors should be visible on some monitor anyway
233-
* @param actor
258+
* @param actor
234259
*/
235-
public findIndexForActor(actor: Clutter.Actor): number
260+
public findIndexForActor(actor: Clutter.Actor): number;
236261

237-
public findMonitorForActor(actor: Clutter.Actor): Monitor | undefined
262+
public findMonitorForActor(actor: Clutter.Actor): Monitor | undefined;
238263

239264
public modalEnded(): void;
240265

241-
242266
protected _sessionUpdated(): void;
243267
protected _updateMonitors(): void;
244268
protected _updateHotCorners(): void;
@@ -276,7 +300,14 @@ export class LayoutManager extends GObject.Object {
276300
protected _startupAnimationSession(): void;
277301
protected _startupAnimationComplete(): void;
278302
protected _findActor(actor: Clutter.Actor): number;
279-
protected _trackActor(actor: Clutter.Actor, params?: { affectsStruts?: boolean; affectsInputRegion?: boolean; trackFullscreen?: boolean; }): void;
303+
protected _trackActor(
304+
actor: Clutter.Actor,
305+
params?: {
306+
affectsStruts?: boolean;
307+
affectsInputRegion?: boolean;
308+
trackFullscreen?: boolean;
309+
}
310+
): void;
280311
protected _untrackActor(actor: Clutter.Actor): void;
281312
protected _updateActorVisibility(actorData: any): void;
282313
protected _updateVisibility(): void;
@@ -287,7 +318,6 @@ export class LayoutManager extends GObject.Object {
287318
}
288319

289320
declare class PressureBarrier extends EventEmitter {
290-
291321
protected _threshold: number;
292322
protected _timeout: number;
293323
protected _actionMode: number;
@@ -315,4 +345,3 @@ declare class PressureBarrier extends EventEmitter {
315345
protected _trigger(): void;
316346
protected _onBarrierHit(barrier: Meta.Barrier, event: any): void;
317347
}
318-
+41-35
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,64 @@
11
// https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/lightbox.js
22

3-
import type Clutter from "@girs/clutter-14"
4-
import type St from "@girs/st-14"
5-
import type Shell from "@girs/shell-14"
3+
import type Clutter from '@girs/clutter-14';
4+
import type St from '@girs/st-14';
5+
import type Shell from '@girs/shell-14';
66

7-
export const DEFAULT_FADE_FACTOR = 0.4
8-
export const VIGNETTE_BRIGHTNESS = 0.5
9-
export const VIGNETTE_SHARPNESS = 0.7
7+
export const DEFAULT_FADE_FACTOR = 0.4;
8+
export const VIGNETTE_BRIGHTNESS = 0.5;
9+
export const VIGNETTE_SHARPNESS = 0.7;
1010

11-
export interface RadialShaderEffectProps
12-
extends Shell.GLSLEffect.ConstructorProperties {
13-
brightness?: number
14-
sharpness?: number
11+
/**
12+
* @version 46
13+
*/
14+
export namespace RadialShaderEffect {
15+
export interface ConstructorProperties extends Shell.GLSLEffect.ConstructorProperties {
16+
brightness?: number;
17+
sharpness?: number;
18+
}
1519
}
1620

1721
/**
1822
* @version 46
1923
*/
2024
export class RadialShaderEffect extends Shell.GLSLEffect {
21-
protected _brightness: number
22-
protected _sharpness: number
25+
protected _brightness: number;
26+
protected _sharpness: number;
2327

24-
public brightness: number
25-
public sharpness: number
28+
public brightness: number;
29+
public sharpness: number;
2630

27-
constructor(props: RadialShaderEffectProps)
28-
public _init(props: RadialShaderEffectProps): void
31+
constructor(props: RadialShaderEffect.ConstructorProperties);
32+
public _init(props: RadialShaderEffect.ConstructorProperties): void;
2933

30-
vfunc_build_pipeline(): void
34+
vfunc_build_pipeline(): void;
3135
}
3236

3337
export interface LightboxAdditionalParameters {
34-
inhibitEvents?: boolean
35-
width?: number
36-
height?: number
37-
fadeFactor?: number
38-
radialEffect?: boolean
38+
inhibitEvents?: boolean;
39+
width?: number;
40+
height?: number;
41+
fadeFactor?: number;
42+
radialEffect?: boolean;
3943
}
4044

41-
export interface LightboxProps
42-
extends St.Bin.ConstructorProperties,
43-
LightboxAdditionalParameters {
44-
brightness?: number
45-
sharpness?: number
45+
/**
46+
* @version 46
47+
*/
48+
export namespace Lightbox {
49+
export interface ConstructorProperties extends St.Bin.ConstructorProperties, LightboxAdditionalParameters {
50+
brightness?: number;
51+
sharpness?: number;
52+
}
4653
}
4754

4855
/**
4956
* @version 46
5057
*/
5158
export class Lightbox extends St.Bin {
52-
protected _active: boolean
59+
protected _active: boolean;
5360

54-
public readonly active: boolean
61+
public readonly active: boolean;
5562

5663
/**
5764
* Lightbox creates a dark translucent "shade" actor to hide the
@@ -76,16 +83,15 @@ export class Lightbox extends St.Bin {
7683
* @param {number=} params.fadeFactor: fading opacity factor
7784
* @param {boolean=} params.radialEffect: whether to enable the GLSL radial effect
7885
*/
79-
constructor(container: Clutter.Actor, params?: LightboxProps)
80-
public _init(container: Clutter.Actor, params?: LightboxProps): void
86+
constructor(container: Clutter.Actor, params?: Lightbox.ConstructorProperties);
87+
public _init(container: Clutter.Actor, params?: Lightbox.ConstructorProperties): void;
8188

82-
lightOn(fadeInTime?: number): void
83-
lightOff(fadeOutTime?: number): void
89+
lightOn(fadeInTime?: number): void;
90+
lightOff(fadeOutTime?: number): void;
8491

85-
highlight(window: Clutter.Actor): void
92+
highlight(window: Clutter.Actor): void;
8693

8794
protected _childAdded(container: Clutter.Actor, newChild: Clutter.Actor): void;
8895
protected _childRemoved(container: Clutter.Actor, child: Clutter.Actor): void;
8996
protected _onDestroy(): void;
90-
9197
}

packages/gnome-shell/src/ui/modalDialog.d.ts

+2-5
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export enum State {
2222
* @version 46
2323
*/
2424
export namespace ModalDialog {
25-
export interface ConstructorProperties {
25+
export interface ConstructorProperties extends St.Widget.ConstructorProperties {
2626
shellReactive?: boolean;
2727
styleClass?: string | null;
2828
actionMode?: Shell.ActionMode;
@@ -36,7 +36,6 @@ export namespace ModalDialog {
3636
* @version 46
3737
*/
3838
export class ModalDialog extends St.Widget {
39-
4039
protected _state: State;
4140
protected _hasModal: boolean;
4241
protected _actionMode: Shell.ActionMode;
@@ -56,10 +55,8 @@ export class ModalDialog extends St.Widget {
5655
public buttonLayout: Dialog['buttonLayout'];
5756
public state: State;
5857

59-
constructor(params?: ModalDialog.ConstructorProperties)
58+
constructor(params?: ModalDialog.ConstructorProperties);
6059

61-
/** @hidden */
62-
public _init(params?: St.Widget.ConstructorProperties): void;
6360
public _init(params?: ModalDialog.ConstructorProperties): void;
6461

6562
protected _setState(state: State): void;

0 commit comments

Comments
 (0)