📝 Adjust line length to 80
[ci skip]
This commit is contained in:
parent
e1bf0ea2b4
commit
9cbcd228f3
3 changed files with 25 additions and 15 deletions
|
@ -34,10 +34,12 @@ Emitted when Electron has finished initialization.
|
||||||
|
|
||||||
Emitted when all windows have been closed.
|
Emitted when all windows have been closed.
|
||||||
|
|
||||||
If you do not subscribe to this event and all windows are closed, the default behavior is to quit the app; however, if you subscribe, you control whether the app quits or not. If the
|
If you do not subscribe to this event and all windows are closed, the default
|
||||||
user pressed `Cmd + Q`, or the developer called `app.quit()`, Electron will
|
behavior is to quit the app; however, if you subscribe, you control whether the
|
||||||
first try to close all the windows and then emit the `will-quit` event, and in
|
app quits or not. If the user pressed `Cmd + Q`, or the developer called
|
||||||
this case the `window-all-closed` event would not be emitted.
|
`app.quit()`, Electron will first try to close all the windows and then emit the
|
||||||
|
`will-quit` event, and in this case the `window-all-closed` event would not be
|
||||||
|
emitted.
|
||||||
|
|
||||||
### Event: 'before-quit'
|
### Event: 'before-quit'
|
||||||
|
|
||||||
|
@ -87,7 +89,8 @@ handle this case (even before the `ready` event is emitted).
|
||||||
|
|
||||||
You should call `event.preventDefault()` if you want to handle this event.
|
You should call `event.preventDefault()` if you want to handle this event.
|
||||||
|
|
||||||
On Windows, you have to parse `process.argv` (in the main process) to get the filepath.
|
On Windows, you have to parse `process.argv` (in the main process) to get the
|
||||||
|
filepath.
|
||||||
|
|
||||||
### Event: 'open-url' _OS X_
|
### Event: 'open-url' _OS X_
|
||||||
|
|
||||||
|
@ -108,8 +111,8 @@ Returns:
|
||||||
* `event` Event
|
* `event` Event
|
||||||
* `hasVisibleWindows` Boolean
|
* `hasVisibleWindows` Boolean
|
||||||
|
|
||||||
Emitted when the application is activated, which usually happens when the user clicks on
|
Emitted when the application is activated, which usually happens when the user
|
||||||
the application's dock icon.
|
clicks on the application's dock icon.
|
||||||
|
|
||||||
### Event: 'continue-activity' _OS X_
|
### Event: 'continue-activity' _OS X_
|
||||||
|
|
||||||
|
@ -251,7 +254,8 @@ Emitted when the gpu process crashes.
|
||||||
|
|
||||||
The `app` object has the following methods:
|
The `app` object has the following methods:
|
||||||
|
|
||||||
**Note:** Some methods are only available on specific operating systems and are labeled as such.
|
**Note:** Some methods are only available on specific operating systems and are
|
||||||
|
labeled as such.
|
||||||
|
|
||||||
### `app.quit()`
|
### `app.quit()`
|
||||||
|
|
||||||
|
@ -283,7 +287,8 @@ Hides all application windows without minimizing them.
|
||||||
|
|
||||||
### `app.show()` _OS X_
|
### `app.show()` _OS X_
|
||||||
|
|
||||||
Shows application windows after they were hidden. Does not automatically focus them.
|
Shows application windows after they were hidden. Does not automatically focus
|
||||||
|
them.
|
||||||
|
|
||||||
### `app.getAppPath()`
|
### `app.getAppPath()`
|
||||||
|
|
||||||
|
@ -397,8 +402,8 @@ The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme internally
|
||||||
|
|
||||||
* `protocol` String - The name of your protocol, without `://`.
|
* `protocol` String - The name of your protocol, without `://`.
|
||||||
|
|
||||||
This method checks if the current executable as the default handler for a protocol
|
This method checks if the current executable as the default handler for a
|
||||||
(aka URI scheme). If so, it will remove the app as the default handler.
|
protocol (aka URI scheme). If so, it will remove the app as the default handler.
|
||||||
|
|
||||||
### `app.isDefaultProtocolClient(protocol)` _OS X_ _Windows_
|
### `app.isDefaultProtocolClient(protocol)` _OS X_ _Windows_
|
||||||
|
|
||||||
|
@ -407,8 +412,11 @@ This method checks if the current executable as the default handler for a protoc
|
||||||
This method checks if the current executable is the default handler for a protocol
|
This method checks if the current executable is the default handler for a protocol
|
||||||
(aka URI scheme). If so, it will return true. Otherwise, it will return false.
|
(aka URI scheme). If so, it will return true. Otherwise, it will return false.
|
||||||
|
|
||||||
**Note:** On OS X, you can use this method to check if the app has been registered as the default protocol handler for a protocol. You can also verify this by checking `~/Library/Preferences/com.apple.LaunchServices.plist` on the OS X machine.
|
**Note:** On OS X, you can use this method to check if the app has been
|
||||||
Please refer to [Apple's documentation][LSCopyDefaultHandlerForURLScheme] for details.
|
registered as the default protocol handler for a protocol. You can also verify
|
||||||
|
this by checking `~/Library/Preferences/com.apple.LaunchServices.plist` on the
|
||||||
|
OS X machine. Please refer to
|
||||||
|
[Apple's documentation][LSCopyDefaultHandlerForURLScheme] for details.
|
||||||
|
|
||||||
The API uses the Windows Registry and LSCopyDefaultHandlerForURLScheme internally.
|
The API uses the Windows Registry and LSCopyDefaultHandlerForURLScheme internally.
|
||||||
|
|
||||||
|
|
|
@ -2,7 +2,8 @@
|
||||||
|
|
||||||
> Enable apps to automatically update themselves.
|
> Enable apps to automatically update themselves.
|
||||||
|
|
||||||
The `autoUpdater` module provides an interface for the [Squirrel](https://github.com/Squirrel) framework.
|
The `autoUpdater` module provides an interface for the
|
||||||
|
[Squirrel](https://github.com/Squirrel) framework.
|
||||||
|
|
||||||
You can quickly launch a multi-platform release server for distributing your
|
You can quickly launch a multi-platform release server for distributing your
|
||||||
application by using one of these projects:
|
application by using one of these projects:
|
||||||
|
|
|
@ -92,7 +92,8 @@ will be passed via `callback(filename)`
|
||||||
* `type` String - Can be `"none"`, `"info"`, `"error"`, `"question"` or
|
* `type` String - Can be `"none"`, `"info"`, `"error"`, `"question"` or
|
||||||
`"warning"`. On Windows, "question" displays the same icon as "info", unless
|
`"warning"`. On Windows, "question" displays the same icon as "info", unless
|
||||||
you set an icon using the "icon" option.
|
you set an icon using the "icon" option.
|
||||||
* `buttons` Array - Array of texts for buttons. On Windows, an empty array will result in one button labeled "OK".
|
* `buttons` Array - Array of texts for buttons. On Windows, an empty array
|
||||||
|
will result in one button labeled "OK".
|
||||||
* `defaultId` Integer - Index of the button in the buttons array which will
|
* `defaultId` Integer - Index of the button in the buttons array which will
|
||||||
be selected by default when the message box opens.
|
be selected by default when the message box opens.
|
||||||
* `title` String - Title of the message box, some platforms will not show it.
|
* `title` String - Title of the message box, some platforms will not show it.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue