Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EngineWindow

Window with the convenient for the Engine Interface

Hierarchy

  • EngineWindow

Index

Properties

Readonly actualGeometry

actualGeometry: Readonly<Rect>

Actual geometry

floatGeometry

floatGeometry: Rect

Geometry of a window, while in floated state

Readonly floating

floating: boolean

If this window is floating, thus its geometry is not tightly managed.

geometry

geometry: Rect

Window geometry

Readonly geometryDelta

geometryDelta: RectDelta

Difference between geometry and actual geometry

Readonly id

id: string

Window unique id

Readonly isDialog

isDialog: boolean

Whether the window is a dialog window

minimized

minimized: boolean

Whether the window is minimized

Readonly screen

screen: number

Screen number, on which the window is present

Readonly shaded

shaded: boolean

Whether the window is shaded (collapsed to the title bar)

Readonly shouldFloat

shouldFloat: boolean

Whether the window should be set to floating state

Readonly shouldIgnore

shouldIgnore: boolean

Whether the window should be ignored by the script

state

General state of the window: floating, maximized, tiled etc.

Readonly statePreviouslyAskedToChangeTo

statePreviouslyAskedToChangeTo: WindowState

State to which the window was asked to be changed previously. This can be the same state, as the current one.

surface

surface: DriverSurface

Surface, the window is currently on

Readonly tileable

tileable: boolean

If this window can be tiled by layout.

Readonly tiled

tiled: boolean

If this window is already tiled, thus a part of the current layout.

timestamp

timestamp: number

The timestamp when the last time Window was focused.

weight

weight: number

Window weight. TODO: This needs a better explanation. This has something to do with ThreeColumnLayout.

Readonly window

window: DriverWindow

Low-level implementation, usable for Driver

Methods

commit

  • commit(): void

forceSetGeometry

  • forceSetGeometry(geometry: Rect): void
  • Force apply the geometry immediately.

    This method is a quick hack created for engine#resizeFloat, thus should not be used in other places.

    Parameters

    Returns void

visibleOn

Generated using TypeDoc