UNPKG

@theia/core

Version:

Theia is a cloud & desktop IDE framework implemented in TypeScript.

68 lines • 3.33 kB
import { Event } from '../../common/index.js'; import { ApplicationShell } from '../shell/index.js'; import { TheiaDockPanel } from '../shell/theia-dock-panel.js'; import { ExtractableWidget, TabBar, Widget } from '../widgets/index.js'; export declare abstract class SecondaryWindowRootWidget extends Widget { secondaryWindow: Window | SecondaryWindow; defaultRestoreArea?: ApplicationShell.Area; abstract widgets: ReadonlyArray<Widget>; abstract addWidget(widget: Widget, disposeCallback: () => void, options?: TheiaDockPanel.AddOptions): void; getTabBar?(widget: Widget): TabBar<Widget> | undefined; } export interface SecondaryWindow extends Window { rootWidget: SecondaryWindowRootWidget | undefined; } export declare function isSecondaryWindow(window: unknown): window is SecondaryWindow; export interface SecondaryWindowOptions { /** * The screen position of the top left corner of the window. If omitted, the window is placed * according to the `window.secondaryWindowPlacement` preference. */ position?: { x: number; y: number; }; /** * The size of the window. If omitted, the size is derived from the widget and the `window.secondaryWindowPlacement` preference. */ size?: { width: number; height: number; }; } export declare const SecondaryWindowService: unique symbol; /** * Service for opening new secondary windows to contain widgets extracted from the application shell. * * @experimental The functionality provided by this service and its implementation is still under development. Use with caution. */ export interface SecondaryWindowService { /** * Creates a new secondary window for a widget to be extracted from the application shell. * The created window is closed automatically when the current theia instance is closed. * * @param onClose optional callback that is invoked when the secondary window is closed * @param options optional options, e.g. the screen position at which to open the window * @returns the created window or `undefined` if it could not be created */ createSecondaryWindow(widget: ExtractableWidget, shell: ApplicationShell, options?: SecondaryWindowOptions): SecondaryWindow | Window | undefined; readonly onWindowOpened: Event<Window>; /** * Emitted once a secondary window's final document has finished loading. Listeners can safely * modify the window's document, unlike with {@link onWindowOpened}: at that point the window * still shows the initial `about:blank` document, and anything added to it is discarded when * the final document replaces it. */ readonly onWindowLoaded: Event<Window>; readonly onWindowClosed: Event<Window>; readonly beforeWidgetRestore: Event<[Widget, Window]>; /** * Moves the given widget from the given secondary window back to the application shell. * The secondary window is closed once it does not contain any widgets anymore. */ restoreWidget(widget: Widget, secondaryWindow: Window, shell: ApplicationShell): Promise<void>; /** Handles focussing the given secondary window in the browser and on Electron. */ focus(win: Window): void; getWindows(): Window[]; } //# sourceMappingURL=secondary-window-service.d.ts.map