kotlin-tauri-apps-api/tauri.apps.api.window/Window

Window

open external class Window(source)

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

Windows are identified by a label a unique identifier that can be used to reference it later. It may only contain alphanumeric characters a-zA-Z plus the following special characters -, /, : and _.

Since

2.0.0

Constructors

Window

constructor(label: WindowLabel, options: WindowOptions = definedExternally)

Creates a new Window.

Types

Companion

object Companion

Properties

label

open var label: WindowLabel

The window label. It is a unique identifier for the window, can be used to reference it later.

listeners

open var listeners: ReadonlyRecord<String, ReadonlyArray<EventCallback<Any?>>>

Local event listeners.

Functions

_handleTauriEvent

fun <T> _handleTauriEvent(event: String, handler: EventCallback<T>): Boolean

center

fun center(): Promise<Void>

Centers the window.

clearEffects

fun clearEffects(): Promise<Void>

Clear any applied effects if possible.

fun close(): Promise<Void>

Closes the window.

destroy

fun destroy(): Promise<Void>

Destroys the window. Behaves like {@link Window.close} but forces the window close instead of emitting a closeRequested event.

emit

fun <T> emit(event: String, payload: T = definedExternally): Promise<Void>

Emits an event to all {@link EventTarget|targets}.

emitTo

fun <T> emitTo(target: EventTarget, event: String, payload: T = definedExternally): Promise<Void>

fun <T> emitTo(target: String, event: String, payload: T = definedExternally): Promise<Void>

Emits an event to all {@link EventTarget|targets} matching the given target.

hide

fun hide(): Promise<Void>

Sets the window visibility to false.

innerPosition

fun innerPosition(): Promise<PhysicalPosition>

The position of the top-left hand corner of the window's client area relative to the top-left hand corner of the desktop.

innerSize

fun innerSize(): Promise<PhysicalSize>

The physical size of the window's client area. The client area is the content of the window, excluding the title bar and borders.

isAlwaysOnTop

fun isAlwaysOnTop(): Promise<Boolean>

Whether the window is configured to be always on top of other windows or not.

isClosable

fun isClosable(): Promise<Boolean>

Gets the window's native close button state.

isDecorated

fun isDecorated(): Promise<Boolean>

Gets the window's current decorated state.

isEnabled

fun isEnabled(): Promise<Boolean>

Whether the window is enabled or disabled.

isFocused

fun isFocused(): Promise<Boolean>

Gets the window's current focus state.

isFullscreen

fun isFullscreen(): Promise<Boolean>

Gets the window's current fullscreen state.

isMaximizable

fun isMaximizable(): Promise<Boolean>

Gets the window's native maximize button state.

isMaximized

fun isMaximized(): Promise<Boolean>

Gets the window's current maximized state.

isMinimizable

fun isMinimizable(): Promise<Boolean>

Gets the window's native minimize button state.

isMinimized

fun isMinimized(): Promise<Boolean>

Gets the window's current minimized state.

isResizable

fun isResizable(): Promise<Boolean>

Gets the window's current resizable state.

isVisible

fun isVisible(): Promise<Boolean>

Gets the window's current visible state.

listen

open fun <T> listen(event: EventName, handler: EventCallback<T>): Promise<UnlistenFn>

Listen to an emitted event on this window.

maximize

fun maximize(): Promise<Void>

Maximizes the window.

minimize

fun minimize(): Promise<Void>

Minimizes the window.

once

open fun <T> once(event: EventName, handler: EventCallback<T>): Promise<UnlistenFn>

Listen to an emitted event on this window only once.

onCloseRequested

fun onCloseRequested(handler: (event: CloseRequestedEvent) -> Any): Promise<UnlistenFn>

Listen to window close requested. Emitted when the user requests to closes the window.

onDragDropEvent

fun onDragDropEvent(handler: EventCallback<DragDropEvent>): Promise<UnlistenFn>

Listen to a file drop event. The listener is triggered when the user hovers the selected files on the webview, drops the files or cancels the operation.

onFocusChanged

fun onFocusChanged(handler: EventCallback<Boolean>): Promise<UnlistenFn>

Listen to window focus change.

onMoved

fun onMoved(handler: EventCallback<PhysicalPosition>): Promise<UnlistenFn>

Listen to window move.

onResized

fun onResized(handler: EventCallback<PhysicalSize>): Promise<UnlistenFn>

Listen to window resize.

onScaleChanged

fun onScaleChanged(handler: EventCallback<ScaleFactorChanged>): Promise<UnlistenFn>

Listen to window scale change. Emitted when the window's scale factor has changed. The following user actions can cause DPI changes:

onThemeChanged

fun onThemeChanged(handler: EventCallback<Theme>): Promise<UnlistenFn>

Listen to the system theme change.

outerPosition

fun outerPosition(): Promise<PhysicalPosition>

The position of the top-left hand corner of the window relative to the top-left hand corner of the desktop.

outerSize

fun outerSize(): Promise<PhysicalSize>

The physical size of the entire window. These dimensions include the title bar and borders. If you don't want that (and you usually don't), use inner_size instead.

requestUserAttention

fun requestUserAttention(requestType: UserAttentionType?): Promise<Void>

Requests user attention to the window, this has no effect if the application is already focused. How requesting for user attention manifests is platform dependent, see UserAttentionType for details.

scaleFactor

fun scaleFactor(): Promise<Double>

The scale factor that can be used to map physical pixels to logical pixels.

setAlwaysOnBottom

fun setAlwaysOnBottom(alwaysOnBottom: Boolean): Promise<Void>

Whether the window should always be below other windows.

setAlwaysOnTop

fun setAlwaysOnTop(alwaysOnTop: Boolean): Promise<Void>

Whether the window should always be on top of other windows.

setBackgroundColor

open fun setBackgroundColor(color: Color): Promise<Void>

Sets the window background color.

setBadgeCount

fun setBadgeCount(count: Double = definedExternally): Promise<Void>

Sets the badge count. It is app wide and not specific to this window.

setBadgeLabel

fun setBadgeLabel(label: String = definedExternally): Promise<Void>

Sets the badge cont macOS only.

setClosable

fun setClosable(closable: Boolean): Promise<Void>

Sets whether the window's native close button is enabled or not.

setContentProtected

fun setContentProtected(protected_: Boolean): Promise<Void>

Prevents the window contents from being captured by other apps.

setCursorGrab

fun setCursorGrab(grab: Boolean): Promise<Void>

Grabs the cursor, preventing it from leaving the window.

setCursorIcon

fun setCursorIcon(icon: CursorIcon): Promise<Void>

Modifies the cursor icon of the window.

setCursorPosition

fun setCursorPosition(position: LogicalPosition): Promise<Void>

fun setCursorPosition(position: PhysicalPosition): Promise<Void>

fun setCursorPosition(position: Position): Promise<Void>

Changes the position of the cursor in window coordinates.

setCursorVisible

fun setCursorVisible(visible: Boolean): Promise<Void>

Modifies the cursor's visibility.

setDecorations

fun setDecorations(decorations: Boolean): Promise<Void>

Whether the window should have borders and bars.

setEffects

fun setEffects(effects: Effects): Promise<Void>

Set window effects.

setEnabled

fun setEnabled(enabled: Boolean): Promise<Void>

Enable or disable the window.

setFocus

fun setFocus(): Promise<Void>

Bring the window to front and focus.

setFocusable

fun setFocusable(focusable: Boolean): Promise<Void>

Sets whether the window can be focused.

setFullscreen

fun setFullscreen(fullscreen: Boolean): Promise<Void>

Sets the window fullscreen state.

setIcon

fun setIcon(icon: ArrayBuffer): Promise<Void>

fun setIcon(icon: Uint8Array<*>): Promise<Void>

fun setIcon(icon: ReadonlyArray<Double>): Promise<Void>

fun setIcon(icon: String): Promise<Void>

fun setIcon(icon: Image): Promise<Void>

Sets the window icon.

setIgnoreCursorEvents

fun setIgnoreCursorEvents(ignore: Boolean): Promise<Void>

Changes the cursor events behavior.

setMaximizable

fun setMaximizable(maximizable: Boolean): Promise<Void>

Sets whether the window's native maximize button is enabled or not. If resizable is set to false, this setting is ignored.

setMaxSize

fun setMaxSize(size: LogicalSize?): Promise<Void>

fun setMaxSize(size: PhysicalSize?): Promise<Void>

fun setMaxSize(size: Size?): Promise<Void>

Sets the window maximum inner size. If the size argument is undefined, the constraint is unset.

setMinimizable

fun setMinimizable(minimizable: Boolean): Promise<Void>

Sets whether the window's native minimize button is enabled or not.

setMinSize

fun setMinSize(size: LogicalSize?): Promise<Void>

fun setMinSize(size: PhysicalSize?): Promise<Void>

fun setMinSize(size: Size?): Promise<Void>

Sets the window minimum inner size. If the size argument is not provided, the constraint is unset.

setOverlayIcon

fun setOverlayIcon(): Promise<Void>

fun setOverlayIcon(icon: ArrayBuffer = definedExternally): Promise<Void>

fun setOverlayIcon(icon: Uint8Array<*> = definedExternally): Promise<Void>

fun setOverlayIcon(icon: ReadonlyArray<Double> = definedExternally): Promise<Void>

fun setOverlayIcon(icon: String = definedExternally): Promise<Void>

fun setOverlayIcon(icon: Image = definedExternally): Promise<Void>

Sets the overlay icon. Windows only The overlay icon can be set for every window.

setPosition

fun setPosition(position: LogicalPosition): Promise<Void>

fun setPosition(position: PhysicalPosition): Promise<Void>

fun setPosition(position: Position): Promise<Void>

Sets the window outer position.

setProgressBar

fun setProgressBar(state: ProgressBarState): Promise<Void>

Sets the taskbar progress state.

setResizable

fun setResizable(resizable: Boolean): Promise<Void>

Updates the window resizable flag.

setShadow

fun setShadow(enable: Boolean): Promise<Void>

Whether or not the window should have shadow.

setSimpleFullscreen

fun setSimpleFullscreen(fullscreen: Boolean): Promise<Void>

On macOS, Toggles a fullscreen mode that doesn’t require a new macOS space. Returns a boolean indicating whether the transition was successful (this won’t work if the window was already in the native fullscreen). This is how fullscreen used to work on macOS in versions before Lion. And allows the user to have a fullscreen window without using another space or taking control over the entire monitor.

setSize