@wailsio/runtime 3.0.0-alpha.4 → 3.0.0-alpha.40

package/types/event_types.d.ts

@@ -0,0 +1,217 @@
+
+export declare const EventTypes: {
+	Windows: {
+		SystemThemeChanged: string,
+		APMPowerStatusChange: string,
+		APMSuspend: string,
+		APMResumeAutomatic: string,
+		APMResumeSuspend: string,
+		APMPowerSettingChange: string,
+		ApplicationStarted: string,
+		WebViewNavigationCompleted: string,
+		WindowInactive: string,
+		WindowActive: string,
+		WindowClickActive: string,
+		WindowMaximise: string,
+		WindowUnMaximise: string,
+		WindowFullscreen: string,
+		WindowUnFullscreen: string,
+		WindowRestore: string,
+		WindowMinimise: string,
+		WindowUnMinimise: string,
+		WindowClosing: string,
+		WindowSetFocus: string,
+		WindowKillFocus: string,
+		WindowDragDrop: string,
+		WindowDragEnter: string,
+		WindowDragLeave: string,
+		WindowDragOver: string,
+		WindowDidMove: string,
+		WindowDidResize: string,
+		WindowShow: string,
+		WindowHide: string,
+		WindowStartMove: string,
+		WindowEndMove: string,
+		WindowStartResize: string,
+		WindowEndResize: string,
+		WindowKeyDown: string,
+		WindowKeyUp: string,
+		WindowZOrderChanged: string,
+		WindowPaint: string,
+		WindowBackgroundErase: string,
+		WindowNonClientHit: string,
+		WindowNonClientMouseDown: string,
+		WindowNonClientMouseUp: string,
+		WindowNonClientMouseMove: string,
+		WindowNonClientMouseLeave: string,
+		WindowDPIChanged: string,
+	},
+	Mac: {
+		ApplicationDidBecomeActive: string,
+		ApplicationDidChangeBackingProperties: string,
+		ApplicationDidChangeEffectiveAppearance: string,
+		ApplicationDidChangeIcon: string,
+		ApplicationDidChangeOcclusionState: string,
+		ApplicationDidChangeScreenParameters: string,
+		ApplicationDidChangeStatusBarFrame: string,
+		ApplicationDidChangeStatusBarOrientation: string,
+		ApplicationDidFinishLaunching: string,
+		ApplicationDidHide: string,
+		ApplicationDidResignActiveNotification: string,
+		ApplicationDidUnhide: string,
+		ApplicationDidUpdate: string,
+		ApplicationWillBecomeActive: string,
+		ApplicationWillFinishLaunching: string,
+		ApplicationWillHide: string,
+		ApplicationWillResignActive: string,
+		ApplicationWillTerminate: string,
+		ApplicationWillUnhide: string,
+		ApplicationWillUpdate: string,
+		ApplicationDidChangeTheme: string,
+		ApplicationShouldHandleReopen: string,
+		WindowDidBecomeKey: string,
+		WindowDidBecomeMain: string,
+		WindowDidBeginSheet: string,
+		WindowDidChangeAlpha: string,
+		WindowDidChangeBackingLocation: string,
+		WindowDidChangeBackingProperties: string,
+		WindowDidChangeCollectionBehavior: string,
+		WindowDidChangeEffectiveAppearance: string,
+		WindowDidChangeOcclusionState: string,
+		WindowDidChangeOrderingMode: string,
+		WindowDidChangeScreen: string,
+		WindowDidChangeScreenParameters: string,
+		WindowDidChangeScreenProfile: string,
+		WindowDidChangeScreenSpace: string,
+		WindowDidChangeScreenSpaceProperties: string,
+		WindowDidChangeSharingType: string,
+		WindowDidChangeSpace: string,
+		WindowDidChangeSpaceOrderingMode: string,
+		WindowDidChangeTitle: string,
+		WindowDidChangeToolbar: string,
+		WindowDidDeminiaturize: string,
+		WindowDidEndSheet: string,
+		WindowDidEnterFullScreen: string,
+		WindowMaximise: string,
+		WindowUnMaximise: string,
+		WindowDidZoom: string,
+		WindowZoomIn: string,
+		WindowZoomOut: string,
+		WindowZoomReset: string,
+		WindowDidEnterVersionBrowser: string,
+		WindowDidExitFullScreen: string,
+		WindowDidExitVersionBrowser: string,
+		WindowDidExpose: string,
+		WindowDidFocus: string,
+		WindowDidMiniaturize: string,
+		WindowDidMove: string,
+		WindowDidOrderOffScreen: string,
+		WindowDidOrderOnScreen: string,
+		WindowDidResignKey: string,
+		WindowDidResignMain: string,
+		WindowDidResize: string,
+		WindowDidUpdate: string,
+		WindowDidUpdateAlpha: string,
+		WindowDidUpdateCollectionBehavior: string,
+		WindowDidUpdateCollectionProperties: string,
+		WindowDidUpdateShadow: string,
+		WindowDidUpdateTitle: string,
+		WindowDidUpdateToolbar: string,
+		WindowShouldClose: string,
+		WindowWillBecomeKey: string,
+		WindowWillBecomeMain: string,
+		WindowWillBeginSheet: string,
+		WindowWillChangeOrderingMode: string,
+		WindowWillClose: string,
+		WindowWillDeminiaturize: string,
+		WindowWillEnterFullScreen: string,
+		WindowWillEnterVersionBrowser: string,
+		WindowWillExitFullScreen: string,
+		WindowWillExitVersionBrowser: string,
+		WindowWillFocus: string,
+		WindowWillMiniaturize: string,
+		WindowWillMove: string,
+		WindowWillOrderOffScreen: string,
+		WindowWillOrderOnScreen: string,
+		WindowWillResignMain: string,
+		WindowWillResize: string,
+		WindowWillUnfocus: string,
+		WindowWillUpdate: string,
+		WindowWillUpdateAlpha: string,
+		WindowWillUpdateCollectionBehavior: string,
+		WindowWillUpdateCollectionProperties: string,
+		WindowWillUpdateShadow: string,
+		WindowWillUpdateTitle: string,
+		WindowWillUpdateToolbar: string,
+		WindowWillUpdateVisibility: string,
+		WindowWillUseStandardFrame: string,
+		MenuWillOpen: string,
+		MenuDidOpen: string,
+		MenuDidClose: string,
+		MenuWillSendAction: string,
+		MenuDidSendAction: string,
+		MenuWillHighlightItem: string,
+		MenuDidHighlightItem: string,
+		MenuWillDisplayItem: string,
+		MenuDidDisplayItem: string,
+		MenuWillAddItem: string,
+		MenuDidAddItem: string,
+		MenuWillRemoveItem: string,
+		MenuDidRemoveItem: string,
+		MenuWillBeginTracking: string,
+		MenuDidBeginTracking: string,
+		MenuWillEndTracking: string,
+		MenuDidEndTracking: string,
+		MenuWillUpdate: string,
+		MenuDidUpdate: string,
+		MenuWillPopUp: string,
+		MenuDidPopUp: string,
+		MenuWillSendActionToItem: string,
+		MenuDidSendActionToItem: string,
+		WebViewDidStartProvisionalNavigation: string,
+		WebViewDidReceiveServerRedirectForProvisionalNavigation: string,
+		WebViewDidFinishNavigation: string,
+		WebViewDidCommitNavigation: string,
+		WindowFileDraggingEntered: string,
+		WindowFileDraggingPerformed: string,
+		WindowFileDraggingExited: string,
+		WindowShow: string,
+		WindowHide: string,
+	},
+	Linux: {
+		SystemThemeChanged: string,
+		WindowLoadChanged: string,
+		WindowDeleteEvent: string,
+		WindowDidMove: string,
+		WindowDidResize: string,
+		WindowFocusIn: string,
+		WindowFocusOut: string,
+		ApplicationStartup: string,
+	},
+	Common: {
+		ApplicationStarted: string,
+		WindowMaximise: string,
+		WindowUnMaximise: string,
+		WindowFullscreen: string,
+		WindowUnFullscreen: string,
+		WindowRestore: string,
+		WindowMinimise: string,
+		WindowUnMinimise: string,
+		WindowClosing: string,
+		WindowZoom: string,
+		WindowZoomIn: string,
+		WindowZoomOut: string,
+		WindowZoomReset: string,
+		WindowFocus: string,
+		WindowLostFocus: string,
+		WindowShow: string,
+		WindowHide: string,
+		WindowDPIChanged: string,
+		WindowFilesDropped: string,
+		WindowRuntimeReady: string,
+		ThemeChanged: string,
+		WindowDidMove: string,
+		WindowDidResize: string,
+		ApplicationOpenedWithFile: string,
+	},
+};

package/types/events.d.ts

@@ -0,0 +1,239 @@
+export function setup(): void;
+/**
+ * Register a callback function to be called multiple times for a specific event.
+ *
+ * @param {string} eventName - The name of the event to register the callback for.
+ * @param {function} callback - The callback function to be called when the event is triggered.
+ * @param {number} maxCallbacks - The maximum number of times the callback can be called for the event. Once the maximum number is reached, the callback will no longer be called.
+ *
+ @return {function} - A function that, when called, will unregister the callback from the event.
+ */
+export function OnMultiple(eventName: string, callback: Function, maxCallbacks: number): Function;
+/**
+ * Registers a callback function to be executed when the specified event occurs.
+ *
+ * @param {string} eventName - The name of the event.
+ * @param {function} callback - The callback function to be executed. It takes no parameters.
+ * @return {function} - A function that, when called, will unregister the callback from the event. */
+export function On(eventName: string, callback: Function): Function;
+/**
+ * Registers a callback function to be executed only once for the specified event.
+ *
+ * @param {string} eventName - The name of the event.
+ * @param {function} callback - The function to be executed when the event occurs.
+ * @return {function} - A function that, when called, will unregister the callback from the event.
+ */
+export function Once(eventName: string, callback: Function): Function;
+/**
+ * Removes event listeners for the specified event names.
+ *
+ * @param {string} eventName - The name of the event to remove listeners for.
+ * @param {...string} additionalEventNames - Additional event names to remove listeners for.
+ * @return {undefined}
+ */
+export function Off(eventName: string, ...additionalEventNames: string[]): undefined;
+/**
+ * Removes all event listeners.
+ *
+ * @function OffAll
+ * @returns {void}
+ */
+export function OffAll(): void;
+/**
+ * Emits an event using the given event name.
+ *
+ * @param {WailsEvent} event - The name of the event to emit.
+ * @returns {any} - The result of the emitted event.
+ */
+export function Emit(event: WailsEvent): any;
+export const Types: {
+    Windows: {
+        SystemThemeChanged: string;
+        APMPowerStatusChange: string;
+        APMSuspend: string;
+        APMResumeAutomatic: string;
+        APMResumeSuspend: string;
+        APMPowerSettingChange: string;
+        ApplicationStarted: string;
+        WebViewNavigationCompleted: string;
+        WindowInactive: string;
+        WindowActive: string;
+        WindowClickActive: string;
+        WindowMaximise: string;
+        WindowUnMaximise: string;
+        WindowFullscreen: string;
+        WindowUnFullscreen: string;
+        WindowRestore: string;
+        WindowMinimise: string;
+        WindowUnMinimise: string;
+        WindowClose: string;
+        WindowSetFocus: string;
+        WindowKillFocus: string;
+        WindowDragDrop: string;
+        WindowDragEnter: string;
+        WindowDragLeave: string;
+        WindowDragOver: string;
+    };
+    Mac: {
+        ApplicationDidBecomeActive: string;
+        ApplicationDidChangeBackingProperties: string;
+        ApplicationDidChangeEffectiveAppearance: string;
+        ApplicationDidChangeIcon: string;
+        ApplicationDidChangeOcclusionState: string;
+        ApplicationDidChangeScreenParameters: string;
+        ApplicationDidChangeStatusBarFrame: string;
+        ApplicationDidChangeStatusBarOrientation: string;
+        ApplicationDidFinishLaunching: string;
+        ApplicationDidHide: string;
+        ApplicationDidResignActiveNotification: string;
+        ApplicationDidUnhide: string;
+        ApplicationDidUpdate: string;
+        ApplicationWillBecomeActive: string;
+        ApplicationWillFinishLaunching: string;
+        ApplicationWillHide: string;
+        ApplicationWillResignActive: string;
+        ApplicationWillTerminate: string;
+        ApplicationWillUnhide: string;
+        ApplicationWillUpdate: string;
+        ApplicationDidChangeTheme: string;
+        ApplicationShouldHandleReopen: string;
+        WindowDidBecomeKey: string;
+        WindowDidBecomeMain: string;
+        WindowDidBeginSheet: string;
+        WindowDidChangeAlpha: string;
+        WindowDidChangeBackingLocation: string;
+        WindowDidChangeBackingProperties: string;
+        WindowDidChangeCollectionBehavior: string;
+        WindowDidChangeEffectiveAppearance: string;
+        WindowDidChangeOcclusionState: string;
+        WindowDidChangeOrderingMode: string;
+        WindowDidChangeScreen: string;
+        WindowDidChangeScreenParameters: string;
+        WindowDidChangeScreenProfile: string;
+        WindowDidChangeScreenSpace: string;
+        WindowDidChangeScreenSpaceProperties: string;
+        WindowDidChangeSharingType: string;
+        WindowDidChangeSpace: string;
+        WindowDidChangeSpaceOrderingMode: string;
+        WindowDidChangeTitle: string;
+        WindowDidChangeToolbar: string;
+        WindowDidChangeVisibility: string;
+        WindowDidDeminiaturize: string;
+        WindowDidEndSheet: string;
+        WindowDidEnterFullScreen: string;
+        WindowDidEnterVersionBrowser: string;
+        WindowDidExitFullScreen: string;
+        WindowDidExitVersionBrowser: string;
+        WindowDidExpose: string;
+        WindowDidFocus: string;
+        WindowDidMiniaturize: string;
+        WindowDidMove: string;
+        WindowDidOrderOffScreen: string;
+        WindowDidOrderOnScreen: string;
+        WindowDidResignKey: string;
+        WindowDidResignMain: string;
+        WindowDidResize: string;
+        WindowDidUpdate: string;
+        WindowDidUpdateAlpha: string;
+        WindowDidUpdateCollectionBehavior: string;
+        WindowDidUpdateCollectionProperties: string;
+        WindowDidUpdateShadow: string;
+        WindowDidUpdateTitle: string;
+        WindowDidUpdateToolbar: string;
+        WindowDidUpdateVisibility: string;
+        WindowShouldClose: string;
+        WindowWillBecomeKey: string;
+        WindowWillBecomeMain: string;
+        WindowWillBeginSheet: string;
+        WindowWillChangeOrderingMode: string;
+        WindowWillClose: string;
+        WindowWillDeminiaturize: string;
+        WindowWillEnterFullScreen: string;
+        WindowWillEnterVersionBrowser: string;
+        WindowWillExitFullScreen: string;
+        WindowWillExitVersionBrowser: string;
+        WindowWillFocus: string;
+        WindowWillMiniaturize: string;
+        WindowWillMove: string;
+        WindowWillOrderOffScreen: string;
+        WindowWillOrderOnScreen: string;
+        WindowWillResignMain: string;
+        WindowWillResize: string;
+        WindowWillUnfocus: string;
+        WindowWillUpdate: string;
+        WindowWillUpdateAlpha: string;
+        WindowWillUpdateCollectionBehavior: string;
+        WindowWillUpdateCollectionProperties: string;
+        WindowWillUpdateShadow: string;
+        WindowWillUpdateTitle: string;
+        WindowWillUpdateToolbar: string;
+        WindowWillUpdateVisibility: string;
+        WindowWillUseStandardFrame: string;
+        MenuWillOpen: string;
+        MenuDidOpen: string;
+        MenuDidClose: string;
+        MenuWillSendAction: string;
+        MenuDidSendAction: string;
+        MenuWillHighlightItem: string;
+        MenuDidHighlightItem: string;
+        MenuWillDisplayItem: string;
+        MenuDidDisplayItem: string;
+        MenuWillAddItem: string;
+        MenuDidAddItem: string;
+        MenuWillRemoveItem: string;
+        MenuDidRemoveItem: string;
+        MenuWillBeginTracking: string;
+        MenuDidBeginTracking: string;
+        MenuWillEndTracking: string;
+        MenuDidEndTracking: string;
+        MenuWillUpdate: string;
+        MenuDidUpdate: string;
+        MenuWillPopUp: string;
+        MenuDidPopUp: string;
+        MenuWillSendActionToItem: string;
+        MenuDidSendActionToItem: string;
+        WebViewDidStartProvisionalNavigation: string;
+        WebViewDidReceiveServerRedirectForProvisionalNavigation: string;
+        WebViewDidFinishNavigation: string;
+        WebViewDidCommitNavigation: string;
+        WindowFileDraggingEntered: string;
+        WindowFileDraggingPerformed: string;
+        WindowFileDraggingExited: string;
+    };
+    Linux: {
+        SystemThemeChanged: string;
+        WindowLoadChanged: string;
+        WindowDeleteEvent: string;
+        WindowFocusIn: string;
+        WindowFocusOut: string;
+        ApplicationStartup: string;
+    };
+    Common: {
+        ApplicationStarted: string;
+        WindowMaximise: string;
+        WindowUnMaximise: string;
+        WindowFullscreen: string;
+        WindowUnFullscreen: string;
+        WindowRestore: string;
+        WindowMinimise: string;
+        WindowUnMinimise: string;
+        WindowClosing: string;
+        WindowZoom: string;
+        WindowZoomIn: string;
+        WindowZoomOut: string;
+        WindowZoomReset: string;
+        WindowFocus: string;
+        WindowLostFocus: string;
+        WindowShow: string;
+        WindowHide: string;
+        WindowDPIChanged: string;
+        WindowFilesDropped: string;
+        WindowRuntimeReady: string;
+        ThemeChanged: string;
+    };
+};
+export class WailsEvent {
+    constructor(name: any, data?: any);
+    name: any;
+    data: any;
+}

package/types/flags.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Retrieves the value associated with the specified key from the flag map.
+ *
+ * @param {string} keyString - The key to retrieve the value for.
+ * @return {*} - The value associated with the specified key.
+ */
+export function GetFlag(keyString: string): any;

package/types/index.d.ts

@@ -0,0 +1,13 @@
+import * as Application from "./application";
+import * as Browser from "./browser";
+import * as Call from "./calls";
+import * as Clipboard from "./clipboard";
+import * as Create from "./create";
+import * as Dialogs from "./dialogs";
+import * as Events from "./events";
+import * as Flags from "./flags";
+import * as Screens from "./screens";
+import * as System from "./system";
+import Window from "./window";
+import * as WML from "./wml";
+export { Application, Browser, Call, Clipboard, Create, Dialogs, Events, Flags, Screens, System, Window, WML };

package/types/runtime.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Creates a runtime caller function that invokes a specified method on a given object within a specified window context.
+ *
+ * @param {Object} object - The object on which the method is to be invoked.
+ * @param {string} windowName - The name of the window context in which the method should be called.
+ * @returns {Function} A runtime caller function that takes the method name and optionally arguments and invokes the method within the specified window context.
+ */
+export function newRuntimeCaller(object: any, windowName: string): Function;
+/**
+ * Creates a new runtime caller with specified ID.
+ *
+ * @param {object} object - The object to invoke the method on.
+ * @param {string} windowName - The name of the window.
+ * @return {Function} - The new runtime caller function.
+ */
+export function newRuntimeCallerWithID(object: object, windowName: string): Function;
+export namespace objectNames {
+    let Call: number;
+    let Clipboard: number;
+    let Application: number;
+    let Events: number;
+    let ContextMenu: number;
+    let Dialog: number;
+    let Window: number;
+    let Screens: number;
+    let System: number;
+    let Browser: number;
+    let CancelCall: number;
+}
+export let clientId: string;

package/types/screens.d.ts

@@ -0,0 +1,94 @@
+/**
+ * Gets all screens.
+ * @returns {Promise<Screen[]>} A promise that resolves to an array of Screen objects.
+ */
+export function GetAll(): Promise<Screen[]>;
+/**
+ * Gets the primary screen.
+ * @returns {Promise<Screen>} A promise that resolves to the primary screen.
+ */
+export function GetPrimary(): Promise<Screen>;
+/**
+ * Gets the current active screen.
+ *
+ * @returns {Promise<Screen>} A promise that resolves with the current active screen.
+ */
+export function GetCurrent(): Promise<Screen>;
+export type Size = {
+    /**
+     * - The width.
+     */
+    Width: number;
+    /**
+     * - The height.
+     */
+    Height: number;
+};
+export type Rect = {
+    /**
+     * - The X coordinate of the origin.
+     */
+    X: number;
+    /**
+     * - The Y coordinate of the origin.
+     */
+    Y: number;
+    /**
+     * - The width of the rectangle.
+     */
+    Width: number;
+    /**
+     * - The height of the rectangle.
+     */
+    Height: number;
+};
+export type Screen = {
+    /**
+     * - Unique identifier for the screen.
+     */
+    ID: string;
+    /**
+     * - Human readable name of the screen.
+     */
+    Name: string;
+    /**
+     * - The scale factor of the screen (DPI/96). 1 = standard DPI, 2 = HiDPI (Retina), etc.
+     */
+    ScaleFactor: number;
+    /**
+     * - The X coordinate of the screen.
+     */
+    X: number;
+    /**
+     * - The Y coordinate of the screen.
+     */
+    Y: number;
+    /**
+     * - Contains the width and height of the screen.
+     */
+    Size: Size;
+    /**
+     * - Contains the bounds of the screen in terms of X, Y, Width, and Height.
+     */
+    Bounds: Rect;
+    /**
+     * - Contains the physical bounds of the screen in terms of X, Y, Width, and Height (before scaling).
+     */
+    PhysicalBounds: Rect;
+    /**
+     * - Contains the area of the screen that is actually usable (excluding taskbar and other system UI).
+     */
+    WorkArea: Rect;
+    /**
+     * - Contains the physical WorkArea of the screen (before scaling).
+     */
+    PhysicalWorkArea: Rect;
+    /**
+     * - True if this is the primary monitor selected by the user in the operating system.
+     */
+    IsPrimary: boolean;
+    /**
+     * - The rotation of the screen.
+     */
+    Rotation: number;
+};