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

external object Companion

Properties

label

open external var label: WindowLabel

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

listeners

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

Local event listeners.

Functions

_handleTauriEvent

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

activityName

external fun activityName(): Promise<String>

center

external fun center(): Promise<Void>

Centers the window.

clearEffects

external fun clearEffects(): Promise<Void>

Clear any applied effects if possible.

external fun close(): Promise<Void>

Closes the window.

destroy

external fun destroy(): Promise<Void>

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

emit

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

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

emitTo

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

external 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

external fun hide(): Promise<Void>

Sets the window visibility to false.

innerPosition

external 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

external 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

external fun isAlwaysOnTop(): Promise<Boolean>

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

isClosable

external fun isClosable(): Promise<Boolean>

Gets the window's native close button state.

isDecorated

external fun isDecorated(): Promise<Boolean>

Gets the window's current decorated state.

isEnabled

external fun isEnabled(): Promise<Boolean>

Whether the window is enabled or disabled.

isFocused

external fun isFocused(): Promise<Boolean>

Gets the window's current focus state.

isFullscreen

external fun isFullscreen(): Promise<Boolean>

Gets the window's current fullscreen state.

isMaximizable

external fun isMaximizable(): Promise<Boolean>

Gets the window's native maximize button state.

isMaximized

external fun isMaximized(): Promise<Boolean>

Gets the window's current maximized state.

isMinimizable

external fun isMinimizable(): Promise<Boolean>

Gets the window's native minimize button state.

isMinimized

external fun isMinimized(): Promise<Boolean>

Gets the window's current minimized state.

isResizable

external fun isResizable(): Promise<Boolean>

Gets the window's current resizable state.

isVisible

external fun isVisible(): Promise<Boolean>

Gets the window's current visible state.

listen

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

Listen to an emitted event on this window.

maximize

external fun maximize(): Promise<Void>

Maximizes the window.

minimize

external fun minimize(): Promise<Void>

Minimizes the window.

once

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

Listen to an emitted event on this window only once.

onCloseRequested

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

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

onDragDropEvent

external 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

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

Listen to window focus change.

onMoved

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

Listen to window move.

onResized

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

Listen to window resize.

onScaleChanged

external 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

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

Listen to the system theme change.

outerPosition

external 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

external 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

external 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

external fun scaleFactor(): Promise<Double>

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

sceneIdentifier

external fun sceneIdentifier(): Promise<String>

setAlwaysOnBottom

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

Whether the window should always be below other windows.

setAlwaysOnTop

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

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

setBackgroundColor

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

Sets the window background color.

setBadgeCount

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

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

setBadgeLabel

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

Sets the badge cont macOS only.

setClosable

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

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

setContentProtected

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

Prevents the window contents from being captured by other apps.

setCursorGrab

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

Grabs the cursor, preventing it from leaving the window.

setCursorIcon

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

Modifies the cursor icon of the window.

setCursorPosition

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

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

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

Changes the position of the cursor in window coordinates.

setCursorVisible

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

Modifies the cursor's visibility.

setDecorations

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

Whether the window should have borders and bars.

setEffects

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

Set window effects.

setEnabled

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

Enable or disable the window.

setFocus

external fun setFocus(): Promise<Void>

Bring the window to front and focus.

setFocusable

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

Sets whether the window can be focused.

setFullscreen

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

Sets the window fullscreen state.

setIcon

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

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

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

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

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

Sets the window icon.

setIgnoreCursorEvents

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

Changes the cursor events behavior.

setMaximizable

external 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

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

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

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

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

setMinimizable

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

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

setMinSize

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

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

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

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

setOverlayIcon

external fun setOverlayIcon(): Promise<Void>

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

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

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

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

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

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

setPosition

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

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

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

Sets the window outer position.

setProgressBar

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

Sets the taskbar progress state.

setResizable

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

Updates the window resizable flag.

setShadow

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

Whether or not the window should have shadow.

setSimpleFullscreen

external 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