kotlin-electron/electron.core/GlobalShortcut

GlobalShortcut

external interface GlobalShortcut(source)

Functions

isRegistered

abstract external fun isRegistered(accelerator: String): Boolean

Whether this application has registered accelerator.

isSuspended

abstract external fun isSuspended(): Boolean

Whether global shortcut handling is currently suspended.

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

Whether or not the shortcut was registered successfully.

registerAll

abstract external 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 external 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 external fun unregister(accelerator: String)

Unregisters the global shortcut of accelerator.

unregisterAll

abstract external fun unregisterAll()

Unregisters all of the global shortcuts.