add last api files first

2016-03-15 17:03:48 +08:00 · 2016-03-15 17:03:48 +08:00 · b105bf59c1
commit b105bf59c1
parent c2c91b6477
4 changed files with 455 additions and 0 deletions
--- a/docs-translations/zh-CN/api/clipboard.md
+++ b/docs-translations/zh-CN/api/clipboard.md
@ -0,0 +1,117 @@
+# clipboard
+
+`clipboard` 模块提供方法来供复制和粘贴操作 .
+下面例子展示了如何将一个字符串写道 clipboard 上:
+
+```javascript
+const clipboard = require('electron').clipboard;
+clipboard.writeText('Example String');
+```
+
+在 X Window 系统上, 有一个可选的 clipboard. 你可以为每个方法使用 `selection` 来控制它:
+
+```javascript
+clipboard.writeText('Example String', 'selection');
+console.log(clipboard.readText('selection'));
+```
+
+## 方法
+
+`clipboard` 模块有以下方法:
+
+**注意:** 测试 APIs 已经标明，并且在将来会被删除 .
+
+### `clipboard.readText([type])`
+
+* `type` String (可选)
+ 
+以纯文本形式从 clipboard 返回内容 .
+
+### `clipboard.writeText(text[, type])`
+
+* `text` String
+* `type` String (可选)
+
+以纯文本形式向 clipboard 添加内容 .
+
+### `clipboard.readHtml([type])`
+
+* `type` String (可选)
+
+返回 clipboard 中的标记内容.
+
+### `clipboard.writeHtml(markup[, type])`
+
+* `markup` String
+* `type` String (可选)
+
+向 clipboard 添加 `markup` 内容 .
+
+### `clipboard.readImage([type])`
+
+* `type` String (可选)
+
+从 clipboard 中返回 [NativeImage](native-image.md) 内容.
+
+### `clipboard.writeImage(image[, type])`
+
+* `image` [NativeImage](native-image.md)
+* `type` String (可选)
+
+向 clipboard 中写入 `image` .
+
+### `clipboard.readRtf([type])`
+
+* `type` String (可选)
+
+从 clipboard 中返回 RTF 内容. 
+
+### `clipboard.writeRtf(text[, type])`
+
+* `text` String
+* `type` String (可选)
+
+向 clipboard 中写入 RTF 格式的 `text` .
+
+### `clipboard.clear([type])`
+
+* `type` String (可选)
+
+清空 clipboard 内容.
+
+### `clipboard.availableFormats([type])`
+
+* `type` String (可选)
+
+返回 clipboard 支持的格式数组 .
+
+### `clipboard.has(data[, type])` _Experimental_
+
+* `data` String
+* `type` String (可选)
+
+返回 clipboard 是否支持指定 `data` 的格式.
+
+```javascript
+console.log(clipboard.has('<p>selection</p>'));
+```
+
+### `clipboard.read(data[, type])` _Experimental_
+
+* `data` String
+* `type` String (可选)
+
+读取 clipboard 的 `data`.
+
+### `clipboard.write(data[, type])`
+
+* `data` Object
+  * `text` String
+  * `html` String
+  * `image` [NativeImage](native-image.md)
+* `type` String (可选)
+
+```javascript
+clipboard.write({text: 'test', html: "<b>test</b>"});
+```
+向 clipboard 写入 `data` .
--- a/docs-translations/zh-CN/api/crash-reporter.md
+++ b/docs-translations/zh-CN/api/crash-reporter.md
@ -0,0 +1,61 @@
+# crashReporter
+
+`crash-reporter` 模块开启发送应用崩溃报告.
+
+下面是一个自动提交崩溃报告给服务器的例子 :
+
+```javascript
+const crashReporter = require('electron').crashReporter;
+
+crashReporter.start({
+  productName: 'YourName',
+  companyName: 'YourCompany',
+  submitURL: 'https://your-domain.com/url-to-submit',
+  autoSubmit: true
+});
+```
+
+## 方法
+
+`crash-reporter` 模块有如下方法:
+
+### `crashReporter.start(options)`
+
+* `options` Object
+  * `companyName` String
+  * `submitURL` String - 崩溃报告发送的路径，以post方式.
+  * `productName` String (可选) - 默认为 `Electron`.
+  * `autoSubmit` Boolean - 是否自动提交.
+    默认为 `true`.
+  * `ignoreSystemCrashHandler` Boolean - 默认为 `false`.
+  * `extra` Object - 一个你可以定义的对象，附带在崩溃报告上一起发送 . 只有字符串属性可以被正确发送，不支持嵌套对象.
+
+只可以在使用其它 `crashReporter` APIs 之前使用这个方法.
+
+**注意:** 在 OS X, Electron 使用一个新的 `crashpad` 客户端, 与 Windows 和 Linux 的 `breakpad` 不同. 为了开启崩溃点搜集，你需要在主进程和其它每个你需要搜集崩溃报告的渲染进程中调用  `crashReporter.start` API 来初始化 `crashpad`.
+
+### `crashReporter.getLastCrashReport()`
+
+返回最后一个崩溃报告的日期和 ID.如果没有过崩溃报告发送过来，或者还没有开始崩溃报告搜集，将返回 `null` .
+
+### `crashReporter.getUploadedReports()`
+
+返回所有上载的崩溃报告，每个报告包含了上载日期和 ID.
+
+## crash-reporter Payload
+
+崩溃报告将发送下面的数据给 `POST` 型的 `提交 URL` :
+
+* `ver` String - Electron 版本.
+* `platform` String - 例如 'win32'.
+* `process_type` String - 例如 'renderer'.
+* `guid` String - 例如 '5e1286fc-da97-479e-918b-6bfb0c3d1c72'
+* `_version` String - `package.json` 版本.
+* `_productName` String - `crashReporter` `options`
+  对象中的产品名字.
+* `prod` String - 基础产品名字. 这种情况为 Electron.
+* `_companyName` String - `crashReporter` `options`
+  对象中的公司名字.
+* `upload_file_minidump` File - 崩溃报告为文件.
+* `crashReporter` 中的 `extra` 对象的所有等级和一个属性.
+  `options` object
--- a/docs-translations/zh-CN/api/native-image.md
+++ b/docs-translations/zh-CN/api/native-image.md
@ -0,0 +1,142 @@
+# nativeImage
+
+在 Electron 中, 对所有创建 images 的 api 来说, 你可以使用文件路径或 `nativeImage` 实例. 如果使用 `null` ，将创建一个空的image 对象.
+
+例如, 当创建一个 tray 或设置窗口的图标时候，你可以使用一个字符串的图片路径 :
+
+```javascript
+var appIcon = new Tray('/Users/somebody/images/icon.png');
+var window = new BrowserWindow({icon: '/Users/somebody/images/window.png'});
+```
+
+或者从剪切板中读取图片，它返回的是 `nativeImage`:
+
+```javascript
+var image = clipboard.readImage();
+var appIcon = new Tray(image);
+```
+
+## 支持的格式
+
+当前支持 `PNG` 和 `JPEG` 图片格式. 推荐 `PNG` ，因为它支持透明和无损压缩.
+
+在 Windows, 你也可以使用 `ICO` 图标的格式.
+
+## 高分辨率图片
+
+如果平台支持 high-DPI，你可以在图片基础路径后面添加 `@2x` ，可以标识它为高分辨率的图片.
+
+例如，如果 `icon.png` 是一个普通图片并且拥有标准分辨率，然后 `icon@2x.png`将被当作高分辨率的图片处理，它将拥有双倍 DPI 密度.
+
+如果想同时支持展示不同分辨率的图片，你可以将拥有不同size 的图片放在同一个文件夹下，不用 DPI 后缀.例如 :
+
+```text
+images/
+├── icon.png
+├── icon@2x.png
+└── icon@3x.png
+```
+
+
+```javascript
+var appIcon = new Tray('/Users/somebody/images/icon.png');
+```
+
+也支持下面这些 DPI 后缀:
+
+* `@1x`
+* `@1.25x`
+* `@1.33x`
+* `@1.4x`
+* `@1.5x`
+* `@1.8x`
+* `@2x`
+* `@2.5x`
+* `@3x`
+* `@4x`
+* `@5x`
+
+## 模板图片
+
+模板图片由黑色和清色(和一个 alpha 通道)组成.
+模板图片不是单独使用的，而是通常和其它内容混合起来创建期望的最终效果.
+
+最常见的用力是将模板图片用到菜单栏图片上，所以它可以同时适应亮、黑不同的菜单栏.
+
+**注意:** 模板图片只在 OS X 上可用.
+
+为了将图片标识为一个模板图片，它的文件名应当以 `Template` 结尾. 例如:
+
+* `xxxTemplate.png`
+* `xxxTemplate@2x.png`
+
+## 方法
+
+`nativeImage` 类有如下方法:
+
+### `nativeImage.createEmpty()`
+
+创建一个空的 `nativeImage` 实例.
+
+### `nativeImage.createFromPath(path)`
+
+* `path` String
+
+从指定 `path` 创建一个新的 `nativeImage` 实例 .
+
+### `nativeImage.createFromBuffer(buffer[, scaleFactor])`
+
+* `buffer` [Buffer][buffer]
+* `scaleFactor` Double (可选)
+
+从 `buffer` 创建一个新的 `nativeImage` 实例 .默认  `scaleFactor` 是 1.0.
+
+### `nativeImage.createFromDataURL(dataURL)`
+
+* `dataURL` String
+
+从 `dataURL` 创建一个新的 `nativeImage` 实例 .
+
+## 实例方法
+
+`nativeImage` 有如下方法:
+
+```javascript
+const nativeImage = require('electron').nativeImage;
+
+var image = nativeImage.createFromPath('/Users/somebody/images/icon.png');
+```
+
+### `image.toPng()`
+
+返回一个 [Buffer][buffer] ，它包含了图片的 `PNG` 编码数据.
+
+### `image.toJpeg(quality)`
+
+* `quality` Integer (**必须**) - 在 0 - 100 之间.
+
+返回一个 [Buffer][buffer] ，它包含了图片的 `JPEG` 编码数据.
+
+### `image.toDataURL()`
+
+返回图片数据的 URL.
+
+### `image.isEmpty()`
+
+返回一个 boolean ，标识图片是否为空.
+
+### `image.getSize()`
+
+返回图片的 size.
+
+[buffer]: https://nodejs.org/api/buffer.html#buffer_class_buffer
+
+### `image.setTemplateImage(option)`
+
+* `option` Boolean
+
+将图片标识为模板图片.
+
+### `image.isTemplateImage()`
+
+返回一个 boolean ，标识图片是否是模板图片.
--- a/docs-translations/zh-CN/api/screen.md
+++ b/docs-translations/zh-CN/api/screen.md
@ -0,0 +1,135 @@
+# screen
+
+`screen` 模块检索屏幕的 size，显示，鼠标位置等的信息.在 `app` 模块的`ready` 事件触发之前不可使用这个模块.
+
+`screen` 是一个 [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter).
+
+**注意:** 在渲染进程 / 开发者工具栏, `window.screen` 是一个预设值的 DOM
+属性, 所以这样写 `var screen = require('electron').screen` 将不会工作.
+在我们下面的例子, 我们取代使用可变名字的 `electronScreen`.
+一个例子，创建一个充满真个屏幕的窗口 :
+
+```javascript
+const electron = require('electron');
+const app = electron.app;
+const BrowserWindow = electron.BrowserWindow;
+
+var mainWindow;
+
+app.on('ready', function() {
+  var electronScreen = electron.screen;
+  var size = electronScreen.getPrimaryDisplay().workAreaSize;
+  mainWindow = new BrowserWindow({ width: size.width, height: size.height });
+});
+```
+
+另一个例子，在次页外创建一个窗口:
+
+```javascript
+const electron = require('electron');
+const app = electron.app;
+const BrowserWindow = electron.BrowserWindow;
+
+var mainWindow;
+
+app.on('ready', function() {
+  var electronScreen = electron.screen;
+  var displays = electronScreen.getAllDisplays();
+  var externalDisplay = null;
+  for (var i in displays) {
+    if (displays[i].bounds.x != 0 || displays[i].bounds.y != 0) {
+      externalDisplay = displays[i];
+      break;
+    }
+  }
+
+  if (externalDisplay) {
+    mainWindow = new BrowserWindow({
+      x: externalDisplay.bounds.x + 50,
+      y: externalDisplay.bounds.y + 50
+    });
+  }
+});
+```
+
+## `Display` 对象
+
+`Display` 对象表示了物力方式连接系统. 一个伪造的 `Display` 或许存在于一个无头系统中，或者一个 `Display` 相当于一个远程的、虚拟的 display.
+
+* `display` object
+  * `id` Integer - 与display 相关的唯一性标志.
+  * `rotation` Integer - 可以是 0, 1, 2, 3, 每个代表了屏幕旋转的度数 0, 90, 180, 270.
+  * `scaleFactor` Number - Output device's pixel scale factor.
+  * `touchSupport` String - 可以是 `available`, `unavailable`, `unknown`.
+  * `bounds` Object
+  * `size` Object
+  * `workArea` Object
+  * `workAreaSize` Object
+
+## 事件
+
+`screen` 模块有如下事件:
+
+### Event: 'display-added'
+
+返回:
+
+* `event` Event
+* `newDisplay` Object
+
+当添加了 `newDisplay` 时发出事件
+
+### Event: 'display-removed'
+
+返回:
+
+* `event` Event
+* `oldDisplay` Object
+
+当移出了 `oldDisplay` 时发出事件
+
+### Event: 'display-metrics-changed'
+
+返回:
+
+* `event` Event
+* `display` Object
+* `changedMetrics` Array
+
+当一个 `display` 中的一个或更多的 metrics 改变时发出事件.
+`changedMetrics` 是一个用来描述这个改变的数组.可能的变化为  `bounds`,
+`workArea`, `scaleFactor` 和 `rotation`.
+
+## 方法
+
+`screen` 模块有如下方法:
+
+### `screen.getCursorScreenPoint()`
+
+返回当前鼠标的绝对路径 .
+
+### `screen.getPrimaryDisplay()`
+
+返回最主要的 display.
+
+### `screen.getAllDisplays()`
+
+返回一个当前可用的 display 数组.
+
+### `screen.getDisplayNearestPoint(point)`
+
+* `point` Object
+  * `x` Integer
+  * `y` Integer
+
+返回离指定点最近的 display.
+
+### `screen.getDisplayMatching(rect)`
+
+* `rect` Object
+  * `x` Integer
+  * `y` Integer
+  * `width` Integer
+  * `height` Integer
+
+返回与提供的边界范围最密切相关的 display.