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

Submenu

open external class Submenu : MenuItemBase(source)

A type that is a submenu inside a {@linkcode Menu} or {@linkcode Submenu}.

Constructors

Submenu

constructor(rid: Double, id: String)

Types

Companion

external object Companion

Properties

external val id: String

The id of this item.

kind

external val kind: String

rid

external val rid: Double

Functions

append

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

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

Add a menu item to the end of this submenu.

external 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.

get

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

Retrieves the menu item matching the given identifier.

insert

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

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

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

isEnabled

external fun isEnabled(): Promise<Boolean>

Returns whether this submenu is enabled or not.

items

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

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

popup

external fun popup(): Promise<Void>

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

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

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

prepend

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

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

Add a menu item to the beginning of this submenu.

remove

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

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

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

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

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

Remove a menu item from this submenu.

removeAt

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

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

setAsHelpMenuForNSApp

external fun setAsHelpMenuForNSApp(): Promise<Void>

Set this submenu as the Help menu for the application on macOS.

setAsWindowsMenuForNSApp

external fun setAsWindowsMenuForNSApp(): Promise<Void>

Set this submenu as the Window menu for the application on macOS.

setEnabled

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

Sets whether this submenu is enabled or not.

setIcon

external fun setIcon(icon: MenuIcon?): Promise<Void>

Sets an icon for this submenu

setText

external fun setText(text: String): Promise<Void>

Sets the text for this submenu.

text

external fun text(): Promise<String>

Returns the text of this submenu.