Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Window

The Window aptitude provides access to the the ability to identyfy window status.

Index

Type aliases

WindowAction

WindowActionBlur

WindowActionBlur: "blur"

WindowActionClosed

WindowActionClosed: "close"

WindowActionFocused

WindowActionFocused: "focus"

WindowActionMoved

WindowActionMoved: "move"

WindowActionOpened

WindowActionOpened: "open"

WindowActionResize

WindowActionResize: "resize"

WindowActionTitleChanged

WindowActionTitleChanged: "titleChange"

Methods

activeWindow

  • Get the currently focused window and it's data.

    Returns Promise<WindowInfo>

    A promise containing active window info.

all

  • Get a list of all the windows and their information.

    Returns Promise<WindowInfo[]>

    A promise containing all window info.

listenActiveWindow

  • Receive notifications whenever the currently focused window changes.

    Parameters

    • callback: (windowInfo: WindowInfo) => void

      A function called when active window changes.

    Returns Promise<Cancellable>

listenAll

  • Receive a notification whenever a window is opened, closed, focused, unfocused, moved, resized, or its title changes. A window that is opened with focus will generate an Opened event and a Focused event.

    Parameters

    • callback: (windowEvent: WindowEvent) => void

      A function called when any window changes.

    Returns Promise<Cancellable>

Generated using TypeDoc