Package-level declarations

Types

Link copied to clipboard
sealed external interface BackgroundThrottlingPolicy

Background throttling policy

Link copied to clipboard
external class CloseRequestedEvent

The event passed to a {@link Window.onCloseRequested} handler.

Link copied to clipboard
typealias Color = Any

An RGBA color. Each value has minimum of 0 and maximum of 255.

Link copied to clipboard
sealed external interface CursorIcon

The cursor shape to display over a window, see {@link Window.setCursorIcon}.

Link copied to clipboard
sealed external interface Effect

Platform-specific window effects

Link copied to clipboard
external interface Effects

The window effects configuration object

Link copied to clipboard
sealed external interface EffectState

Window effect state macOS only

Link copied to clipboard
external interface Monitor

Allows you to retrieve information about a given monitor.

Link copied to clipboard
external interface MonitorWorkArea
Link copied to clipboard
external interface PreventOverflowMargin

An extra margin kept free around a window when {@link WindowOptions.preventOverflow} limits it to the working area.

Link copied to clipboard
external interface ProgressBarState

The taskbar/dock progress indicator state, see {@link Window.setProgressBar}.

Link copied to clipboard
sealed external interface ProgressBarStatus

The state of the taskbar/dock progress bar, see {@link Window.setProgressBar}.

Link copied to clipboard
sealed external interface ResizeDirection

The edge or corner a resize drag started from, see {@link Window.startResizeDragging}.

Link copied to clipboard
external interface ScaleFactorChanged

The payload for the scaleChange event.

Link copied to clipboard
sealed external interface ScrollBarStyle

The scrollbar style to use in the webview.

Link copied to clipboard
sealed external interface Theme

The light or dark appearance of a window or of the system.

Link copied to clipboard
sealed external interface TitleBarStyle

The style of the window title bar. macOS only

Link copied to clipboard
sealed external interface UserAttentionType

Attention type to request on a window.

Link copied to clipboard
open external class Window

Create new window or get a handle to an existing one.

Link copied to clipboard
typealias WindowLabel = String
Link copied to clipboard
external interface WindowOptions

Configuration for the window to create.

Link copied to clipboard
external interface WindowSizeConstraints

Inner size constraints for a window, see {@link Window.setSizeConstraints}.

Properties

Link copied to clipboard
val CursorIcon.Companion.alias: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.allScroll: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.arrow: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.cell: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.colResize: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.contextMenu: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.copy: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.crosshair: CursorIcon
Link copied to clipboard
val Theme.Companion.dark: Theme
Link copied to clipboard
val CursorIcon.Companion.default: CursorIcon
Link copied to clipboard
val ResizeDirection.Companion.East: ResizeDirection
Link copied to clipboard
val CursorIcon.Companion.eResize: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.ewResize: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.grab: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.grabbing: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.hand: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.help: CursorIcon
Link copied to clipboard
val Theme.Companion.light: Theme
Link copied to clipboard
val CursorIcon.Companion.move: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.neResize: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.neswResize: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.noDrop: CursorIcon
Link copied to clipboard
val ResizeDirection.Companion.North: ResizeDirection
Link copied to clipboard
val ResizeDirection.Companion.NorthEast: ResizeDirection
Link copied to clipboard
val ResizeDirection.Companion.NorthWest: ResizeDirection
Link copied to clipboard
val CursorIcon.Companion.notAllowed: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.nResize: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.nsResize: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.nwResize: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.nwseResize: CursorIcon
Link copied to clipboard
val TitleBarStyle.Companion.overlay: TitleBarStyle
Link copied to clipboard
val CursorIcon.Companion.progress: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.rowResize: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.seResize: CursorIcon
Link copied to clipboard
val ResizeDirection.Companion.South: ResizeDirection
Link copied to clipboard
val ResizeDirection.Companion.SouthEast: ResizeDirection
Link copied to clipboard
val ResizeDirection.Companion.SouthWest: ResizeDirection
Link copied to clipboard
val CursorIcon.Companion.sResize: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.swResize: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.text: CursorIcon
Link copied to clipboard
val TitleBarStyle.Companion.transparent: TitleBarStyle
Link copied to clipboard
val CursorIcon.Companion.verticalText: CursorIcon
Link copied to clipboard
val TitleBarStyle.Companion.visible: TitleBarStyle
Link copied to clipboard
val CursorIcon.Companion.wait: CursorIcon
Link copied to clipboard
val ResizeDirection.Companion.West: ResizeDirection
Link copied to clipboard
val CursorIcon.Companion.wResize: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.zoomIn: CursorIcon
Link copied to clipboard
val CursorIcon.Companion.zoomOut: CursorIcon

Functions

Link copied to clipboard

Returns the list of all the monitors available on the system.

Link copied to clipboard
external fun currentMonitor(): Promise<Monitor?>

Returns the monitor on which the window currently resides. Returns null if current monitor can't be detected.

Link copied to clipboard

Get the cursor position relative to the top-left hand corner of the desktop.

Link copied to clipboard

Gets a list of instances of Window for all available windows.

Link copied to clipboard
external fun getCurrentWindow(): Window

Get an instance of Window for the current window.

Link copied to clipboard
external fun monitorFromPoint(x: Double, y: Double): Promise<Monitor?>

Returns the monitor that contains the given point. Returns null if can't find any.

Link copied to clipboard
external fun primaryMonitor(): Promise<Monitor?>

Returns the primary monitor of the system. Returns null if it can't identify any monitor as a primary one.