зеркало из https://github.com/electron/electron.git
Update docs to follow the 'link first instance' standard
This commit is contained in:
Родитель
03979936f3
Коммит
b859afc118
|
@ -219,14 +219,7 @@ Returns:
|
|||
* `event` Event
|
||||
* `webContents` [WebContents](web-contents.md)
|
||||
* `url` URL
|
||||
* `certificateList` [Objects]
|
||||
* `data` String - PEM encoded data
|
||||
* `issuerName` String - Issuer's Common Name
|
||||
* `subjectName` String - Subject's Common Name
|
||||
* `serialNumber` String - Hex value represented string
|
||||
* `validStart` Integer - Start date of the certificate being valid in seconds
|
||||
* `validExpiry` Integer - End date of the certificate being valid in seconds
|
||||
* `fingerprint` String - Fingerprint of the certificate
|
||||
* `certificateList` [Certificate[]](structures/certificate.md)
|
||||
* `callback` Function
|
||||
|
||||
Emitted when a client certificate is requested.
|
||||
|
@ -523,7 +516,7 @@ The API uses the Windows Registry and LSCopyDefaultHandlerForURLScheme internall
|
|||
|
||||
### `app.setUserTasks(tasks)` _Windows_
|
||||
|
||||
* `tasks` Array - Array of `Task` objects
|
||||
* `tasks` [Task[]](structures/task.md) - Array of `Task` objects
|
||||
|
||||
Adds `tasks` to the [Tasks][tasks] category of the JumpList on Windows.
|
||||
|
||||
|
@ -555,7 +548,7 @@ Returns `Object`:
|
|||
* `minItems` Integer - The minimum number of items that will be shown in the
|
||||
Jump List (for a more detailed description of this value see the
|
||||
[MSDN docs][JumpListBeginListMSDN]).
|
||||
* `removedItems` Array - Array of `JumpListItem` objects that correspond to
|
||||
* `removedItems` [JumpListItem[]](structures/jump-list-item.md) - Array of `JumpListItem` objects that correspond to
|
||||
items that the user has explicitly removed from custom categories in the
|
||||
Jump List. These items must not be re-added to the Jump List in the **next**
|
||||
call to `app.setJumpList()`, Windows will not display any custom category
|
||||
|
@ -563,7 +556,7 @@ Returns `Object`:
|
|||
|
||||
### `app.setJumpList(categories)` _Windows_
|
||||
|
||||
* `categories` Array or `null` - Array of `JumpListCategory` objects.
|
||||
* `categories` [JumpListCategory[]](structures/jump-list-category.md) or `null` - Array of `JumpListCategory` objects.
|
||||
|
||||
Sets or removes a custom Jump List for the application, and returns one of the
|
||||
following strings:
|
||||
|
|
|
@ -666,45 +666,26 @@ height areas you have within the overall content view.
|
|||
|
||||
#### `win.setBounds(options[, animate])`
|
||||
|
||||
* `options` Object
|
||||
* `x` Integer
|
||||
* `y` Integer
|
||||
* `width` Integer
|
||||
* `height` Integer
|
||||
* `options` [Bounds](structures/bounds.md)
|
||||
* `animate` Boolean (optional) _macOS_
|
||||
|
||||
Resizes and moves the window to `width`, `height`, `x`, `y`.
|
||||
Resizes and moves the window to the supplied bounds
|
||||
|
||||
#### `win.getBounds()`
|
||||
|
||||
Returns `Object`:
|
||||
* `width` Integer
|
||||
* `height` Integer
|
||||
* `x` Integer
|
||||
* `y` Integer
|
||||
Returns [`Bounds`](structures/bounds.md)
|
||||
|
||||
#### `win.setContentBounds(options[, animate])`
|
||||
|
||||
* `options` Object
|
||||
* `x` Integer
|
||||
* `y` Integer
|
||||
* `width` Integer
|
||||
* `height` Integer
|
||||
* `options` [Bounds](structures/bounds.md)
|
||||
* `animate` Boolean (optional) _macOS_
|
||||
|
||||
Resizes and moves the window's client area (e.g. the web page) to
|
||||
`width`, `height`, `x`, `y`.
|
||||
the supplied bounds.
|
||||
|
||||
#### `win.getContentBounds()`
|
||||
|
||||
Returns `Object`:
|
||||
* `width` Integer
|
||||
* `height` Integer
|
||||
* `x` Integer
|
||||
* `y` Integer
|
||||
|
||||
Returns an object that contains the window's client area (e.g. the web page)
|
||||
width, height, x and y values.
|
||||
Returns [`Bounds`](structures/bounds.md)
|
||||
|
||||
#### `win.setSize(width, height[, animate])`
|
||||
|
||||
|
@ -967,11 +948,7 @@ Whether `Boolean` - Whether the window's document has been edited.
|
|||
|
||||
#### `win.capturePage([rect, ]callback)`
|
||||
|
||||
* `rect` Object (optional) - The area of the page to be captured
|
||||
* `x` Integer
|
||||
* `y` Integer
|
||||
* `width` Integer
|
||||
* `height` Integer
|
||||
* `rect` [Bounds](structures/bounds.md) (optional) - The bounds to capture
|
||||
* `callback` Function
|
||||
|
||||
Same as `webContents.capturePage([rect, ]callback)`.
|
||||
|
@ -1060,7 +1037,9 @@ On Windows and Linux always returns
|
|||
|
||||
#### `win.setThumbarButtons(buttons)` _Windows_
|
||||
|
||||
* `buttons` Array
|
||||
* `buttons` [ThumbarButton[]](structures/thumbar-button.md)
|
||||
|
||||
Returns `Boolean` - Whether the buttons were added successfully
|
||||
|
||||
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
|
||||
|
@ -1096,11 +1075,7 @@ The `flags` is an array that can include following `String`s:
|
|||
|
||||
#### `win.setThumbnailClip(region)` _Windows_
|
||||
|
||||
* `region` Object - Region of the window
|
||||
* `x` Integer - x-position of region
|
||||
* `y` Integer - y-position of region
|
||||
* `width` Integer - width of region
|
||||
* `height` Integer - height of region
|
||||
* `region` [Bounds](structures/bounds.md) - Region of the window
|
||||
|
||||
Sets the region of the window to show as the thumbnail image displayed when
|
||||
hovering over the window in the taskbar. You can reset the thumbnail to be
|
||||
|
|
|
@ -74,7 +74,7 @@ Creates or updates a shortcut link at `shortcutPath`.
|
|||
|
||||
* `shortcutPath` String
|
||||
|
||||
Returns `ShortcutDetails`
|
||||
Returns [`ShortcutDetails`](structures/shortcut-details.md)
|
||||
|
||||
Resolves the shortcut link at `shortcutPath`.
|
||||
|
||||
|
|
|
@ -70,7 +70,7 @@ The `Tray` module emits the following events:
|
|||
* `shiftKey` Boolean
|
||||
* `ctrlKey` Boolean
|
||||
* `metaKey` Boolean
|
||||
* `bounds` Bounds - The [Bounds](structures/bounds.md) of tray icon
|
||||
* `bounds` [Bounds](structures/bounds.md) - The bounds of tray icon
|
||||
|
||||
Emitted when the tray icon is clicked.
|
||||
|
||||
|
@ -81,7 +81,7 @@ Emitted when the tray icon is clicked.
|
|||
* `shiftKey` Boolean
|
||||
* `ctrlKey` Boolean
|
||||
* `metaKey` Boolean
|
||||
* `bounds` Bounds - The [Bounds](structures/bounds.md) of tray icon
|
||||
* `bounds` [Bounds](structures/bounds.md) - The bounds of tray icon
|
||||
|
||||
Emitted when the tray icon is right clicked.
|
||||
|
||||
|
@ -92,7 +92,7 @@ Emitted when the tray icon is right clicked.
|
|||
* `shiftKey` Boolean
|
||||
* `ctrlKey` Boolean
|
||||
* `metaKey` Boolean
|
||||
* `bounds` Bounds - The [Bounds](structures/bounds.md) of tray icon
|
||||
* `bounds` [Bounds](structures/bounds.md) - The bounds of tray icon
|
||||
|
||||
Emitted when the tray icon is double clicked.
|
||||
|
||||
|
@ -231,7 +231,7 @@ Sets the context menu for this icon.
|
|||
|
||||
#### `tray.getBounds()` _macOS_ _Windows_
|
||||
|
||||
Returns `Bounds` - A [Bounds](structures/bounds.md) object
|
||||
Returns [`Bounds`](structures/bounds.md)
|
||||
|
||||
The `bounds` of this tray icon as `Object`.
|
||||
|
||||
|
|
Загрузка…
Ссылка в новой задаче