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

Merge pull request #4964 from jwheare/app-command-docs

Browse source 
Improve app-command docs, list arguments and explain command string
This commit is contained in:
Kevin Sawicki 2016-03-31 15:45:16 -07:00
commit 1eddaecef8
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/api/browser-window.md
View file

@ -301,10 +301,18 @@ Emitted when the window leaves full screen state triggered by html api.
### Event: 'app-command' _Windows_ ### Event: 'app-command' _Windows_
Returns:
* `event` Event
* `command` String
Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx) Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx)
is invoked. These are typically related to keyboard media keys or browser is invoked. These are typically related to keyboard media keys or browser
commands, as well as the "Back" button built into some mice on Windows. commands, as well as the "Back" button built into some mice on Windows.
Commands are lowercased with underscores replaced with hyphens and the `APPCOMMAND_` prefix stripped off.
e.g. `APPCOMMAND_BROWSER_BACKWARD` is emitted as `browser-backward`.
```js ```js
someWindow.on('app-command', function(e, cmd) { someWindow.on('app-command', function(e, cmd) {
// Navigate the window back when the user hits their mouse back button // Navigate the window back when the user hits their mouse back button