globalShortcut to zh-CN

This commit is contained in:
Weiqiang Lin 2017-02-09 17:08:58 +08:00
parent 4a78490a6a
commit 8f542b1d69

View file

@ -1,18 +1,21 @@
# global-shortcut # globalShortcut
`global-shortcut` 模块可以便捷的为您设置(注册/注销)各种自定义操作的快捷键. > 当应用程序没有键盘焦点时检测键盘事件。
**Note**: 使用此模块注册的快捷键是系统全局的(QQ截图那种), 不要在应用模块(app module)响应 `ready` 进程: [Main](../glossary.md#main-process)
消息前使用此模块(注册快捷键).
`globalShortcut` 模块可以便捷的为你设置(注册/注销)各种自定义操作的快捷键。
**注意:** 使用此模块注册的快捷键是系统全局的(QQ截图那种), 不要在应用模块app module响应 `ready`
消息前使用此模块(注册快捷键)。
```javascript ```javascript
var app = require('app') const {app, globalShortcut} = require('electron')
var globalShortcut = require('global-shortcut')
app.on('ready', function () { app.on('ready', () => {
// Register a 'ctrl+x' shortcut listener. // Register a 'CommandOrControl+X' shortcut listener.
var ret = globalShortcut.register('ctrl+x', function () { const ret = globalShortcut.register('CommandOrControl+X', () => {
console.log('ctrl+x is pressed') console.log('CommandOrControl+X is pressed')
}) })
if (!ret) { if (!ret) {
@ -20,12 +23,12 @@ app.on('ready', function () {
} }
// Check whether a shortcut is registered. // Check whether a shortcut is registered.
console.log(globalShortcut.isRegistered('ctrl+x')) console.log(globalShortcut.isRegistered('CommandOrControl+X'))
}) })
app.on('will-quit', function () { app.on('will-quit', () => {
// Unregister a shortcut. // Unregister a shortcut.
globalShortcut.unregister('ctrl+x') globalShortcut.unregister('CommandOrControl+X')
// Unregister all shortcuts. // Unregister all shortcuts.
globalShortcut.unregisterAll() globalShortcut.unregisterAll()
@ -34,27 +37,35 @@ app.on('will-quit', function () {
## Methods ## Methods
`global-shortcut` 模块包含以下函数: `globalShortcut` 模块包含以下函数:
### `globalShortcut.register(accelerator, callback)` ### `globalShortcut.register(accelerator, callback)`
* `accelerator` [Accelerator](accelerator.md) * `accelerator` [Accelerator](accelerator.md)
* `callback` Function * `callback` Function
注册 `accelerator` 快捷键. 当用户按下注册的快捷键时将会调用 `callback` 函数. 注册 `accelerator` 快捷键。当用户按下注册的快捷键时将会调用 `callback` 函数。
当 accelerator 已经被其他应用程序占用时,此调用将
默默地失败。这种行为是操作系统的意图,因为它们没有
想要应用程序争取全局快捷键。
### `globalShortcut.isRegistered(accelerator)` ### `globalShortcut.isRegistered(accelerator)`
* `accelerator` [Accelerator](accelerator.md) * `accelerator` [Accelerator](accelerator.md)
查询 `accelerator` 快捷键是否已经被注册过了,将会返回 `true`(已被注册) 或 `false`(未注册). 返回 `Boolean` - 查询 `accelerator` 快捷键是否已经被注册过了,将会返回 `true``false`
当 accelerator 已经被其他应用程序占用时,此调用将
默默地失败。这种行为是操作系统的意图,因为它们没有
想要应用程序争取全局快捷键。
### `globalShortcut.unregister(accelerator)` ### `globalShortcut.unregister(accelerator)`
* `accelerator` [Accelerator](accelerator.md) * `accelerator` [Accelerator](accelerator.md)
注销全局快捷键 `accelerator`. 注销全局快捷键 `accelerator`
### `globalShortcut.unregisterAll()` ### `globalShortcut.unregisterAll()`
注销本应用注册的所有全局快捷键. 注销本应用程序注册的所有全局快捷键。