kotlin-electron/electron.core/GlobalShortcut

GlobalShortcut

external interface GlobalShortcut(source)

Functions

isRegistered

abstract fun isRegistered(accelerator: String): Boolean

Whether this application has registered accelerator.

isSuspended

abstract fun isSuspended(): Boolean

Whether global shortcut handling is currently suspended.

abstract fun register(accelerator: String, callback: () -> Unit): Boolean

Whether or not the shortcut was registered successfully.

registerAll

abstract fun registerAll(accelerators: ReadonlyArray<String>, callback: () -> Unit)

Registers a global shortcut of all accelerator items in accelerators. The callback is called when any of the registered shortcuts are pressed by the user.

setSuspended

abstract fun setSuspended(suspended: Boolean)

Suspends or resumes global shortcut handling. When suspended, all registered global shortcuts will stop listening for key presses. When resumed, all previously registered shortcuts will begin listening again. New shortcut registrations will fail while handling is suspended.

unregister

abstract fun unregister(accelerator: String)

Unregisters the global shortcut of accelerator.

unregisterAll

abstract fun unregisterAll()

Unregisters all of the global shortcuts.