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

docs: Pass bounds in clicked event of tray

Browse source
This commit is contained in:
Cheng Zhao 2015-05-04 11:23:09 +08:00
parent 294dbac869
commit f64dbbea3e
1 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/api/tray.md
View file

@ -47,12 +47,16 @@ Creates a new tray icon associated with the `image`.
### Event: 'clicked' ### Event: 'clicked'
* `event` * `event`
* `point` Object * `bounds` Object - the bounds of tray icon
* `x` Integer * `x` Integer
* `y` Integer * `y` Integer
* `width` Integer
* `height` Integer
Emitted when the tray icon is clicked. Emitted when the tray icon is clicked.
__NOte:__ The `bounds` payload is only implemented on OS X.
### Event: 'double-clicked' ### Event: 'double-clicked'
Emitted when the tray icon is double clicked. Emitted when the tray icon is double clicked.
@ -106,7 +110,7 @@ Sets the hover text for this tray icon.
Sets the title displayed aside of the tray icon in the status bar. Sets the title displayed aside of the tray icon in the status bar.
This is only implemented on OS X. __Note:__ This is only implemented on OS X.
### Tray.setHighlightMode(highlight) ### Tray.setHighlightMode(highlight)
@ -114,7 +118,7 @@ This is only implemented on OS X.
Sets whether the tray icon is highlighted when it is clicked. Sets whether the tray icon is highlighted when it is clicked.
This is only implmented on OS X. __Note:__ This is only implemented on OS X.
### Tray.displayBalloon(options) ### Tray.displayBalloon(options)
@ -123,10 +127,14 @@ This is only implmented on OS X.
* `title` String * `title` String
* `content` String * `content` String
Displays a tray balloon.
__Note:__ This is only implemented on Windows.
### Tray.setContextMenu(menu) ### Tray.setContextMenu(menu)
* `menu` Menu * `menu` Menu
Set the context menu for this icon. Sets the context menu for this icon.
[event-emitter]: http://nodejs.org/api/events.html#events_class_events_eventemitter [event-emitter]: http://nodejs.org/api/events.html#events_class_events_eventemitter