@e-xi/xion 0.0.6

package/dist/main/window/window-lifecycle-abstract.d.ts

@@ -0,0 +1,514 @@
+import type { XoAppAbstract } from '../app/xo-app-abstract';
+/**
+ * Xion 窗口生命周期抽象类
+ * @class WindowLifecycleAbstract
+ */
+export declare abstract class WindowLifecycleAbstract {
+    /**
+     * Xion 应用
+     * @type {XoAppAbstract}
+     * @protected
+     */
+    protected readonly xoApp: XoAppAbstract;
+    /**
+     * 构造函数
+     */
+    constructor(xoApp: XoAppAbstract);
+    /**
+     * 创建窗口前
+     * @param {XoWindow.Type}                            type    窗口类型
+     * @param {Electron.BrowserWindowConstructorOptions} options 窗口配置
+     * @returns {Promise<void>}
+     */
+    beforeCreate(type: XoWindow.Type, options: Electron.BrowserWindowConstructorOptions): Promise<void>;
+    /**
+     * 创建窗口后
+     * <p>项目中可以在此方法中处理窗口事件，如：</p>
+     * <p>record.window.on('always-on-top-changed', () => {})</p>
+     * <p>record.window.webContents.on('context-menu', () => {})</p>
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    afterCreated(record: XoWindow.Record): Promise<void>;
+    /**
+     * 加载窗口渲染进程
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    loadIndex(record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口准备显示
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onceReadyToShow(record: XoWindow.Record): Promise<void>;
+    /**
+     * 页面加载完成
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onShow(record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口隐藏
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onHide(record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口获得焦点
+     * @param {Electron.Event}  event  事件对象
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onFocus(event: Electron.Event, record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口失去焦点
+     * @param {Electron.Event}  event  事件对象
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onBlur(event: Electron.Event, record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口尺寸变化
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onResize(record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口尺寸变化完成
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onResized(record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口位置变化
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onMove(record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口位置移动完成
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onMoved(record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口最大化
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onMaximize(record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口退出最大化
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onUnmaximize(record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口最小化
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onMinimize(record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口恢复
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onRestore(record: XoWindow.Record): Promise<void>;
+    /**
+     * 进入全屏
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onEnterFullScreen(record: XoWindow.Record): Promise<void>;
+    /**
+     * 退出全屏
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onLeaveFullScreen(record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口置顶状态变化
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onAlwaysOnTopChanged(record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口关闭前
+     * @param {Electron.Event}  event  事件对象
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onClose(event: Electron.Event, record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口已关闭
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onClosed(record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口无响应
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onUnresponsive(record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口恢复响应
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onResponsive(record: XoWindow.Record): Promise<void>;
+    /**
+     * 页面加载完成
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsDidFinishLoad(record: XoWindow.Record): Promise<void>;
+    /**
+     * 页面开始加载
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsDidStartLoading(record: XoWindow.Record): Promise<void>;
+    /**
+     * 页面停止加载
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsDidStopLoading(record: XoWindow.Record): Promise<void>;
+    /**
+     * 页面 DOM 准备完成
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsDomReady(record: XoWindow.Record): Promise<void>;
+    /**
+     * 页面标题更新
+     * @param {Electron.Event}  event       事件对象
+     * @param {XoWindow.Record} record      窗口实例
+     * @param {string}          title       页面标题
+     * @param {boolean}         explicitSet 是否显式设置标题
+     * @returns {Promise<void>}
+     */
+    onWebContentsPageTitleUpdated(event: Electron.Event, record: XoWindow.Record, title: string, explicitSet: boolean): Promise<void>;
+    /**
+     * 页面图标更新
+     * @param {Electron.Event}  event    事件对象
+     * @param {XoWindow.Record} record   窗口实例
+     * @param {string[]}        favicons 图标地址
+     * @returns {Promise<void>}
+     */
+    onWebContentsPageFaviconUpdated(event: Electron.Event, record: XoWindow.Record, favicons: string[]): Promise<void>;
+    /**
+     * webContents 焦点获得
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsFocus(record: XoWindow.Record): Promise<void>;
+    /**
+     * webContents 焦点失去
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsBlur(record: XoWindow.Record): Promise<void>;
+    /**
+     * webContents 主题色变化
+     * @param {Electron.Event}  event  事件对象
+     * @param {XoWindow.Record} record 窗口实例
+     * @param {string | null}   color  主题色
+     * @returns {Promise<void>}
+     */
+    onWebContentsDidChangeThemeColor(event: Electron.Event, record: XoWindow.Record, color: string | null): Promise<void>;
+    /**
+     * webContents 目标地址变化
+     * @param {Electron.Event}  event  事件对象
+     * @param {XoWindow.Record} record 窗口实例
+     * @param {string}          url    目标地址
+     * @returns {Promise<void>}
+     */
+    onWebContentsUpdateTargetUrl(event: Electron.Event, record: XoWindow.Record, url: string): Promise<void>;
+    /**
+     * webContents 即将跳转
+     * @param {Electron.Event}  event              事件对象
+     * @param {XoWindow.Record} record             窗口实例
+     * @param {string}          url                跳转地址
+     * @param {boolean}         shouldOpenExternal 是否应使用系统浏览器打开
+     * @returns {Promise<void>}
+     */
+    onWebContentsWillNavigate(event: Electron.Event, record: XoWindow.Record, url: string, shouldOpenExternal: boolean): Promise<void>;
+    /**
+     * webContents 上下文菜单
+     * @param {Electron.Event}             event  事件对象
+     * @param {XoWindow.Record}            record 窗口实例
+     * @param {Electron.ContextMenuParams} params 上下文菜单参数
+     * @returns {Promise<void>}
+     */
+    onWebContentsContextMenu(event: Electron.Event, record: XoWindow.Record, params: Electron.ContextMenuParams): Promise<void>;
+    /**
+     * webContents 按键前置事件
+     * @param {Electron.Event}  event  事件对象
+     * @param {XoWindow.Record} record 窗口实例
+     * @param {Electron.Input}  input  输入信息
+     * @returns {Promise<void>}
+     */
+    onWebContentsBeforeInputEvent(event: Electron.Event, record: XoWindow.Record, input: Electron.Input): Promise<void>;
+    /**
+     * webContents 输入事件
+     * @param {Electron.Event}      event      事件对象
+     * @param {XoWindow.Record}     record     窗口实例
+     * @param {Electron.InputEvent} inputEvent 输入事件
+     * @returns {Promise<void>}
+     */
+    onWebContentsInputEvent(event: Electron.Event, record: XoWindow.Record, inputEvent: Electron.InputEvent): Promise<void>;
+    /**
+     * webContents DevTools 打开链接
+     * @param {Electron.Event}  event  事件对象
+     * @param {XoWindow.Record} record 窗口实例
+     * @param {string}          url    链接
+     * @returns {Promise<void>}
+     */
+    onWebContentsDevtoolsOpenUrl(event: Electron.Event, record: XoWindow.Record, url: string): Promise<void>;
+    /**
+     * webContents DevTools 搜索
+     * @param {Electron.Event}  event  事件对象
+     * @param {XoWindow.Record} record 窗口实例
+     * @param {string}          query  关键字
+     * @returns {Promise<void>}
+     */
+    onWebContentsDevtoolsSearchQuery(event: Electron.Event, record: XoWindow.Record, query: string): Promise<void>;
+    /**
+     * webContents DevTools 打开
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsDevtoolsOpened(record: XoWindow.Record): Promise<void>;
+    /**
+     * webContents DevTools 关闭
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsDevtoolsClosed(record: XoWindow.Record): Promise<void>;
+    /**
+     * webContents DevTools 聚焦
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsDevtoolsFocused(record: XoWindow.Record): Promise<void>;
+    /**
+     * webContents 证书错误
+     * @param {Electron.Event}               event       事件对象
+     * @param {XoWindow.Record}              record      窗口实例
+     * @param {string}                       url         请求地址
+     * @param {string}                       error       错误码
+     * @param {Electron.Certificate}         certificate 证书
+     * @param {(isTrusted: boolean) => void} callback    回调函数
+     * @param {boolean}                      isMainFrame 是否主框架
+     * @returns {Promise<void>}
+     */
+    onWebContentsCertificateError(event: Electron.Event, record: XoWindow.Record, url: string, error: string, certificate: Electron.Certificate, callback: (isTrusted: boolean) => void, isMainFrame: boolean): Promise<void>;
+    /**
+     * webContents 选择客户端证书
+     * @param {Electron.Event}                              event           事件对象
+     * @param {XoWindow.Record}                             record          窗口实例
+     * @param {string}                                      url             请求地址
+     * @param {Electron.Certificate[]}                      certificateList 证书列表
+     * @param {(certificate: Electron.Certificate) => void} callback        回调函数
+     * @returns {Promise<void>}
+     */
+    onWebContentsSelectClientCertificate(event: Electron.Event, record: XoWindow.Record, url: string, certificateList: Electron.Certificate[], callback: (certificate: Electron.Certificate) => void): Promise<void>;
+    /**
+     * webContents 登录
+     * @param {Electron.Event}                                 event                         事件对象
+     * @param {XoWindow.Record}                                record                        窗口实例
+     * @param {Electron.LoginAuthenticationResponseDetails}    authenticationResponseDetails 认证响应详情
+     * @param {Electron.AuthInfo}                              authInfo                      认证信息
+     * @param {(username?: string, password?: string) => void} callback                      回调函数
+     * @returns {Promise<void>}
+     */
+    onWebContentsLogin(event: Electron.Event, record: XoWindow.Record, authenticationResponseDetails: Electron.LoginAuthenticationResponseDetails, authInfo: Electron.AuthInfo, callback: (username?: string, password?: string) => void): Promise<void>;
+    /**
+     * webContents 查找结果
+     * @param {Electron.Event}  event  事件对象
+     * @param {XoWindow.Record} record 窗口实例
+     * @param {Electron.Result} result 查找结果
+     * @returns {Promise<void>}
+     */
+    onWebContentsFoundInPage(event: Electron.Event, record: XoWindow.Record, result: Electron.Result): Promise<void>;
+    /**
+     * webContents 媒体开始播放
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsMediaStartedPlaying(record: XoWindow.Record): Promise<void>;
+    /**
+     * webContents 媒体暂停
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsMediaPaused(record: XoWindow.Record): Promise<void>;
+    /**
+     * webContents 音频状态变化
+     * @param {Electron.Event<Electron.WebContentsAudioStateChangedEventParams>} event  事件对象
+     * @param {XoWindow.Record}                                                  record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsAudioStateChanged(event: Electron.Event<Electron.WebContentsAudioStateChangedEventParams>, record: XoWindow.Record): Promise<void>;
+    /**
+     * webContents 控制台消息
+     * @param {Electron.Event<Electron.WebContentsConsoleMessageEventParams>} details 控制台详情
+     * @param {XoWindow.Record}                                               record  窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsConsoleMessage(details: Electron.Event<Electron.WebContentsConsoleMessageEventParams>, record: XoWindow.Record): Promise<void>;
+    /**
+     * webContents 预加载错误
+     * @param {Electron.Event}  event       事件对象
+     * @param {XoWindow.Record} record      窗口实例
+     * @param {string}          preloadPath 预加载脚本路径
+     * @param {Error}           error       错误对象
+     * @returns {Promise<void>}
+     */
+    onWebContentsPreloadError(event: Electron.Event, record: XoWindow.Record, preloadPath: string, error: Error): Promise<void>;
+    /**
+     * webContents IPC 消息
+     * @param {Electron.IpcMainEvent} event   事件对象
+     * @param {XoWindow.Record}       record  窗口实例
+     * @param {string}                channel 通道
+     * @param {any[]}                 args    参数列表
+     * @returns {Promise<void>}
+     */
+    onWebContentsIpcMessage(event: Electron.IpcMainEvent, record: XoWindow.Record, channel: string, ...args: any[]): Promise<void>;
+    /**
+     * webContents 同步 IPC 消息
+     * @param {Electron.IpcMainEvent} event   事件对象
+     * @param {XoWindow.Record}       record  窗口实例
+     * @param {string}                channel 通道
+     * @param {any[]}                 args    参数列表
+     * @returns {Promise<void>}
+     */
+    onWebContentsIpcMessageSync(event: Electron.IpcMainEvent, record: XoWindow.Record, channel: string, ...args: any[]): Promise<void>;
+    /**
+     * webContents 预期尺寸变化
+     * @param {Electron.Event}  event         事件对象
+     * @param {XoWindow.Record} record        窗口实例
+     * @param {Electron.Size}   preferredSize 预期尺寸
+     * @returns {Promise<void>}
+     */
+    onWebContentsPreferredSizeChanged(event: Electron.Event, record: XoWindow.Record, preferredSize: Electron.Size): Promise<void>;
+    /**
+     * webContents frame 创建
+     * @param {Electron.Event}               event   事件对象
+     * @param {XoWindow.Record}              record  窗口实例
+     * @param {Electron.FrameCreatedDetails} details Frame详情
+     * @returns {Promise<void>}
+     */
+    onWebContentsFrameCreated(event: Electron.Event, record: XoWindow.Record, details: Electron.FrameCreatedDetails): Promise<void>;
+    /**
+     * webContents 即将挂载 webview
+     * @param {Electron.Event}          event          事件对象
+     * @param {XoWindow.Record}         record         窗口实例
+     * @param {Electron.WebPreferences} webPreferences Webview配置
+     * @param {Record<string, string>}  params         Webview参数
+     * @returns {Promise<void>}
+     */
+    onWebContentsWillAttachWebview(event: Electron.Event, record: XoWindow.Record, webPreferences: Electron.WebPreferences, params: Record<string, string>): Promise<void>;
+    /**
+     * webContents 已挂载 webview
+     * @param {Electron.Event}       event       事件对象
+     * @param {XoWindow.Record}      record      窗口实例
+     * @param {Electron.WebContents} webContents Guest WebContents
+     * @returns {Promise<void>}
+     */
+    onWebContentsDidAttachWebview(event: Electron.Event, record: XoWindow.Record, webContents: Electron.WebContents): Promise<void>;
+    /**
+     * webContents 绘制
+     * @param {Electron.Event<Electron.WebContentsPaintEventParams>} details   绘制详情
+     * @param {XoWindow.Record}                                      record    窗口实例
+     * @param {Electron.Rectangle}                                   dirtyRect 脏矩形
+     * @param {Electron.NativeImage}                                 image     图像
+     * @returns {Promise<void>}
+     */
+    onWebContentsPaint(details: Electron.Event<Electron.WebContentsPaintEventParams>, record: XoWindow.Record, dirtyRect: Electron.Rectangle, image: Electron.NativeImage): Promise<void>;
+    /**
+     * webContents DevTools 刷新页面
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsDevtoolsReloadPage(record: XoWindow.Record): Promise<void>;
+    /**
+     * webContents 销毁
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsDestroyed(record: XoWindow.Record): Promise<void>;
+    /**
+     * 页面加载失败
+     * @param {Electron.Event}              event       事件对象
+     * @param {XoWindow.Record}             record      窗口实例
+     * @param {XoWindow.DidFailLoadPayload} failPayload 失败信息
+     * @returns {Promise<void>}
+     */
+    onWebContentsDidFailLoad(event: Electron.Event, record: XoWindow.Record, failPayload: XoWindow.DidFailLoadPayload): Promise<void>;
+    /**
+     * 渲染进程退出
+     * @param {Electron.Event}                    event   事件对象
+     * @param {XoWindow.Record}                   record  窗口实例
+     * @param {Electron.RenderProcessGoneDetails} details 详情
+     * @returns {Promise<void>}
+     */
+    onWebContentsRenderProcessGone(event: Electron.Event, record: XoWindow.Record, details: Electron.RenderProcessGoneDetails): Promise<void>;
+    /**
+     * 进入 HTML 全屏
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsEnterHtmlFullScreen(record: XoWindow.Record): Promise<void>;
+    /**
+     * 退出 HTML 全屏
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    onWebContentsLeaveHtmlFullScreen(record: XoWindow.Record): Promise<void>;
+    /**
+     * 窗口生命周期错误
+     * @param {XoWindow.Record}         record 窗口实例
+     * @param {XoWindow.LifecycleError} error  错误信息
+     * @returns {Promise<void>}
+     */
+    onError(record: XoWindow.Record, error: XoWindow.LifecycleError): Promise<void>;
+    /**
+     * 是否是主窗口
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {boolean}
+     * @private
+     */
+    private isMainWindow;
+    /**
+     * 是否是设置窗口
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {boolean}
+     * @private
+     */
+    private isSettingWindow;
+    /**
+     * 是否是设置窗口
+     * @param {XoWindow.Type} type 窗口类型
+     * @returns {boolean}
+     * @private
+     */
+    private isSettingWindowByType;
+    /**
+     * 获取用于持久化的窗口位置和尺寸
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Electron.Rectangle}
+     * @private
+     */
+    private getWindowRectangle;
+    /**
+     * 是否外部触发启动模式
+     * @returns {boolean}
+     * @private
+     */
+    private isExternalLaunchMode;
+}