Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a Windows 96 application instance.

Hierarchy

  • WApplicationInstance

Index

Constructors

constructor

  • new WApplicationInstance(): any
  • Returns any

Properties

_appResult

_appResult: any

[internal] The exit result.

_running

_running: Boolean

[internal] Whether the application is still running.

_terminating

_terminating: Boolean

[internal] Whether the application is in the process of shutting down.

Readonly appId

appId: Number

The app (process) ID.

Incremented when a new instance is created. You can use this ID to kill your process.

Readonly appWindow

appWindow: StandardWindow

The main application window.

execCtx

Execution context.

Readonly ipcEQs

ipcEQs: string[]

IPC event queues.

title

title: string

Process title.

Readonly windows

windows: StandardWindow[]

A list containing all window objects owned by this application.

Methods

createWindow

  • !! Do not override !! Creates a new window for the specified application.

    Set isAppWindow to false to create a sub window that closes when the main window closes.

    Parameters

    • params: WindowParams

      The parameters to use to create the window.

    • isAppWindow: boolean

      Specifies whether this is an application window (the main window). Only one such window is allowed to exist.

    Returns StandardWindow

main

  • main(argv: string[]): Promise<any>
  • The entry point to the application.

    Parameters

    • argv: string[]

      The arguments to pass to the application.

    Returns Promise<any>

Optional onterminated

  • onterminated(result: any): void
  • Called when the application is terminated.

    Parameters

    • result: any

      A user defined result.

    Returns void

ontermination

  • ontermination(): void
  • Called when the application will be terminated.

    Returns void

registerIpcEQ

  • Registers an IPC event queue.

    Parameters

    • name: string

      The name of the queue to create.

    Returns EventEmitter

setAppResult

  • setAppResult(v: any): void
  • Sets a value as the app result.

    Parameters

    • v: any

      The value to use as a result.

    Returns void

terminate

  • terminate(): void
  • Terminates the application.

    Returns void

unregisterAllEQs

  • unregisterAllEQs(): void
  • Unregisters all event queues.

    Returns void

unregisterIpcEQ

  • unregisterIpcEQ(name: string): void
  • Unregisters an Ipc EQ.

    Parameters

    • name: string

      The name of the queue to unregister.

    Returns void

Generated using TypeDoc