Add Japanes translated docs.

This commit is contained in:
Takahito Yamatoya 2016-01-18 01:00:28 +09:00
parent 6ecacd18be
commit def1477466
6 changed files with 251 additions and 0 deletions

View file

@ -0,0 +1,27 @@
# `File` object
DOMのファイルインターフェイスにより、ユーザーはHTML 5 ファイルAPIで直接、ネイティブファイルで作業できるように、ネイティブファイル周りの抽象化を提供します。Electronは、ファイルシステム上のファイルの実際のパスを公開する`File`インターフェイスの`path`属性を追加します。
アプリ上にドラッグしたファイルの実際のパスを取得する例:
```html
<div id="holder">
Drag your file here
</div>
<script>
var holder = document.getElementById('holder');
holder.ondragover = function () {
return false;
};
holder.ondragleave = holder.ondragend = function () {
return false;
};
holder.ondrop = function (e) {
e.preventDefault();
var file = e.dataTransfer.files[0];
console.log('File you dragged here is', file.path);
return false;
};
</script>
```

View file

@ -0,0 +1,33 @@
# powerMonitor
`power-monitor`モジュールは、パワー状態の変更の監視に使われます。メインプロセスでみ使用することができます。`app`モジュールの`ready`が出力されるまで、このモジュールを使うべきではありません。
例:
```javascript
app.on('ready', function() {
require('electron').powerMonitor.on('suspend', function() {
console.log('The system is going to sleep');
});
});
```
## イベント
`power-monitor`モジュールは次のイベントを出力します。:
### イベント: 'suspend'
システムがサスペンドのときに出力されます。
### イベント: 'resume'
システムがレジュームのときに出力されます。
### イベント: 'on-ac'
システムがACパワーに変わったときに出力されます。
### イベント: 'on-battery'
システムがバッテリーパワーに変わったときに出力されます。

View file

@ -0,0 +1,42 @@
# powerSaveBlocker
`powerSaveBlocker`モジュールは、省電力(スリープ)モードからシステムをブロックするのに使用され、それ故にアプリがシステムと画面をアクティブに維持することができます。
例:
```javascript
const powerSaveBlocker = require('electron').powerSaveBlocker;
var id = powerSaveBlocker.start('prevent-display-sleep');
console.log(powerSaveBlocker.isStarted(id));
powerSaveBlocker.stop(id);
```
## メソッド
`powerSaveBlocker`モジュールは次のメソッドを持ちます:
### `powerSaveBlocker.start(type)`
* `type` String - パワーセーブのブロック種類です。
* `prevent-app-suspension` - アプリケーションがサスペンドになるのを防ぎます。システムのアクティブ状態を維持できますが、画面をオフにすることができます。使用例:ファイルのダウンロードまたは音楽の再生
* `prevent-display-sleep`- ディスプレイがスリープになるのを防ぎます。システムと画面のアクティブ状態を維持できます。使用例:ビデオ再生
省電力モードに入るのを防止するシステムを開始します。パワーセーブブロッカーを確認する数字を返します。
**Note:** `prevent-display-sleep`は`prevent-app-suspension`より高い優先権を持ちます。最も優先権が高いタイプのみが影響します。言い換えれば。`prevent-display-sleep`はいつも`prevent-app-suspension`より高い優先権をもちます。
例えば、APIが`prevent-app-suspension`を要求するAをコールし、ほかのAPIが`prevent-display-sleep`を要求するBをコールすると、`prevent-display-sleep`はBのリクエストが止まるまで使われ、そのあと`prevent-app-suspension`が使われます。
### `powerSaveBlocker.stop(id)`
* `id` Integer - `powerSaveBlocker.start`によって、パワーセーブブロッカーIDが返されます。
指定したパワーセーブブロッカーを停止します。
### `powerSaveBlocker.isStarted(id)`
* `id` Integer - `powerSaveBlocker.start`によって、パワーセーブブロッカーIDが返されます。
`powerSaveBlocker`が開始したかどうかのブーリアン値を返します。

View file

@ -0,0 +1,47 @@
# process
Electronの`process`オブジェクトは上流nodeの1つから次のような違いがあります。
* `process.type` String - プロセスの種類で、`browser` (例 メインプロセス)または `renderer`を設定できます。
* `process.versions['electron']` String - Electronのバージョン
* `process.versions['chrome']` String - Chromiumのバージョン
* `process.resourcesPath` String - JavaScriptのソースコードのパスを設定します。
* `process.mas` Boolean - Mac app Store用のビルドで、値は`true`です。ほかのビルドの場合は`undefined`です。
## イベント
### イベント: 'loaded'
Electronは内部の初期化スクリプトをロードしたとき出力され、ウェブページまたはメインスクリプトのロードが始まります。
Node統合がオフになっているとき、削除したNodeグローバルシンボルをグローバルスコープへ戻してプリロードスクリプトで使用できます。
```js
// preload.js
var _setImmediate = setImmediate;
var _clearImmediate = clearImmediate;
process.once('loaded', function() {
global.setImmediate = _setImmediate;
global.clearImmediate = _clearImmediate;
});
```
## プロパティ
### `process.noAsar`
これを`true`に設定すると、Nodeのビルトインモジュールで、`asar`アーカイブのサポートを無効にできます。
## メソッド
`process`オブジェクトは次のめっそどを持ちます。
### `process.hang()`
現在のプロセスがハングしているメインスレッドが原因で発生します。
### `process.setFdLimit(maxDescriptors)` _OS X_ _Linux_
* `maxDescriptors` Integer
現在のプロセスで、`maxDescriptors`またはOSハード制限のどちらか低いほうで、ソフトファイルディスクリプターを設定します。

View file

@ -0,0 +1,43 @@
# shell
`shell`モジュールはデスクトップ統合に関係した機能を提供します。
ユーザーのデフォルトのブラウザでURLを開く例です
```javascript
const shell = require('electron').shell;
shell.openExternal('https://github.com');
```
## メソッド
`shell`モジュールは次のメソッドを持ちます:
### `shell.showItemInFolder(fullPath)`
* `fullPath` String
ファイルマネジャーでファイルを表示します。もし可能ならファイルを選択します。
### `shell.openItem(fullPath)`
* `fullPath` String
デスクトップの既定のやり方で指定したファイルを開きます。
### `shell.openExternal(url)`
* `url` String
デスクトップの既定のやり方で指定した外部のプロトコルURLで開きます。例えば、mailto:URLでユーザーの既定メールエージェントを開きます
### `shell.moveItemToTrash(fullPath)`
* `fullPath` String
ゴミ箱へ指定したファイルを移動し、操作結果をブーリアン値を返します。
### `shell.beep()`
ビープ音を再生します。

View file

@ -0,0 +1,59 @@
# `window.open` 関数
Webページで新しいウィンドウを作成するために`window.open`をコールすると、`url`用の`BrowserWindow`の新しいインスタンスが作成され、プロキシはそれ以上の制御を制限したページを許可する`window.open`を返します。
プロキシは伝統的なウェブページと互換性のある制限された標準的な機能が実装されています。新しいウィンドウの完全な制御のために、直接、`BrowserWindow`を作成する必要があります。
新しく作成された`BrowserWindow`は、既定で、親ウィンドウのオプションを継承し、`features`文字列で設定したオプションを継承しオーバーライドします。
### `window.open(url[, frameName][, features])`
* `url` String
* `frameName` String (optional)
* `features` String (optional)
新しいウィンドウを作成し、`BrowserWindowProxy` クラスのインスタンを返します。
`features`文字列は標準的なブラウザーのフォーマットに従いますが、それぞれの機能は`BrowserWindow`のオプションフィールドである必要があります。
### `window.opener.postMessage(message, targetOrigin)`
* `message` String
* `targetOrigin` String
優先的なオリジンなく特定のオリジンまたは`*`で親ウィンドウにメッセージが送信されます。
## Class: BrowserWindowProxy
`BrowserWindowProxy`オブジェクトは`window.open`から返り、子ウィンドウに制限された機能を提供します。
### `BrowserWindowProxy.blur()`
子ウィンドウからフォーカスを削除します。
### `BrowserWindowProxy.close()`
アンロードイベントをコールせず、強制的に子ウィンドウを閉じます。
### `BrowserWindowProxy.closed`
子ウィンドウがクローズした後、trueを設定します。
### `BrowserWindowProxy.eval(code)`
* `code` String
子ウィンドウでコードを評価します。
### `BrowserWindowProxy.focus()`
前面にウィンドウを出し、子ウィンドウにフォーカスします。
### `BrowserWindowProxy.postMessage(message, targetOrigin)`
* `message` String
* `targetOrigin` String
優先的なオリジンなく特定のオリジンまたは`*`で子ウィンドウにメッセージが送信されます。
それらのメッセージに加え、子ウィンドウはプロパティとシグナルメッセージなしで`window.opener`オブジェクトを実装します。