electron/docs-translations/jp/api/global-shortcut.md

65 lines
2.6 KiB
Markdown
Raw Normal View History

2016-01-19 08:23:17 +00:00
# globalShortcut
さまざまなショートカットの動作をカスタマイズするために、オペレーティングシステムのグローバルのキーボードショートカットを`globalShortcut`モジュールは登録したり、解除したりできます。
**Note:** ショートカットはグローバルです。アプリがキーボードフォーカスを持っていなくても動作します。`app`モジュールの `ready`イベントが出力されるまでは使うべきではありません。
```javascript
const electron = require('electron')
const app = electron.app
const globalShortcut = electron.globalShortcut
2016-01-19 08:23:17 +00:00
app.on('ready', function () {
2016-01-19 08:23:17 +00:00
// Register a 'ctrl+x' shortcut listener.
var ret = globalShortcut.register('ctrl+x', function () {
console.log('ctrl+x is pressed')
})
2016-01-19 08:23:17 +00:00
if (!ret) {
console.log('registration failed')
2016-01-19 08:23:17 +00:00
}
// Check whether a shortcut is registered.
console.log(globalShortcut.isRegistered('ctrl+x'))
})
2016-01-19 08:23:17 +00:00
app.on('will-quit', function () {
2016-01-19 08:23:17 +00:00
// Unregister a shortcut.
globalShortcut.unregister('ctrl+x')
2016-01-19 08:23:17 +00:00
// Unregister all shortcuts.
globalShortcut.unregisterAll()
})
2016-01-19 08:23:17 +00:00
```
## メソッド
`globalShortcut`モジュールは次のメソッドを持ちます:
### `globalShortcut.register(accelerator, callback)`
* `accelerator` [Accelerator](accelerator.md)
* `callback` Function
`accelerator`のグローバルショートカットを登録します。`callback`は、ユーザーが登録しているショートカットを押したときにコールされます。
ほかのアプリケーションがすでにacceleratorを使用している時、この呼び出しは静かに失敗します。アプリケーション間でグローバルショートカットの争いをしてほしくないので、オペレーティングシステムはこの挙動を採用しています。
### `globalShortcut.isRegistered(accelerator)`
* `accelerator` [Accelerator](accelerator.md)
このアプリケーションが`accelerator`に登録されているかどうかを返します。
acceleratorがすでにほかのアプリケーションで取得していると、このコールは、`false`を返します。アプリケーション間でグローバルショートカットの争いをしてほしくないので、オペレーティングシステムはこの挙動を採用しています。
### `globalShortcut.unregister(accelerator)`
* `accelerator` [Accelerator](accelerator.md)
Unregisters the global shortcut of `accelerator`のグローバルショートカットを解除します。
### `globalShortcut.unregisterAll()`
全てのグローバルショートカットを解除します。