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

Update docs for globalShortcut.register

Browse source 
Document return value for globalShortcut.register and common failure scenario.

Fix: #3600
This commit is contained in:
Stephen Niedzielski 2015-11-26 22:35:22 -07:00
parent 42454b07d0
commit 0b245b96e4
1 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -46,7 +46,10 @@ The `global-shortcut` module has the following methods:
* `callback` Function * `callback` 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. Returns `true` if the shortcut
`accelerator` was registered, `false` otherwise. For example, the specified
`accelerator` has already been registered by another caller or other native
applications.
### `globalShortcut.isRegistered(accelerator)` ### `globalShortcut.isRegistered(accelerator)`