mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Standardize global-shortcut

Browse source
This commit is contained in:
Jessica Lord 2015-08-26 17:32:47 -07:00
parent f96c76584f
commit a34a16653e
1 changed files with 15 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/api/global-shortcut.md
View file

@ -1,9 +1,12 @@
# global-shortcut # global-shortcut
The `global-shortcut` module can register/unregister a global keyboard shortcut The `global-shortcut` module can register/unregister a global keyboard shortcut
with the operating system, so that you can customize the operations for various shortcuts. with the operating system so that you can customize the operations for various
Note that the shortcut is global; it will work even if the app does not have the keyboard focus. shortcuts.
You should not use this module until the `ready` event of the app module is emitted.
Note that 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.
```javascript ```javascript
var app = require('app'); var app = require('app');
@ -32,7 +35,11 @@ app.on('will-quit', function() {
}); });
``` ```
## globalShortcut.register(accelerator, callback) ## Methods
The `global-shortcut` module has the following methods:
### `globalShortcut.register(accelerator, callback)`
* `accelerator` [Accelerator](accelerator.md) * `accelerator` [Accelerator](accelerator.md)
* `callback` Function * `callback` Function
@ -40,18 +47,18 @@ app.on('will-quit', function() {
Registers a global shortcut of `accelerator`. The `callback` is called when Registers a global shortcut of `accelerator`. The `callback` is called when
the registered shortcut is pressed by the user. the registered shortcut is pressed by the user.
## globalShortcut.isRegistered(accelerator) ### `globalShortcut.isRegistered(accelerator)`
* `accelerator` [Accelerator](accelerator.md) * `accelerator` [Accelerator](accelerator.md)
Returns `true` or `false` depending on whether the shortcut `accelerator` is registered. Returns `true` or `false` depending on whether the shortcut `accelerator` is registered.
## globalShortcut.unregister(accelerator) ### `globalShortcut.unregister(accelerator)`
* `accelerator` [Accelerator](accelerator.md) * `accelerator` [Accelerator](accelerator.md)
Unregisters the global shortcut of `keycode`. Unregisters the global shortcut of `accelerator`.
## globalShortcut.unregisterAll() ### `globalShortcut.unregisterAll()`
Unregisters all the global shortcuts. Unregisters all the global shortcuts.