diff --git a/docs/api/app-ko.md b/docs/api/app-ko.md deleted file mode 100644 index 434d0620282a..000000000000 --- a/docs/api/app-ko.md +++ /dev/null @@ -1,321 +0,0 @@ -# app - -The `app` module is responsible for controlling the application's life time. - -The example of quitting the whole application when the last window is closed: - -```javascript -var app = require('app'); -app.on('window-all-closed', function() { - app.quit(); -}); -``` - -## Event: will-finish-launching - -Emitted when application has done basic startup. On Windows and Linux it is the -same with `ready` event, on OS X this event represents the -`applicationWillFinishLaunching` message of `NSApplication`, usually you would -setup listeners to `open-file` and `open-url` events here, and start the crash -reporter and auto updater. - -Under most cases you should just do everything in `ready` event. - -## Event: ready - -Emitted when Electron has done everything initialization. - -## Event: window-all-closed - -Emitted when all windows have been closed. - -This event is only emitted when the application is not going to quit. If a -user pressed `Cmd + Q`, or the developer called `app.quit()`, Electron would -first try to close all windows and then emit the `will-quit` event, and in -this case the `window-all-closed` would not be emitted. - -## Event: before-quit - -* `event` Event - -Emitted before the application starts closing its windows. -Calling `event.preventDefault()` will prevent the default behaviour, which is -terminating the application. - -## Event: will-quit - -* `event` Event - -Emitted when all windows have been closed and the application will quit. -Calling `event.preventDefault()` will prevent the default behaviour, which is -terminating the application. - -See description of `window-all-closed` for the differences between `will-quit` -and it. - -## Event: quit - -Emitted when application is quitting. - -## Event: open-file - -* `event` Event -* `path` String - -Emitted when user wants to open a file with the application, it usually happens -when the application is already opened and then OS wants to reuse the -application to open file. But it is also emitted when a file is dropped onto the -dock and the application is not yet running. Make sure to listen to open-file -very early in your application startup to handle this case (even before the -`ready` event is emitted). - -You should call `event.preventDefault()` if you want to handle this event. - -## Event: open-url - -* `event` Event -* `url` String - -Emitted when user wants to open a URL with the application, this URL scheme -must be registered to be opened by your application. - -You should call `event.preventDefault()` if you want to handle this event. - -## Event: activate-with-no-open-windows - -Emitted when the application is activated while there is no opened windows. It -usually happens when user has closed all of application's windows and then -click on the application's dock icon. - -## Event: browser-window-blur - -* `event` Event -* `window` BrowserWindow - -Emitted when a [browserWindow](browser-window-ko.md) gets blurred. - -## Event: browser-window-focus - -* `event` Event -* `window` BrowserWindow - -Emitted when a [browserWindow](browser-window-ko.md) gets focused. - -### Event: 'select-certificate' - -Emitted when client certificate is requested. - -* `event` Event -* `webContents` [WebContents](browser-window-ko.md#class-webcontents) -* `url` String -* `certificateList` [Objects] - * `data` PEM encoded data - * `issuerName` Issuer's Common Name -* `callback` Function - -``` -app.on('select-certificate', function(event, host, url, list, callback) { - event.preventDefault(); - callback(list[0]); -}) -``` - -`url` corresponds to the navigation entry requesting the client certificate, -`callback` needs to be called with an entry filtered from the list. -`event.preventDefault()` prevents from using the first certificate from -the store. - -### Event: 'gpu-process-crashed' - -Emitted when the gpu process is crashed. - -## app.quit() - -Try to close all windows. The `before-quit` event will first be emitted. If all -windows are successfully closed, the `will-quit` event will be emitted and by -default the application would be terminated. - -This method guarantees all `beforeunload` and `unload` handlers are correctly -executed. It is possible that a window cancels the quitting by returning -`false` in `beforeunload` handler. - -## app.getAppPath() - -Returns the current application directory. - -## app.getPath(name) - -* `name` String - -Retrieves a path to a special directory or file associated with `name`. On -failure an `Error` would throw. - -You can request following paths by the names: - -* `home`: User's home directory -* `appData`: Per-user application data directory, by default it is pointed to: - * `%APPDATA%` on Windows - * `$XDG_CONFIG_HOME` or `~/.config` on Linux - * `~/Library/Application Support` on OS X -* `userData`: The directory for storing your app's configuration files, by - default it is the `appData` directory appended with your app's name -* `cache`: Per-user application cache directory, by default it is pointed to: - * `%APPDATA%` on Window, which doesn't has a universal place for cache - * `$XDG_CACHE_HOME` or `~/.cache` on Linux - * `~/Library/Caches` on OS X -* `userCache`: The directory for placing your app's caches, by default it is the - `cache` directory appended with your app's name -* `temp`: Temporary directory -* `userDesktop`: The current user's Desktop directory -* `exe`: The current executable file -* `module`: The `libchromiumcontent` library - -## app.setPath(name, path) - -* `name` String -* `path` String - -Overrides the `path` to a special directory or file associated with `name`. if -the path specifies a directory that does not exist, the directory will be -created by this method. On failure an `Error` would throw. - -You can only override paths of `name`s defined in `app.getPath`. - -By default web pages' cookies and caches will be stored under `userData` -directory, if you want to change this location, you have to override the -`userData` path before the `ready` event of `app` module gets emitted. - -## app.getVersion() - -Returns the version of loaded application, if no version is found in -application's `package.json`, the version of current bundle or executable would -be returned. - -## app.getName() - -Returns current application's name, the name in `package.json` would be -used. - -Usually the `name` field of `package.json` is a short lowercased name, according -to the spec of npm modules. So usually you should also specify a `productName` -field, which is your application's full capitalized name, and it will be -preferred over `name` by Electron. - -## app.resolveProxy(url, callback) - -* `url` URL -* `callback` Function - -Resolves the proxy information for `url`, the `callback` would be called with -`callback(proxy)` when the request is done. - -## app.addRecentDocument(path) - -* `path` String - -Adds `path` to recent documents list. - -This list is managed by the system, on Windows you can visit the list from task -bar, and on Mac you can visit it from dock menu. - -## app.clearRecentDocuments() - -Clears the recent documents list. - -## app.setUserTasks(tasks) - -* `tasks` Array - Array of `Task` objects - -Adds `tasks` to the [Tasks][tasks] category of JumpList on Windows. - -The `tasks` is an array of `Task` objects in following format: - -* `Task` Object - * `program` String - Path of the program to execute, usually you should - specify `process.execPath` which opens current program - * `arguments` String - The arguments of command line when `program` is - executed - * `title` String - The string to be displayed in a JumpList - * `description` String - Description of this task - * `iconPath` String - The absolute path to an icon to be displayed in a - JumpList, it can be arbitrary resource file that contains an icon, usually - you can specify `process.execPath` to show the icon of the program - * `iconIndex` Integer - The icon index in the icon file. If an icon file - consists of two or more icons, set this value to identify the icon. If an - icon file consists of one icon, this value is 0 - -**Note:** This API is only available on Windows. - -## app.commandLine.appendSwitch(switch, [value]) - -Append a switch [with optional value] to Chromium's command line. - -**Note:** This will not affect `process.argv`, and is mainly used by developers -to control some low-level Chromium behaviors. - -## app.commandLine.appendArgument(value) - -Append an argument to Chromium's command line. The argument will quoted properly. - -**Note:** This will not affect `process.argv`. - -## app.dock.bounce([type]) - -* `type` String - Can be `critical` or `informational`, the default is - `informational` - -When `critical` is passed, the dock icon will bounce until either the -application becomes active or the request is canceled. - -When `informational` is passed, the dock icon will bounce for one second. The -request, though, remains active until either the application becomes active or -the request is canceled. - -An ID representing the request would be returned. - -**Note:** This API is only available on Mac. - -## app.dock.cancelBounce(id) - -* `id` Integer - -Cancel the bounce of `id`. - -**Note:** This API is only available on Mac. - -## app.dock.setBadge(text) - -* `text` String - -Sets the string to be displayed in the dock’s badging area. - -**Note:** This API is only available on Mac. - -## app.dock.getBadge() - -Returns the badge string of the dock. - -**Note:** This API is only available on Mac. - -## app.dock.hide() - -Hides the dock icon. - -**Note:** This API is only available on Mac. - -## app.dock.show() - -Shows the dock icon. - -**Note:** This API is only available on Mac. - -## app.dock.setMenu(menu) - -* `menu` Menu - -Sets the application [dock menu][dock-menu]. - -**Note:** This API is only available on Mac. - -[dock-menu]:https://developer.apple.com/library/mac/documentation/Carbon/Conceptual/customizing_docktile/concepts/dockconcepts.html#//apple_ref/doc/uid/TP30000986-CH2-TPXREF103 -[tasks]:http://msdn.microsoft.com/en-us/library/windows/desktop/dd378460(v=vs.85).aspx#tasks diff --git a/docs/api/browser-window-ko.md b/docs/api/browser-window-ko.md deleted file mode 100644 index 29a07661409d..000000000000 --- a/docs/api/browser-window-ko.md +++ /dev/null @@ -1,1169 +0,0 @@ -# browser-window - -The `BrowserWindow` class gives you ability to create a browser window, an -example is: - -```javascript -var BrowserWindow = require('browser-window'); - -var win = new BrowserWindow({ width: 800, height: 600, show: false }); -win.on('closed', function() { - win = null; -}); - -win.loadUrl('https://github.com'); -win.show(); -``` - -You can also create a window without chrome by using -[Frameless Window](frameless-window.md) API. - -## Class: BrowserWindow - -`BrowserWindow` is an -[EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). - -### new BrowserWindow(options) - -* `options` Object - * `x` Integer - Window's left offset to screen - * `y` Integer - Window's top offset to screen - * `width` Integer - Window's width - * `height` Integer - Window's height - * `use-content-size` Boolean - The `width` and `height` would be used as web - page's size, which means the actual window's size will include window - frame's size and be slightly larger. - * `center` Boolean - Show window in the center of the screen - * `min-width` Integer - Minimum width - * `min-height` Integer - Minimum height - * `max-width` Integer - Maximum width - * `max-height` Integer - Maximum height - * `resizable` Boolean - Whether window is resizable - * `always-on-top` Boolean - Whether the window should always stay on top of - other windows - * `fullscreen` Boolean - Whether the window should show in fullscreen, when - set to `false` the fullscreen button would also be hidden on OS X - * `skip-taskbar` Boolean - Do not show window in taskbar - * `zoom-factor` Number - The default zoom factor of the page, zoom factor is - zoom percent / 100, so `3.0` represents `300%` - * `kiosk` Boolean - The kiosk mode - * `title` String - Default window title - * `icon` [NativeImage](native-image.md) - The window icon, when omitted on - Windows the executable's icon would be used as window icon - * `show` Boolean - Whether window should be shown when created - * `frame` Boolean - Specify `false` to create a - [Frameless Window](frameless-window.md) - * `node-integration` Boolean - Whether node integration is enabled, default - is `true` - * `accept-first-mouse` Boolean - Whether the web view accepts a single - mouse-down event that simultaneously activates the window - * `disable-auto-hide-cursor` Boolean - Do not hide cursor when typing - * `auto-hide-menu-bar` Boolean - Auto hide the menu bar unless the `Alt` - key is pressed. - * `enable-larger-than-screen` Boolean - Enable the window to be resized larger - than screen. - * `dark-theme` Boolean - Forces using dark theme for the window, only works on - some GTK+3 desktop environments - * `preload` String - Specifies a script that will be loaded before other - scripts run in the window. This script will always have access to node APIs - no matter whether node integration is turned on for the window, and the path - of `preload` script has to be absolute path. - * `transparent` Boolean - Makes the window [transparent](frameless-window.md) - * `type` String - Specifies the type of the window, possible types are - `desktop`, `dock`, `toolbar`, `splash`, `notification`. This only works on - Linux. - * `standard-window` Boolean - Uses the OS X's standard window instead of the - textured window. Defaults to `true`. - * `web-preferences` Object - Settings of web page's features - * `javascript` Boolean - * `web-security` Boolean - * `images` Boolean - * `java` Boolean - * `text-areas-are-resizable` Boolean - * `webgl` Boolean - * `webaudio` Boolean - * `plugins` Boolean - Whether plugins should be enabled, currently only - `NPAPI` plugins are supported. - * `extra-plugin-dirs` Array - Array of paths that would be searched for - plugins. Note that if you want to add a directory under your app, you - should use `__dirname` or `process.resourcesPath` to join the paths to - make them absolute, using relative paths would make Electron search - under current working directory. - * `experimental-features` Boolean - * `experimental-canvas-features` Boolean - * `subpixel-font-scaling` Boolean - * `overlay-scrollbars` Boolean - * `overlay-fullscreen-video` Boolean - * `shared-worker` Boolean - * `direct-write` Boolean - Whether the DirectWrite font rendering system on - Windows is enabled - * `page-visibility` Boolean - Page would be forced to be always in visible - or hidden state once set, instead of reflecting current window's - visibility. Users can set it to `true` to prevent throttling of DOM - timers. - -Creates a new `BrowserWindow` with native properties set by the `options`. -Usually you only need to set the `width` and `height`, other properties will -have decent default values. - -### Event: 'page-title-updated' - -* `event` Event - -Emitted when the document changed its title, calling `event.preventDefault()` -would prevent the native window's title to change. - -### Event: 'close' - -* `event` Event - -Emitted when the window is going to be closed. It's emitted before the -`beforeunload` and `unload` event of DOM, calling `event.preventDefault()` -would cancel the close. - -Usually you would want to use the `beforeunload` handler to decide whether the -window should be closed, which will also be called when the window is -reloaded. In Electron, returning an empty string or `false` would cancel the -close. An example is: - -```javascript -window.onbeforeunload = function(e) { - console.log('I do not want to be closed'); - - // Unlike usual browsers, in which a string should be returned and the user is - // prompted to confirm the page unload, Electron gives developers more options. - // Returning empty string or false would prevent the unloading now. - // You can also use the dialog API to let the user confirm closing the application. - return false; -}; -``` - -### Event: 'closed' - -Emitted when the window is closed. After you have received this event you should -remove the reference to the window and avoid using it anymore. - -### Event: 'unresponsive' - -Emitted when the web page becomes unresponsive. - -### Event: 'responsive' - -Emitted when the unresponsive web page becomes responsive again. - -### Event: 'blur' - -Emitted when window loses focus. - -### Event: 'focus' - -Emitted when window gains focus. - -### Event: 'maximize' - -Emitted when window is maximized. - -### Event: 'unmaximize' - -Emitted when window exits from maximized state. - -### Event: 'minimize' - -Emitted when window is minimized. - -### Event: 'restore' - -Emitted when window is restored from minimized state. - -### Event: 'resize' - -Emitted when window is getting resized. - -### Event: 'move' - -Emitted when the window is getting moved to a new position. - -__Note__: On OS X this event is just an alias of `moved`. - -### Event: 'moved' - -Emitted once when the window is moved to a new position. - -__Note__: This event is available only on OS X. - -### Event: 'enter-full-screen' - -Emitted when window enters full screen state. - -### Event: 'leave-full-screen' - -Emitted when window leaves full screen state. - -### Event: 'enter-html-full-screen' - -Emitted when window enters full screen state triggered by html api. - -### Event: 'leave-html-full-screen' - -Emitted when window leaves full screen state triggered by html api. - -### Event: 'devtools-opened' - -Emitted when devtools is opened. - -### Event: 'devtools-closed' - -Emitted when devtools is closed. - -### Event: 'devtools-focused' - -Emitted when devtools is focused / opened. - -### 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 commands, as well as the "Back" button built into some mice on Windows. - -```js -someWindow.on('app-command', function(e, cmd) { - // Navigate the window back when the user hits their mouse back button - if (cmd === 'browser-backward' && someWindow.webContents.canGoBack()) { - someWindow.webContents.goBack(); - } -}); -``` - -__Note__: This event is only fired on Windows. - -### Class Method: BrowserWindow.getAllWindows() - -Returns an array of all opened browser windows. - -### Class Method: BrowserWindow.getFocusedWindow() - -Returns the window that is focused in this application. - -### Class Method: BrowserWindow.fromWebContents(webContents) - -* `webContents` WebContents - -Find a window according to the `webContents` it owns - -### Class Method: BrowserWindow.fromId(id) - -* `id` Integer - -Find a window according to its ID. - -### Class Method: BrowserWindow.addDevToolsExtension(path) - -* `path` String - -Adds devtools extension located at `path`, and returns extension's name. - -The extension will be remembered so you only need to call this API once, this -API is not for programming use. - -### Class Method: BrowserWindow.removeDevToolsExtension(name) - -* `name` String - -Remove the devtools extension whose name is `name`. - -### BrowserWindow.webContents - -The `WebContents` object this window owns, all web page related events and -operations would be done via it. - -**Note:** Users should never store this object because it may become `null` -when the renderer process (web page) has crashed. - -### BrowserWindow.devToolsWebContents - -Get the `WebContents` of devtools of this window. - -**Note:** Users should never store this object because it may become `null` -when the devtools has been closed. - -### BrowserWindow.id - -Get the unique ID of this window. - -### BrowserWindow.destroy() - -Force closing the window, the `unload` and `beforeunload` event won't be emitted -for the web page, and `close` event would also not be emitted -for this window, but it would guarantee the `closed` event to be emitted. - -You should only use this method when the renderer process (web page) has crashed. - -### BrowserWindow.close() - -Try to close the window, this has the same effect with user manually clicking -the close button of the window. The web page may cancel the close though, see -the [close event](#event-close). - -### BrowserWindow.focus() - -Focus on the window. - -### BrowserWindow.isFocused() - -Returns whether the window is focused. - -### BrowserWindow.show() - -Shows and gives focus to the window. - -### BrowserWindow.showInactive() - -Shows the window but doesn't focus on it. - -### BrowserWindow.hide() - -Hides the window. - -### BrowserWindow.isVisible() - -Returns whether the window is visible to the user. - -### BrowserWindow.maximize() - -Maximizes the window. - -### BrowserWindow.unmaximize() - -Unmaximizes the window. - -### BrowserWindow.isMaximized() - -Returns whether the window is maximized. - -### BrowserWindow.minimize() - -Minimizes the window. On some platforms the minimized window will be shown in -the Dock. - -### BrowserWindow.restore() - -Restores the window from minimized state to its previous state. - -### BrowserWindow.isMinimized() - -Returns whether the window is minimized. - -### BrowserWindow.setFullScreen(flag) - -* `flag` Boolean - -Sets whether the window should be in fullscreen mode. - -### BrowserWindow.isFullScreen() - -Returns whether the window is in fullscreen mode. - -### BrowserWindow.setBounds(options) - -* `options` Object - * `x` Integer - * `y` Integer - * `width` Integer - * `height` Integer - -Resizes and moves the window to `width`, `height`, `x`, `y`. - -### BrowserWindow.getBounds() - -Returns an object that contains window's width, height, x and y values. - -### BrowserWindow.setSize(width, height) - -* `width` Integer -* `height` Integer - -Resizes the window to `width` and `height`. - -### BrowserWindow.getSize() - -Returns an array that contains window's width and height. - -### BrowserWindow.setContentSize(width, height) - -* `width` Integer -* `height` Integer - -Resizes the window's client area (e.g. the web page) to `width` and `height`. - -### BrowserWindow.getContentSize() - -Returns an array that contains window's client area's width and height. - -### BrowserWindow.setMinimumSize(width, height) - -* `width` Integer -* `height` Integer - -Sets the minimum size of window to `width` and `height`. - -### BrowserWindow.getMinimumSize() - -Returns an array that contains window's minimum width and height. - -### BrowserWindow.setMaximumSize(width, height) - -* `width` Integer -* `height` Integer - -Sets the maximum size of window to `width` and `height`. - -### BrowserWindow.getMaximumSize() - -Returns an array that contains window's maximum width and height. - -### BrowserWindow.setResizable(resizable) - -* `resizable` Boolean - -Sets whether the window can be manually resized by user. - -### BrowserWindow.isResizable() - -Returns whether the window can be manually resized by user. - -### BrowserWindow.setAlwaysOnTop(flag) - -* `flag` Boolean - -Sets whether the window should show always on top of other windows. After -setting this, the window is still a normal window, not a toolbox window which -can not be focused on. - -### BrowserWindow.isAlwaysOnTop() - -Returns whether the window is always on top of other windows. - -### BrowserWindow.center() - -Moves window to the center of the screen. - -### BrowserWindow.setPosition(x, y) - -* `x` Integer -* `y` Integer - -Moves window to `x` and `y`. - -### BrowserWindow.getPosition() - -Returns an array that contains window's current position. - -### BrowserWindow.setTitle(title) - -* `title` String - -Changes the title of native window to `title`. - -### BrowserWindow.getTitle() - -Returns the title of the native window. - -**Note:** The title of web page can be different from the title of the native -window. - -### BrowserWindow.flashFrame(flag) - -* `flag` Boolean - -Starts or stops flashing the window to attract user's attention. - -### BrowserWindow.setSkipTaskbar(skip) - -* `skip` Boolean - -Makes the window not show in the taskbar. - -### BrowserWindow.setKiosk(flag) - -* `flag` Boolean - -Enters or leaves the kiosk mode. - -### BrowserWindow.isKiosk() - -Returns whether the window is in kiosk mode. - -### BrowserWindow.setRepresentedFilename(filename) - -* `filename` String - -Sets the pathname of the file the window represents, and the icon of the file -will show in window's title bar. - -__Note__: This API is only available on OS X. - -### BrowserWindow.getRepresentedFilename() - -Returns the pathname of the file the window represents. - -__Note__: This API is only available on OS X. - -### BrowserWindow.setDocumentEdited(edited) - -* `edited` Boolean - -Specifies whether the window’s document has been edited, and the icon in title -bar will become grey when set to `true`. - -__Note__: This API is only available on OS X. - -### BrowserWindow.IsDocumentEdited() - -Whether the window's document has been edited. - -__Note__: This API is only available on OS X. - -### BrowserWindow.openDevTools([options]) - -* `options` Object - * `detach` Boolean - opens devtools in a new window - -Opens the developer tools. - -### BrowserWindow.closeDevTools() - -Closes the developer tools. - -### BrowserWindow.isDevToolsOpened() - -Returns whether the developer tools are opened. - -### BrowserWindow.toggleDevTools() - -Toggle the developer tools. - -### BrowserWindow.inspectElement(x, y) - -* `x` Integer -* `y` Integer - -Starts inspecting element at position (`x`, `y`). - -### BrowserWindow.inspectServiceWorker() - -Opens the developer tools for the service worker context present in the web contents. - -### BrowserWindow.focusOnWebView() - -### BrowserWindow.blurWebView() - -### BrowserWindow.capturePage([rect, ]callback) - -* `rect` Object - The area of page to be captured - * `x` Integer - * `y` Integer - * `width` Integer - * `height` Integer -* `callback` Function - -Captures the snapshot of page within `rect`, upon completion `callback` would be -called with `callback(image)`, the `image` is an instance of -[NativeImage](native-image.md) that stores data of the snapshot. Omitting the -`rect` would capture the whole visible page. - -**Note:** Be sure to read documents on remote buffer in -[remote](remote.md) if you are going to use this API in renderer -process. - -### BrowserWindow.print([options]) - -Same with `webContents.print([options])` - -### BrowserWindow.printToPDF(options, callback) - -Same with `webContents.printToPDF(options, callback)` - -### BrowserWindow.loadUrl(url, [options]) - -Same with `webContents.loadUrl(url, [options])`. - -### BrowserWindow.reload() - -Same with `webContents.reload`. - -### BrowserWindow.setMenu(menu) - -* `menu` Menu - -Sets the `menu` as the window's menu bar, setting it to `null` will remove the -menu bar. - -__Note:__ This API is not available on OS X. - -### BrowserWindow.setProgressBar(progress) - -* `progress` Double - -Sets progress value in progress bar. Valid range is [0, 1.0]. - -Remove progress bar when progress < 0; -Change to indeterminate mode when progress > 1. - -On Linux platform, only supports Unity desktop environment, you need to specify -the `*.desktop` file name to `desktopName` field in `package.json`. By default, -it will assume `app.getName().desktop`. - -### BrowserWindow.setOverlayIcon(overlay, description) - -* `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 -cleared -* `description` String - a description that will be provided to Accessibility -screen readers - -Sets a 16px overlay onto the current taskbar icon, usually used to convey some sort of application status or to passively notify the user. - -__Note:__ This API is only available on Windows (Windows 7 and above) - -### BrowserWindow.showDefinitionForSelection() - -Shows pop-up dictionary that searches the selected word on the page. - -__Note__: This API is only available on OS X. - -### BrowserWindow.setAutoHideMenuBar(hide) - -* `hide` Boolean - -Sets whether the window menu bar should hide itself automatically. Once set the -menu bar will only show when users press the single `Alt` key. - -If the menu bar is already visible, calling `setAutoHideMenuBar(true)` won't -hide it immediately. - -### BrowserWindow.isMenuBarAutoHide() - -Returns whether menu bar automatically hides itself. - -### BrowserWindow.setMenuBarVisibility(visible) - -* `visible` Boolean - -Sets whether the menu bar should be visible. If the menu bar is auto-hide, users -can still bring up the menu bar by pressing the single `Alt` key. - -### BrowserWindow.isMenuBarVisible() - -Returns whether the menu bar is visible. - -### BrowserWindow.setVisibleOnAllWorkspaces(visible) - -* `visible` Boolean - -Sets whether the window should be visible on all workspaces. - -**Note:** This API does nothing on Windows. - -### BrowserWindow.isVisibleOnAllWorkspaces() - -Returns whether the window is visible on all workspaces. - -**Note:** This API always returns false on Windows. - -## Class: WebContents - -A `WebContents` is responsible for rendering and controlling a web page. - -`WebContents` is an -[EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). - -### Event: 'did-finish-load' - -Emitted when the navigation is done, i.e. the spinner of the tab will stop -spinning, and the `onload` event was dispatched. - -### Event: 'did-fail-load' - -* `event` Event -* `errorCode` Integer -* `errorDescription` String - -This event is like `did-finish-load`, but emitted when the load failed or was -cancelled, e.g. `window.stop()` is invoked. - -### Event: 'did-frame-finish-load' - -* `event` Event -* `isMainFrame` Boolean - -Emitted when a frame has done navigation. - -### Event: 'did-start-loading' - -Corresponds to the points in time when the spinner of the tab starts spinning. - -### Event: 'did-stop-loading' - -Corresponds to the points in time when the spinner of the tab stops spinning. - -### Event: 'did-get-response-details' - -* `event` Event -* `status` Boolean -* `newUrl` String -* `originalUrl` String -* `httpResponseCode` Integer -* `requestMethod` String -* `referrer` String -* `headers` Object - -Emitted when details regarding a requested resource is available. -`status` indicates the socket connection to download the resource. - -### Event: 'did-get-redirect-request' - -* `event` Event -* `oldUrl` String -* `newUrl` String -* `isMainFrame` Boolean - -Emitted when a redirect was received while requesting a resource. - -### Event: 'dom-ready' - -* `event` Event - -Emitted when document in the given frame is loaded. - -### Event: 'page-favicon-updated' - -* `event` Event -* `favicons` Array - Array of Urls - -Emitted when page receives favicon urls. - -### Event: 'new-window' - -* `event` Event -* `url` String -* `frameName` String -* `disposition` String - Can be `default`, `foreground-tab`, `background-tab`, - `new-window` and `other` - -Emitted when the page requested to open a new window for `url`. It could be -requested by `window.open` or an external link like ``. - -By default a new `BrowserWindow` will be created for the `url`. - -Calling `event.preventDefault()` can prevent creating new windows. - -### Event: 'will-navigate' - -* `event` Event -* `url` String - -Emitted when user or the page wants to start an navigation, it can happen when -`window.location` object is changed or user clicks a link in the page. - -This event will not emit when the navigation is started programmatically with APIs -like `WebContents.loadUrl` and `WebContents.back`. - -Calling `event.preventDefault()` can prevent the navigation. - -### Event: 'crashed' - -Emitted when the renderer process is crashed. - -### Event: 'plugin-crashed' - -* `event` Event -* `name` String -* `version` String - -Emitted when a plugin process is crashed. - -### Event: 'destroyed' - -Emitted when the WebContents is destroyed. - -### WebContents.session - -Returns the `Session` object used by this WebContents. - -### WebContents.loadUrl(url, [options]) - -* `url` URL -* `options` URL - * `httpReferrer` String - A HTTP Referer url - * `userAgent` String - A user agent originating the request - -Loads the `url` in the window, the `url` must contains the protocol prefix, -e.g. the `http://` or `file://`. - -### WebContents.getUrl() - -Returns URL of current web page. - -### WebContents.getTitle() - -Returns the title of web page. - -### WebContents.isLoading() - -Returns whether web page is still loading resources. - -### WebContents.isWaitingForResponse() - -Returns whether web page is waiting for a first-response for the main resource -of the page. - -### WebContents.stop() - -Stops any pending navigation. - -### WebContents.reload() - -Reloads current page. - -### WebContents.reloadIgnoringCache() - -Reloads current page and ignores cache. - -### WebContents.canGoBack() - -Returns whether the web page can go back. - -### WebContents.canGoForward() - -Returns whether the web page can go forward. - -### WebContents.canGoToOffset(offset) - -* `offset` Integer - -Returns whether the web page can go to `offset`. - -### WebContents.clearHistory() - -Clears the navigation history. - -### WebContents.goBack() - -Makes the web page go back. - -### WebContents.goForward() - -Makes the web page go forward. - -### WebContents.goToIndex(index) - -* `index` Integer - -Navigates to the specified absolute index. - -### WebContents.goToOffset(offset) - -* `offset` Integer - -Navigates to the specified offset from the "current entry". - -### WebContents.isCrashed() - -Whether the renderer process has crashed. - -### WebContents.setUserAgent(userAgent) - -* `userAgent` String - -Overrides the user agent for this page. - -### WebContents.insertCSS(css) - -* `css` String - -Injects CSS into this page. - -### WebContents.executeJavaScript(code) - -* `code` String - -Evaluates `code` in page. - -### WebContents.setAudioMuted(muted) - -+ `muted` Boolean - -Set the page muted. - -### WebContents.isAudioMuted() - -Returns whether this page has been muted. - -### WebContents.undo() - -Executes editing command `undo` in page. - -### WebContents.redo() - -Executes editing command `redo` in page. - -### WebContents.cut() - -Executes editing command `cut` in page. - -### WebContents.copy() - -Executes editing command `copy` in page. - -### WebContents.paste() - -Executes editing command `paste` in page. - -### WebContents.pasteAndMatchStyle() - -Executes editing command `pasteAndMatchStyle` in page. - -### WebContents.delete() - -Executes editing command `delete` in page. - -### WebContents.selectAll() - -Executes editing command `selectAll` in page. - -### WebContents.unselect() - -Executes editing command `unselect` in page. - -### WebContents.replace(text) - -* `text` String - -Executes editing command `replace` in page. - -### WebContents.replaceMisspelling(text) - -* `text` String - -Executes editing command `replaceMisspelling` in page. - -### WebContents.hasServiceWorker(callback) - -* `callback` Function - -Checks if any serviceworker is registered and returns boolean as -response to `callback`. - -### WebContents.unregisterServiceWorker(callback) - -* `callback` Function - -Unregisters any serviceworker if present and returns boolean as -response to `callback` when the JS promise is fullfilled or false -when the JS promise is rejected. - -### WebContents.print([options]) - -* `options` Object - * `silent` Boolean - Don't ask user for print settings, defaults to `false` - * `printBackground` Boolean - Also prints the background color and image of - the web page, defaults to `false`. - -Prints window's web page. When `silent` is set to `false`, Electron will pick -up system's default printer and default settings for printing. - -Calling `window.print()` in web page is equivalent to call -`WebContents.print({silent: false, printBackground: false})`. - -**Note:** On Windows, the print API relies on `pdf.dll`. If your application -doesn't need print feature, you can safely remove `pdf.dll` in saving binary -size. - -### WebContents.printToPDF(options, callback) - -* `options` Object - * `marginsType` Integer - Specify the type of margins to use - * 0 - default - * 1 - none - * 2 - minimum - * `printBackground` Boolean - Whether to print CSS backgrounds. - * `printSelectionOnly` Boolean - Whether to print selection only. - * `landscape` Boolean - `true` for landscape, `false` for portrait. - -* `callback` Function - `function(error, data) {}` - * `error` Error - * `data` Buffer - PDF file content - -Prints windows' web page as PDF with Chromium's preview printing custom -settings. - -By default, an empty `options` will be regarded as -`{marginsType:0, printBackgrounds:false, printSelectionOnly:false, - landscape:false}`. - -```javascript -var BrowserWindow = require('browser-window'); -var fs = require('fs'); - -var win = new BrowserWindow({width: 800, height: 600}); -win.loadUrl("http://github.com"); - -win.webContents.on("did-finish-load", function() { - // Use default printing options - win.webContents.printToPDF({}, function(error, data) { - if (error) throw error; - fs.writeFile(dist, data, function(error) { - if (err) - alert('write pdf file error', error); - }) - }) -}); -``` - -### WebContents.send(channel[, args...]) - -* `channel` String - -Send `args..` to the web page via `channel` in asynchronous message, the web -page can handle it by listening to the `channel` event of `ipc` module. - -An example of sending messages from the main process to the renderer process: - -```javascript -// On the main process. -var window = null; -app.on('ready', function() { - window = new BrowserWindow({width: 800, height: 600}); - window.loadUrl('file://' + __dirname + '/index.html'); - window.webContents.on('did-finish-load', function() { - window.webContents.send('ping', 'whoooooooh!'); - }); -}); -``` - -```html -// index.html - - - - - -``` - -**Note:** - -1. The IPC message handler in web pages do not have a `event` parameter, which - is different from the handlers on the main process. -2. There is no way to send synchronous messages from the main process to a - renderer process, because it would be very easy to cause dead locks. - -## Class: Session - -### Session.cookies - -The `cookies` gives you ability to query and modify cookies, an example is: - -```javascript -var BrowserWindow = require('browser-window'); - -var win = new BrowserWindow({ width: 800, height: 600 }); - -win.loadUrl('https://github.com'); - -win.webContents.on('did-finish-load', function() { - // Query all cookies. - win.webContents.session.cookies.get({}, function(error, cookies) { - if (error) throw error; - console.log(cookies); - }); - - // Query all cookies that are associated with a specific url. - win.webContents.session.cookies.get({ url : "http://www.github.com" }, - function(error, cookies) { - if (error) throw error; - console.log(cookies); - }); - - // Set a cookie with the given cookie data; - // may overwrite equivalent cookies if they exist. - win.webContents.session.cookies.set( - { url : "http://www.github.com", name : "dummy_name", value : "dummy"}, - function(error, cookies) { - if (error) throw error; - console.log(cookies); - }); -}); -``` - -### Session.cookies.get(details, callback) - -* `details` Object - * `url` String - Retrieves cookies which are associated with `url`. - Empty imples retrieving cookies of all urls. - * `name` String - Filters cookies by name - * `domain` String - Retrieves cookies whose domains match or are subdomains of `domains` - * `path` String - Retrieves cookies whose path matches `path` - * `secure` Boolean - Filters cookies by their Secure property - * `session` Boolean - Filters out session or persistent cookies. -* `callback` Function - function(error, cookies) - * `error` Error - * `cookies` Array - array of `cookie` objects. - * `cookie` - Object - * `name` String - The name of the cookie - * `value` String - The value of the cookie - * `domain` String - The domain of the cookie - * `host_only` String - Whether the cookie is a host-only cookie - * `path` String - The path of the cookie - * `secure` Boolean - Whether the cookie is marked as Secure (typically HTTPS) - * `http_only` Boolean - Whether the cookie is marked as HttpOnly - * `session` Boolean - Whether the cookie is a session cookie or a persistent - cookie with an expiration date. - * `expirationDate` Double - (Option) The expiration date of the cookie as - the number of seconds since the UNIX epoch. Not provided for session cookies. - - -### Session.cookies.set(details, callback) - -* `details` Object - * `url` String - Retrieves cookies which are associated with `url` - * `name` String - The name of the cookie. Empty by default if omitted. - * `value` String - The value of the cookie. Empty by default if omitted. - * `domain` String - The domain of the cookie. Empty by default if omitted. - * `path` String - The path of the cookie. Empty by default if omitted. - * `secure` Boolean - Whether the cookie should be marked as Secure. Defaults to false. - * `session` Boolean - Whether the cookie should be marked as HttpOnly. Defaults to false. - * `expirationDate` Double - The expiration date of the cookie as the number of - seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie. - -* `callback` Function - function(error) - * `error` Error - -### Session.cookies.remove(details, callback) - -* `details` Object - * `url` String - The URL associated with the cookie - * `name` String - The name of cookie to remove -* `callback` Function - function(error) - * `error` Error - -### Session.clearCache(callback) - -* `callback` Function - Called when operation is done - -Clears the session's HTTP cache. - -### Session.clearStorageData([options, ]callback) - -* `options` Object - * `origin` String - Should follow `window.location.origin`'s representation - `scheme://host:port` - * `storages` Array - The types of storages to clear, can contain: - `appcache`, `cookies`, `filesystem`, `indexdb`, `localstorage`, - `shadercache`, `websql`, `serviceworkers` - * `quotas` Array - The types of quotas to clear, can contain: - `temporary`, `persistent`, `syncable` -* `callback` Function - Called when operation is done - -Clears the data of web storages. diff --git a/docs/api/dialog-ko.md b/docs/api/dialog-ko.md index a16daebb6f3a..11b06f99ae9c 100644 --- a/docs/api/dialog-ko.md +++ b/docs/api/dialog-ko.md @@ -66,23 +66,27 @@ Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동 * `browserWindow` BrowserWindow * `options` Object - ** `type` String - `"none"`, `"info"`, `"error"`, `"question"`, `"warning"` 중 하나를 사용할 수 있습니다. + * `type` String - `"none"`, `"info"`, `"error"`, `"question"`, `"warning"` 중 하나를 사용할 수 있습니다. + Windows에선 따로 `icon`을 설정하지 않은 이상 "question"과 "info"는 같은 아이콘으로 표시됩니다. * `buttons` Array - 버튼들의 라벨을 포함한 배열입니다. - * `title` String - 메시지 상자의 제목입니다. 몇몇 플랫폼에선 보이지 않을 수 있습니다. - * `message` String - 메시지 상자의 본문 내용입니다. + * `title` String - 대화 상자의 제목입니다. 몇몇 플랫폼에선 보이지 않을 수 있습니다. + * `message` String - 대화 상자의 본문 내용입니다. * `detail` String - 메시지의 추가 정보입니다. * `icon` [NativeImage](native-image-ko.md) * `cancelId` Integer - 유저가 대화 상자의 버튼을 클릭하지 않고 대화 상자를 취소했을 때 반환되는 버튼의 index입니다. 기본적으로 버튼 리스트가 "cancel" 또는 "no" 라벨을 가지고 있을 때 해당 버튼의 index를 반환합니다. 따로 두 라벨이 지정되지 않은 경우 0을 반환합니다. OS X와 Windows에선 `cancelId` 지정 여부에 상관없이 "Cancel" 버튼이 언제나 `cancelId`로 지정됩니다. + * `noLink` Boolean - Windows Electron은 "Cancel"이나 "Yes"와 같은 흔히 사용되는 버튼을 찾으려고 시도하고 + 대화 상자 내에서 해당 버튼을 커맨드 링크처럼 만듭니다. 이 기능으로 앱을 좀 더 Modern Windows 앱처럼 만들 수 있습니다. + 이 기능을 원하지 않으면 `noLink`를 true로 지정하면 됩니다. * `callback` Function -메시지 상자를 표시합니다. `browserWindow`를 지정하면 메시지 상자가 완전히 닫힐 때까지는 창을 사용할 수 없습니다. +대화 상자를 표시합니다. `browserWindow`를 지정하면 대화 상자가 완전히 닫힐 때까지는 창을 사용할 수 없습니다. 완료시 유저가 선택한 버튼의 index를 반환합니다. 역주: 부정을 표현하는 "아니오", "취소"와 같은 한글 단어는 지원되지 않습니다. 만약 OS X 또는 Windows에서 "확인", "취소"와 같은 순서로 버튼을 지정하게 될 때 Alt + f4로 해당 대화 상자를 끄게 되면 "확인"을 누른걸로 판단되어 버립니다. -이를 해결하려면 "Cancel"을 대신 사용하거나 BrowserWindow API를 사용하여 메시지 상자를 직접 구현해야합니다. +이를 해결하려면 "Cancel"을 대신 사용하거나 BrowserWindow API를 사용하여 대화 상자를 직접 구현해야합니다. `callback`이 전달되면 메소드가 비동기로 작동되며 결과는 `callback(response)`을 통해 전달됩니다. diff --git a/docs/api/tray-ko.md b/docs/api/tray-ko.md index 145302b65f65..3d7120e69b98 100644 --- a/docs/api/tray-ko.md +++ b/docs/api/tray-ko.md @@ -24,8 +24,8 @@ app.on('ready', function(){ __플랫폼별 한계:__ -* OS X에서는 트레이 아이콘이 컨텍스트 메뉴를 가지고 있을 경우 `clicked` 이벤트는 무시됩니다. * Linux에서는 앱 알림 표시기(app indicator)가 지원되면 해당 기능을 사용합니다. 만약 지원하지 않으면 `GtkStatusIcon`을 대신 사용합니다. +* Linux 배포판이 앱 알림 표시기만 지원하고 있다면 `libappindicator1`를 설치하여 트레이 아이콘이 작동하도록 만들 수 있습니다. * 앱 알림 표시기는 컨텍스트 메뉴를 가지고 있을 때만 보입니다. * Linux에서 앱 알림 표시기가 사용될 경우, `clicked` 이벤트는 무시됩니다. @@ -55,6 +55,20 @@ __플랫폼별 한계:__ __주의:__ `bounds`는 OS X와 Window 7 이후 버전에서만 작동합니다. +### Event: 'right-clicked' + +* `event` +* `bounds` Object - 트레이 아이콘의 범위 + * `x` Integer + * `y` Integer + * `width` Integer + * `height` Integer + +트레이 아이콘을 오른쪽 클릭될 때 호출 됩니다. + +__주의:__ 이 기능은 Windows와 OS X에서만 사용할 수 있습니다. +Windows에서는 이 이벤트가 컨텍스트 메뉴를 가지고 있을 때만 호출됩니다. + ### Event: 'double-clicked' 트레이 아이콘이 더블 클릭될 때 호출됩니다. @@ -79,6 +93,15 @@ __주의:__ 이 기능은 Windows에서만 작동합니다. __주의:__ 이 기능은 Windows에서만 작동합니다. +### Event: 'drop-files' + +* `event` +* `files` Array - 드롭된 파일의 경로 + +트레이 아이콘에 파일이 드롭되면 호출됩니다. + +__주의:__ 이 기능은 OS X에서만 작동합니다. + ### Tray.destroy() 트레이 아이콘을 즉시 삭제시킵니다. @@ -130,6 +153,15 @@ __주의:__ 이 기능은 OS X에서만 작동합니다. __알림:__ 이 기능은 Windows에서만 작동합니다. +### Tray.popContextMenu([position]) + +* `position` Object - 팝 메뉴 위치 + * `x` Integer + * `y` Integer + +__주의:__ 이 기능은 Windows와 OS X에서만 작동합니다. +`position`은 Windows에서만 사용할 수 있으며 기본값은 (0, 0)입니다. + ### Tray.setContextMenu(menu) * `menu` Menu diff --git a/docs/api/web-view-tag-ko.md b/docs/api/web-view-tag-ko.md index 2ff07ccc126f..e6b3d6c99f5c 100644 --- a/docs/api/web-view-tag-ko.md +++ b/docs/api/web-view-tag-ko.md @@ -215,6 +215,10 @@ Whether the renderer process has crashed. Overrides the user agent for guest page. +### ``.getUserAgent() + +Returns a `String` represents the user agent for guest page. + ### ``.insertCSS(css) * `css` String