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

Merge branch 'master' of https://github.com/MaxWhere/electron into MaxWhere-master

Browse source
This commit is contained in:
Cheng Zhao 2015-09-18 12:01:33 +08:00
commit ee0d48dc5a
11 changed files with 602 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -244,7 +244,16 @@ Emitted when DevTools is closed.
Emitted when DevTools is focused / opened.
### Event: 'app-command' _Windows_
### Event: 'frame-rendered'
* `event` Event
* `frame` Buffer
* `size` Number
Emitted when *offscreen render* is enabled, the current frame's pixel data
and size are available.
### Event: 'app-command':
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
@ -772,3 +781,68 @@ Sets whether the window should be visible on all workspaces.
Returns whether the window is visible on all workspaces.
**Note:** This API always returns false on Windows.
### BrowserWindow.beginFrameSubscription()
Enables offscreen rendering, after this call `frame-rendered` events will be
fired when the window receives a new frame from the renderer.
### BrowserWindow.endFrameSubscription()
Enables offscreen rendering, after this call `frame-rendered` events will
no longer be fired if offscreen rendering was enabled before.
### BrowserWindow.sendMouseEvent(options)
Sends a mouse event to the BrowserWindow.
* `options` Object
* `type` String - The type of the mouse event.
* `down` String - Mouse down event.
* `up` String - Mouse up event.
* `move` String - Mouse move event.
* `enter` String - Mouse enter event.
* `leave` String - Mouse leave event.
* `context-menu` String - Context menu event.
* `wheel` String - Mouse wheel event.
* `x` Integer - The x component of the location of the mouse event.
* `y` Integer - The y component of the location of the mouse event.
* `movement-x` Integer - The x component of the mouse movement since the last event.
* `movement-y` Integer - The y component of the mouse movement since the last event.
* `button` String - The mouse button associated with the mouse event. Also sets the associated modifier values on the event.
* `left` String - The left button was pressed.
* `right` String - The right button was pressed.
* `middle` String - The middle button was pressed.
* `click-count` Integer - The number of clicks associated with the mouse event.
* `precise` Boolean - For the `wheel` event type, this option sets the `hasPreciseScrollingDeltas` option of the event.
* `modifiers` Object - The modifier values associated with the event.
* `left-button-down` Boolean - The left mouse button was pressed.
* `middle-button-down` Boolean - The right mouse button was pressed.
* `right-button-down` Boolean - The middle mouse button was pressed.
* `shift` Boolean - The shift key was pressed.
* `control` Boolean - The control key was pressed.
* `alt` Boolean - The alt key was pressed.
* `meta` Boolean - The meta key was pressed.
* `caps-lock` Boolean - The caps-lock key was on.
* `num-lock` Boolean - The num-lock key was on.
### BrowserWindow.sendKeyboardEvent(options)
Sends a keyboard event to the BrowserWindow.
* `options` Object
* `type` String - The type of the keyboard event.
* `down` String - Key down event.
* `up` String - Key up event.
* `char` String - Character event.
* `code` Integer - The key code of the key that generated the event.
* `native` Integer - The native key code of the key that generated the event.
* `modifiers` Object - The modifier values associated with the event.
* `keypad` Boolean - Sets the `IsKeyPad` option of the event.
* `auto-repeat` Boolean - Sets the `IsAutoRepeat` option of the event.
* `left` Boolean - Sets the `IsLeft` option of the event.
* `right` Boolean - Sets the `IsRight` option of the event.
* `shift` Boolean - The shift key was pressed.
* `control` Boolean - The control key was pressed.
* `alt` Boolean - The alt key was pressed.
* `meta` Boolean - The meta key was pressed.
* `caps-lock` Boolean - The caps-lock key was on.
* `num-lock` Boolean - The num-lock key was on.