Skip to content

Commit af3def9

Browse files
committed
Merge pull request electron#4146 from yamatoya/master
Add Japanes translated docs.
2 parents 01e1d0d + 140bc4e commit af3def9

File tree

6 files changed

+503
-0
lines changed

6 files changed

+503
-0
lines changed

docs-translations/jp/api/clipboard.md

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# clipboard
2+
3+
`clipboard`モジュールは、コピーとペースト操作を実行するメソッドを提供します。次の例は、クリップボードに文字列を書き込む方法を示しています:
4+
5+
```javascript
6+
const clipboard = require('electron').clipboard;
7+
clipboard.writeText('Example String');
8+
```
9+
10+
X Windowsシステム上では、セレクションクリップボードがあります。それを操作するために、それぞれのメソッドで、`selection`を通す必要があります。
11+
12+
```javascript
13+
clipboard.writeText('Example String', 'selection');
14+
console.log(clipboard.readText('selection'));
15+
```
16+
17+
## メソッド
18+
19+
`clipboard`モジュールには、次のメソッドがあります:
20+
21+
**Note:** 実験的APIには、そのようにマークしてあり、将来的には削除される可能性があります。
22+
23+
### `clipboard.readText([type])`
24+
25+
* `type` String (optional)
26+
27+
プレーンテキストとしてクリップボードの内容を返します。
28+
29+
### `clipboard.writeText(text[, type])`
30+
31+
* `text` String
32+
* `type` String (optional)
33+
34+
プレーンテキストとしてクリップボードに`text`を書き込みます。
35+
36+
### `clipboard.readHtml([type])`
37+
38+
* `type` String (optional)
39+
40+
HTMLマークアップとして、クリップボードの内容を返します。
41+
42+
### `clipboard.writeHtml(markup[, type])`
43+
44+
* `markup` String
45+
* `type` String (optional)
46+
47+
クリップボードにHTMLマークアップとして書き込みます。
48+
49+
### `clipboard.readImage([type])`
50+
51+
* `type` String (optional)
52+
53+
[NativeImage](native-image.md)としてクリップボードの内容を返します。
54+
55+
### `clipboard.writeImage(image[, type])`
56+
57+
* `image` [NativeImage](native-image.md)
58+
* `type` String (optional)
59+
60+
`image` としてクリップボードに書き込みます。
61+
62+
### `clipboard.clear([type])`
63+
64+
* `type` String (optional)
65+
66+
クリップボードの内容をクリアします。
67+
68+
### `clipboard.availableFormats([type])`
69+
70+
* `type` String (optional)
71+
72+
`type`のクリップボードがサポートしているフォーマット配列を返します。
73+
74+
### `clipboard.has(data[, type])` _実験_
75+
76+
* `data` String
77+
* `type` String (optional)
78+
79+
`data`で指定したフォーマットをクリップボードがサポートしているかどうかを返します。
80+
81+
```javascript
82+
console.log(clipboard.has('<p>selection</p>'));
83+
```
84+
85+
### `clipboard.read(data[, type])` _実験_
86+
87+
* `data` String
88+
* `type` String (optional)
89+
90+
クリップボードから`data`を読み込みます。
91+
92+
### `clipboard.write(data[, type])`
93+
94+
* `data` Object
95+
* `text` String
96+
* `html` String
97+
* `image` [NativeImage](native-image.md)
98+
* `type` String (optional)
99+
100+
```javascript
101+
clipboard.write({text: 'test', html: "<b>test</b>"});
102+
```
103+
クリップボードに`data`を書き込みます。
+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# crashReporter
2+
3+
`crash-reporter`モジュールはアプリのクラッシュレポートを送信することができます。
4+
5+
リモートサーバーに自動的にクラッシュレポートを登録する例です。
6+
7+
```javascript
8+
const crashReporter = require('electron').crashReporter;
9+
10+
crashReporter.start({
11+
productName: 'YourName',
12+
companyName: 'YourCompany',
13+
submitURL: 'https://your-domain.com/url-to-submit',
14+
autoSubmit: true
15+
});
16+
```
17+
18+
## メソッド
19+
20+
`crash-reporter`モジュールは次のメソッドを持ちます:
21+
22+
### `crashReporter.start(options)`
23+
24+
`options` Object, properties:
25+
26+
* `productName` String, デフォルト: Electron.
27+
* `companyName` String (**必須**)
28+
* `submitURL` String, (**必須**)
29+
* クラッシュレポートがPOSTで送信されるURL
30+
* `autoSubmit` Boolean, デフォルト: `true`.
31+
* ユーザーの判断なくクラッシュレポートを送信します
32+
* `ignoreSystemCrashHandler` Boolean, デフォルト: `false`.
33+
* `extra` Object
34+
* あなたが定義できるオブジェクトは、レポートと一緒に送信されます。
35+
* 文字列プロパティのみが正しく送信されます。
36+
* オブジェクトのネストはサポートしていません。
37+
38+
他の`crashReporter`APIを使用する前にこのメソッドをコールする必要があります。
39+
40+
**Note:** OS Xでは、Electronは、WindowsとLinux上の`breakpad` とは異なる、新しい`crashpad`クライアントを使用します。クラッシュ収集機能を有効にするために、メインプロセスや、クラッシュレポートを収集したいそれぞれのレンダラープロセスで、`crashpad`を初期化するために`crashReporter.start`APIをコールする必要があります。
41+
42+
### `crashReporter.getLastCrashReport()`
43+
44+
日付と最後のクラッシュレポートのIDを返します。もしなんのクラッシュレポートも送信されていないか、クラッシュレポーターが起動していない場合、`null`を返します。
45+
46+
### `crashReporter.getUploadedReports()`
47+
48+
滑ってのアップロードされたクラッシュレポートが返されます。それぞれのレポートには日付とアップロードされたIDが含まれます。
49+
50+
## crash-reporter Payload
51+
52+
クラッシュレポーターは`POST``submitURL` に次のデーターが送信されます。
53+
54+
* `ver` String - Electronのバージョン
55+
* `platform` String - 例: 'win32'.
56+
* `process_type` String - 例: 'renderer'.
57+
* `guid` String - 例: '5e1286fc-da97-479e-918b-6bfb0c3d1c72'
58+
* `_version` String - `package.json`でのバージョン
59+
* `_productName` String - `crashReporter`でのプロダクト名 `オプション`
60+
object.
61+
* `prod` String - 基盤となる製品の名前。この場合は、Electronです。
62+
* `_companyName` String - `crashReporter`での会社名 `オプション`
63+
object.
64+
* `upload_file_minidump` File - ファイル形式のクラッシュレポート
65+
* `crashReporter`での`extra`オブジェクトのすべてのレベル1のプロパティ
66+
`オプション` object
+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# DownloadItem
2+
3+
`DownloadItem`は、Electronでアイテムのダウンロードを示すEventEmitterです。 `Session`モジュールの`will-download`イベントで使用され、ダウンロードしたアイテムをコントロールすることができます。
4+
5+
```javascript
6+
// In the main process.
7+
win.webContents.session.on('will-download', function(event, item, webContents) {
8+
// Set the save path, making Electron not to prompt a save dialog.
9+
item.setSavePath('/tmp/save.pdf');
10+
console.log(item.getMimeType());
11+
console.log(item.getFilename());
12+
console.log(item.getTotalBytes());
13+
item.on('updated', function() {
14+
console.log('Received bytes: ' + item.getReceivedBytes());
15+
});
16+
item.on('done', function(e, state) {
17+
if (state == "completed") {
18+
console.log("Download successfully");
19+
} else {
20+
console.log("Download is cancelled or interrupted that can't be resumed");
21+
}
22+
});
23+
```
24+
25+
## イベント
26+
27+
### イベント: 'updated'
28+
29+
`downloadItem`が更新されたときに出力されます。
30+
31+
### イベント: 'done'
32+
33+
* `event` Event
34+
* `state` String
35+
* `completed` - ダウンロードが成功で完了
36+
* `cancelled` - ダウンロードをキャンセル
37+
* `interrupted` - ファイルサーバーとの接続が切れてエラー
38+
39+
ダウンロードが終了状態になったときに出力されます。終了状態には、ダウンロードの完了、ダウンロードのキャンセル(`downloadItem.cancel()`経由)、レジュームできないダウンロードの中断などです。
40+
41+
## メソッド
42+
43+
`downloadItem`オブジェクトは次のメソッドを持ちます:
44+
45+
### `downloadItem.setSavePath(path)`
46+
47+
* `path` String - ダウンロードアイテムの保存ファイルパスを設定します。
48+
49+
APIはセッションの`will-download`コールバック関数のみで提供されます。API経由で保存パスを設定しなかった場合、Electronは保存パスを決めるための元のルーチン(通常は保存ダイアログ)を使用します。
50+
51+
### `downloadItem.pause()`
52+
53+
ダウンロードをポーズします。
54+
55+
### `downloadItem.resume()`
56+
57+
ポーズしたダウンロードを再開します。
58+
59+
### `downloadItem.cancel()`
60+
61+
ダウンロード操作をキャンセルします。
62+
63+
### `downloadItem.getURL()`
64+
65+
どのURLからアイテムをダウンロードするのかを示す`String`を返します。
66+
67+
### `downloadItem.getMimeType()`
68+
69+
mimeタイプを示す`String`を返します。
70+
71+
### `downloadItem.hasUserGesture()`
72+
73+
ダウンロードがユーザージェスチャーを持っているかどうかを示す`Boolean`を返します。
74+
75+
### `downloadItem.getFilename()`
76+
77+
ダウンロードアイテムのファイル名を示す`String`を返します。
78+
79+
**Note:** ファイル名はローカルディスクに実際に保存するものといつも同じとは限りません。ダウンロード保存ダイアログでユーザーがファイル名を変更していると、保存するファイルの実際の名前は異なります。
80+
81+
### `downloadItem.getTotalBytes()`
82+
83+
ダウンロードアイテムの合計バイトサイズを示す`Integer`を返します。
84+
サイズが不明な場合、0を返します。
85+
86+
### `downloadItem.getReceivedBytes()`
87+
88+
ダウンロードしたアイテムの受信バイト数を示す`Integer`を返します。
89+
90+
### `downloadItem.getContentDisposition()`
91+
92+
レスポンスヘッダーからContent-Dispositionを示す`String`を返します。
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# 環境変数
2+
3+
コマンドラインやアプリのコードよりも早く初期化されるために、Electronのいくつかの挙動は環境変数がコントロールしています。
4+
5+
POSIX shellでの例:
6+
7+
```bash
8+
$ export ELECTRON_ENABLE_LOGGING=true
9+
$ electron
10+
```
11+
12+
Windows コンソール上:
13+
14+
```powershell
15+
> set ELECTRON_ENABLE_LOGGING=true
16+
> electron
17+
```
18+
19+
## `ELECTRON_RUN_AS_NODE`
20+
21+
通常のNode.jsプロセスでプロセスを開始します。
22+
23+
## `ELECTRON_ENABLE_LOGGING`
24+
25+
Chromeのインターナルログをコンソールに出力します。
26+
27+
## `ELECTRON_ENABLE_STACK_DUMPING`
28+
29+
Electronがクラッシュしたとき、コンソールにスタックとレースを出力します。
30+
`crashReporter`が開始していないと、この環境変数は動作しません。
31+
32+
## `ELECTRON_DEFAULT_ERROR_MODE` _Windows_
33+
34+
Electronがクラッシュしたとき、Windowsのクラッシュダイアログを表示します。
35+
`crashReporter`が開始していないと、この環境変数は動作しません。
36+
37+
## `ELECTRON_NO_ATTACH_CONSOLE` _Windows_
38+
39+
現在のコンソールセッションにはアタッチできません。
40+
41+
## `ELECTRON_FORCE_WINDOW_MENU_BAR` _Linux_
42+
43+
Linuxでグローバルメニューバーを使用できません。
44+
45+
## `ELECTRON_HIDE_INTERNAL_MODULES`
46+
47+
`require('ipc')`のような古い組み込みモジュールとの互換モードを無効にします。
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# globalShortcut
2+
3+
さまざまなショートカットの動作をカスタマイズするために、オペレーティングシステムのグローバルのキーボードショートカットを`globalShortcut`モジュールは登録したり、解除したりできます。
4+
5+
**Note:** ショートカットはグローバルです。アプリがキーボードフォーカスを持っていなくても動作します。`app`モジュールの `ready`イベントが出力されるまでは使うべきではありません。
6+
7+
```javascript
8+
const electron = require('electron');
9+
const app = electron.app;
10+
const globalShortcut = electron.globalShortcut;
11+
12+
app.on('ready', function() {
13+
// Register a 'ctrl+x' shortcut listener.
14+
var ret = globalShortcut.register('ctrl+x', function() {
15+
console.log('ctrl+x is pressed');
16+
});
17+
18+
if (!ret) {
19+
console.log('registration failed');
20+
}
21+
22+
// Check whether a shortcut is registered.
23+
console.log(globalShortcut.isRegistered('ctrl+x'));
24+
});
25+
26+
app.on('will-quit', function() {
27+
// Unregister a shortcut.
28+
globalShortcut.unregister('ctrl+x');
29+
30+
// Unregister all shortcuts.
31+
globalShortcut.unregisterAll();
32+
});
33+
```
34+
35+
## メソッド
36+
37+
`globalShortcut`モジュールは次のメソッドを持ちます:
38+
39+
### `globalShortcut.register(accelerator, callback)`
40+
41+
* `accelerator` [Accelerator](accelerator.md)
42+
* `callback` Function
43+
44+
`accelerator`のグローバルショートカットを登録します。`callback`は、ユーザーが登録しているショートカットを押したときにコールされます。
45+
46+
ほかのアプリケーションがすでにacceleratorを使用している時、この呼び出しは静かに失敗します。アプリケーション間でグローバルショートカットの争いをしてほしくないので、オペレーティングシステムはこの挙動を採用しています。
47+
48+
### `globalShortcut.isRegistered(accelerator)`
49+
50+
* `accelerator` [Accelerator](accelerator.md)
51+
52+
このアプリケーションが`accelerator`に登録されているかどうかを返します。
53+
54+
acceleratorがすでにほかのアプリケーションで取得していると、このコールは、`false`を返します。アプリケーション間でグローバルショートカットの争いをしてほしくないので、オペレーティングシステムはこの挙動を採用しています。
55+
56+
### `globalShortcut.unregister(accelerator)`
57+
58+
* `accelerator` [Accelerator](accelerator.md)
59+
60+
Unregisters the global shortcut of `accelerator`のグローバルショートカットを解除します。
61+
62+
### `globalShortcut.unregisterAll()`
63+
64+
全てのグローバルショートカットを解除します。

0 commit comments

Comments
 (0)