mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
39 lines
1.5 KiB
TypeScript
39 lines
1.5 KiB
TypeScript
// Type definitions for Electron v0.37.2
|
|
// Project: http://electron.atom.io/
|
|
// Definitions by: jedmao <https://github.com/jedmao/>, rhysd <https://rhysd.github.io>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
declare namespace Electron {
|
|
/**
|
|
* The globalShortcut module can register/unregister a global keyboard shortcut
|
|
* with the operating system so that you can customize the operations for various shortcuts.
|
|
* Note: The shortcut is global; it will work even if the app does not have the keyboard focus.
|
|
* You should not use this module until the ready event of the app module is emitted.
|
|
*/
|
|
interface GlobalShortcut {
|
|
/**
|
|
* Registers a global shortcut of accelerator.
|
|
* @param accelerator Represents a keyboard shortcut. It can contain modifiers
|
|
* and key codes, combined by the "+" character.
|
|
* @param callback Called when the registered shortcut is pressed by the user.
|
|
*/
|
|
register(accelerator: string, callback: Function): void;
|
|
/**
|
|
* @param accelerator Represents a keyboard shortcut. It can contain modifiers
|
|
* and key codes, combined by the "+" character.
|
|
* @returns Whether the accelerator is registered.
|
|
*/
|
|
isRegistered(accelerator: string): boolean;
|
|
/**
|
|
* Unregisters the global shortcut of keycode.
|
|
* @param accelerator Represents a keyboard shortcut. It can contain modifiers
|
|
* and key codes, combined by the "+" character.
|
|
*/
|
|
unregister(accelerator: string): void;
|
|
/**
|
|
* Unregisters all the global shortcuts.
|
|
*/
|
|
unregisterAll(): void;
|
|
}
|
|
}
|