Add platform labels

This commit is contained in:
Jessica Lord 2015-08-26 14:05:47 -07:00
parent 5f1897713c
commit 4e781eb042

View file

@ -200,12 +200,10 @@ Emitted when the window is getting moved to a new position.
__Note__: On OS X this event is just an alias of `moved`. __Note__: On OS X this event is just an alias of `moved`.
### Event: 'moved' ### Event: 'moved' _OS X_
Emitted once when the window is moved to a new position. Emitted once when the window is moved to a new position.
__Note__: This event is available only on OS X.
### Event: 'enter-full-screen' ### Event: 'enter-full-screen'
Emitted when the window enters full screen state. Emitted when the window enters full screen state.
@ -234,7 +232,7 @@ Emitted when devtools is closed.
Emitted when devtools is focused / opened. Emitted when devtools is focused / opened.
### Event: 'app-command': ### Event: 'app-command' _Windows_
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
@ -249,8 +247,6 @@ someWindow.on('app-command', function(e, cmd) {
}); });
``` ```
__Note__: This event is only fired on Windows.
## Methods ## Methods
The `BrowserWindow` object has the following methods: The `BrowserWindow` object has the following methods:
@ -421,8 +417,6 @@ the player itself we would call this function with arguments of 16/9 and
are within the content view--only that they exist. Just sum any extra width and are within the content view--only that they exist. Just sum any extra width and
height areas you have within the overall content view. height areas you have within the overall content view.
__Note__: This API is only implemented on OS X.
### `win.setBounds(options)` ### `win.setBounds(options)`
`options` Object, properties: `options` Object, properties:
@ -554,36 +548,28 @@ Enters or leaves the kiosk mode.
Returns whether the window is in kiosk mode. Returns whether the window is in kiosk mode.
### `win.setRepresentedFilename(filename)` ### `win.setRepresentedFilename(filename)` _OS X_
* `filename` String * `filename` String
Sets the pathname of the file the window represents, and the icon of the file Sets the pathname of the file the window represents, and the icon of the file
will show in window's title bar. will show in window's title bar.
__Note__: This API is only available on OS X. ### `win.getRepresentedFilename()` _OS X_
### `win.getRepresentedFilename()`
Returns the pathname of the file the window represents. Returns the pathname of the file the window represents.
__Note__: This API is only available on OS X. ### `win.setDocumentEdited(edited)` _OS X_
### `win.setDocumentEdited(edited)`
* `edited` Boolean * `edited` Boolean
Specifies whether the windows document has been edited, and the icon in title Specifies whether the windows document has been edited, and the icon in title
bar will become grey when set to `true`. bar will become grey when set to `true`.
__Note__: This API is only available on OS X. ### `win.IsDocumentEdited()` _OS X_
### `win.IsDocumentEdited()`
Whether the window's document has been edited. Whether the window's document has been edited.
__Note__: This API is only available on OS X.
### `win.openDevTools([options])` ### `win.openDevTools([options])`
* `options` Object (optional). Properties: * `options` Object (optional). Properties:
@ -656,8 +642,6 @@ Same as `webContents.reload`.
Sets the `menu` as the window's menu bar, setting it to `null` will remove the Sets the `menu` as the window's menu bar, setting it to `null` will remove the
menu bar. menu bar.
__Note:__ This API is not available on OS X.
### `win.setProgressBar(progress)` ### `win.setProgressBar(progress)`
* `progress` Double * `progress` Double
@ -671,7 +655,7 @@ On Linux platform, only supports Unity desktop environment, you need to specify
the `*.desktop` file name to `desktopName` field in `package.json`. By default, the `*.desktop` file name to `desktopName` field in `package.json`. By default,
it will assume `app.getName().desktop`. it will assume `app.getName().desktop`.
### `win.setOverlayIcon(overlay, description)` _Windows_ ### `win.setOverlayIcon(overlay, description)` _Windows 7+_
* `overlay` [NativeImage](native-image.md) - the icon to display on the bottom * `overlay` [NativeImage](native-image.md) - the icon to display on the bottom
right corner of the taskbar icon. If this parameter is `null`, the overlay is right corner of the taskbar icon. If this parameter is `null`, the overlay is
@ -682,10 +666,8 @@ screen readers
Sets a 16px overlay onto the current taskbar icon, usually used to convey some Sets a 16px overlay onto the current taskbar icon, usually used to convey some
sort of application status or to passively notify the user. sort of application status or to passively notify the user.
__Note:__ This API is only available on Windows (Windows 7 and above)
### `win.setThumbarButtons(buttons)` _Windows 7+_
### `win.setThumbarButtons(buttons)` _Windows_
`buttons` Array of `button` Objects: `buttons` Array of `button` Objects:
@ -713,7 +695,6 @@ Add a thumbnail toolbar with a specified set of buttons to the thumbnail image
of a window in a taskbar button layout. Returns a `Boolean` object indicates of a window in a taskbar button layout. Returns a `Boolean` object indicates
whether the thumbnail has been added successfully. whether the thumbnail has been added successfully.
__Note:__ This API is only available on Windows (Windows 7 and above).
The number of buttons in thumbnail toolbar should be no greater than 7 due to The number of buttons in thumbnail toolbar should be no greater than 7 due to
the limited room. Once you setup the thumbnail toolbar, the toolbar cannot be the limited room. Once you setup the thumbnail toolbar, the toolbar cannot be
removed due to the platform's limitation. But you can call the API with an empty removed due to the platform's limitation. But you can call the API with an empty
@ -723,8 +704,6 @@ array to clean the buttons.
Shows pop-up dictionary that searches the selected word on the page. Shows pop-up dictionary that searches the selected word on the page.
__Note__: This API is only available on OS X.
### `win.setAutoHideMenuBar(hide)` ### `win.setAutoHideMenuBar(hide)`
* `hide` Boolean * `hide` Boolean