kotlin-tauri-apps-api/tauri.apps.api.menu/Menu

Menu

open external class Menu : MenuItemBase(source)

A type that is either a menu bar on the window on Windows and Linux or as a global menu in the menubar on macOS.

Platform-specific:

macOS: if using {@linkcode Menu} for the global menubar, it can only contain {@linkcode Submenu}s.

Constructors

constructor(rid: Double, id: String)

Types

object Companion

Properties

The id of this item.

val kind: String

val rid: Double

Functions

fun <T : Any> append(items: T): Promise<Void>

fun <T : Any> append(items: ReadonlyArray<T>): Promise<Void>

Add a menu item to the end of this menu.

fun close(): Promise<Void>

Destroys and cleans up this resource from memory. You should not call any method on this object anymore and should drop any reference to it.

fun get(id: String): Promise<Any?>

Retrieves the menu item matching the given identifier.

fun <T : Any> insert(items: T, position: Double): Promise<Void>

fun <T : Any> insert(items: ReadonlyArray<T>, position: Double): Promise<Void>

Add a menu item to the specified position in this menu.

fun items(): Promise<ReadonlyArray<Any>>

Returns a list of menu items that has been added to this menu.

fun popup(): Promise<Void>

fun popup(at: LogicalPosition = definedExternally, window: Window = definedExternally): Promise<Void>

fun popup(at: PhysicalPosition = definedExternally, window: Window = definedExternally): Promise<Void>

fun popup(at: Position = definedExternally, window: Window = definedExternally): Promise<Void>

Popup this menu as a context menu on the specified window.

fun <T : Any> prepend(items: T): Promise<Void>

fun <T : Any> prepend(items: ReadonlyArray<T>): Promise<Void>

Add a menu item to the beginning of this menu.

fun remove(item: CheckMenuItem): Promise<Void>

fun remove(item: IconMenuItem): Promise<Void>

fun remove(item: MenuItem): Promise<Void>

fun remove(item: PredefinedMenuItem): Promise<Void>

fun remove(item: Submenu): Promise<Void>

Remove a menu item from this menu.

fun removeAt(position: Double): Promise<Any?>

Remove a menu item from this menu at the specified position.

fun setAsAppMenu(): Promise<Menu?>

Sets the app-wide menu and returns the previous one.

setAsWindowMenu

fun setAsWindowMenu(window: Window = definedExternally): Promise<Menu?>

Sets the window menu and returns the previous one.