window-provider.interface.ts

import { Region } from "../region.class";

/**
 * A WindowActionProvider should provide access to a system's window system
 *
 * @interface WindowProviderInterface
 */
export interface WindowProviderInterface {
  /**
   * {@link getWindows} returns a list of window handles for further processing.
   * These window handles may serve as input to e.g. {@link getWindowTitle}
   *
   * @returns A list of window handles
   */
  getWindows(): Promise<number[]>;

  /**
   * {@link getActiveWindow} returns the window handle of the currently active foreground window
   *
   * @returns The handle to the currently active foreground window
   */
  getActiveWindow(): Promise<number>;

  /**
   * {@link getWindowTitle} returns the title of a window addressed via its window handle
   *
   * @returns A string representing the title of a window addressed via its window handle
   */
  getWindowTitle(windowHandle: number): Promise<string>;

  /**
   * {@link getWindowRegion} returns a {@link Region} object representing the size and position of the window addressed via its window handle
   *
   * @returns The {@link Region} occupied by the window addressed via its window handle
   */
  getWindowRegion(windowHandle: number): Promise<Region>;
}