Add Japanes translated docs.
This commit is contained in:
Takahito Yamatoya
parent
31624995bc
commit
85df3157c7
3 changed files with 337 additions and 0 deletions
88
docs-translations/jp/api/dialog.md
Normal file
88
docs-translations/jp/api/dialog.md
Normal file
|
|
@ -0,0 +1,88 @@
|
|||
# dialog
|
||||
|
||||
`dialog`モジュールは、ファイルやアラートを開くようなネイティブシステムダイアログを表示するためのAPIを提供します。そのため、ネイティブアプリケーションのようにウェブアプリケーションに同じユーザー体験を提供できます。
|
||||
|
||||
複数のファイルやディレクトリを選択するためのダイアログを表示する例です:
|
||||
|
||||
```javascript
|
||||
var win = ...; // BrowserWindow in which to show the dialog
|
||||
const dialog = require('electron').dialog;
|
||||
console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]}));
|
||||
```
|
||||
|
||||
**Note for OS X**: シートとしてダイアログを表示したい場合、唯一しなければならないことは、`browserWindow`パラメーターを参照する`BrowserWindow`を提供することです。
|
||||
|
||||
## メソッド
|
||||
|
||||
`dialog`モジュールは次のメソッドを持っています:
|
||||
|
||||
### `dialog.showOpenDialog([browserWindow, ]options[, callback])`
|
||||
|
||||
* `browserWindow` BrowserWindow (オプション)
|
||||
* `options` Object
|
||||
* `title` String
|
||||
* `defaultPath` String
|
||||
* `filters` Array
|
||||
* `properties` Array - ダイアログが使うべき機能を含め、`openFile`と`openDirectory`、`multiSelections`、`createDirectory`を含められます。
|
||||
* `callback` Function (オプション)
|
||||
|
||||
成功したら、このメソッドはユーザーが選択したファイルパスの配列を返し、さうでなければ`undefined`を返します。
|
||||
|
||||
ユーザーが選択できる種類を制限したいときに、`filters`で表示したり選択できるファイル種別の配列を指定します。
|
||||
|
||||
```javascript
|
||||
{
|
||||
filters: [
|
||||
{ name: 'Images', extensions: ['jpg', 'png', 'gif'] },
|
||||
{ name: 'Movies', extensions: ['mkv', 'avi', 'mp4'] },
|
||||
{ name: 'Custom File Type', extensions: ['as'] },
|
||||
{ name: 'All Files', extensions: ['*'] }
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
`extensions`配列は、ワイルドカードやドットなしで拡張子を指定すべきです（例えば、`'png'`は良いですが、`'.png'` と `'*.png'`はダメです）。すべてのファイルを表示するために、`'*'`ワイルドカードを使用します（それいがいのワイルドカードはサポートしていません）。
|
||||
|
||||
`callback`を通すと、APIは非同期に読み出し、結果は`callback(filenames)`経由で通します。
|
||||
|
||||
**Note:** WindowsとLinuxでは、オープンダイアログがファイル選択とディレクトリ選択の両方を選択することはできません。プラットフォーム上で `properties`に`['openFile', 'openDirectory']`を設定すると、ディレクトリ選択が表示されます。
|
||||
|
||||
### `dialog.showSaveDialog([browserWindow, ]options[, callback])`
|
||||
|
||||
* `browserWindow` BrowserWindow (オプション)
|
||||
* `options` Object
|
||||
* `title` String
|
||||
* `defaultPath` String
|
||||
* `filters` Array
|
||||
* `callback` Function (オプション)
|
||||
|
||||
成功すると、このメソッドはユーザーが選択したファイルのパスが返され、そうでなければ`undefined`が返されます。
|
||||
|
||||
`filters`が表示できるファイル種別配列を指定します。例えば、`dialog.showOpenDialog`を参照してください。
|
||||
|
||||
`callback`を通すと、APIは非同期でコールされ、結果は`callback(filename)`経由で通します。
|
||||
|
||||
### `dialog.showMessageBox([browserWindow, ]options[, callback])`
|
||||
|
||||
* `browserWindow` BrowserWindow (オプション)
|
||||
* `options` Object
|
||||
* `type` String - `"none"`と `"info"`、 `"error"`、 `"question"`、`"warning"`を設定できます。Windowsでは、 "icon"オプションを使用してアイコンを設定しない限り、"question"は"info"として同じアイコンを表示します。
|
||||
* `buttons` Array - ボタン用のテキスト配列。
|
||||
* `defaultId` Integer - メッセージボックスを開くとき、既定で選択されるボタン配列でのボタンインデックスです
|
||||
* `title` String - メッセージボックスのタイトルで、いくつかのプラットフォームでは表示されません。
|
||||
* `message` String - メッセージボックスのコンテンツ。
|
||||
* `detail` String - メッセージの外部情報
|
||||
* `icon` [NativeImage](native-image.md)
|
||||
* `cancelId` Integer - ダイアログのボタンをクリックする代わりにユーザーがダイアログをキャンセルしたときに返す値です。既定では、ラベルの "cancel"や"no"を持つボタンのインデックスまたは、そのようなボタンが無ければ0を返します。OS XやWindowsでは、 すでに指定されているかどうかは関係なく、"Cancel"ボタンのインデックスはいつでも `cancelId`が使われます。
|
||||
* `noLink` Boolean - Windowsでは、Electronは、 ("Cancel" または "Yes"のような)共通ボタンである`buttons`の一つを見つけようとし、ダイアログ内のコマンドリンクとして表示します。この挙動が気に入らない場合は、 `noLink` を `true`に設定できます。
|
||||
* `callback` Function
|
||||
|
||||
メッセージボックスを表示し、メッセージボックスが閉じるまでプロセスをブロックします。クリックされたボタンのインデックスを返します。
|
||||
|
||||
`callback`が通されると、APIは非同期にコールし、結果は`callback(response)`経由で通されます。
|
||||
|
||||
### `dialog.showErrorBox(title, content)`
|
||||
|
||||
エラーメッセージを表示するモデルダイアログを表示します。
|
||||
|
||||
`app`モジュールが`ready`イベントを出力する前に、このAPIは安全にコールできます。スタートアップの早い段階でエラーを報告するのに通常は使われます。Linuxで、アプリの`ready`イベントの前にコールすると、メッセージは標準エラーに出力され、GUIダイアログは表示されません。
|
||||
50
docs-translations/jp/api/menu-item.md
Normal file
50
docs-translations/jp/api/menu-item.md
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
# MenuItem
|
||||
|
||||
`menu-item`モジュールは、アプリケーションまたはコンテキスト[`メニュー`](menu.md)に項目を追加することができます。
|
||||
|
||||
具体例は、 [`menu`](menu.md) を見てください。
|
||||
|
||||
## クラス: MenuItem
|
||||
|
||||
次のメソッドで、新しい`MenuItem`を作成します。
|
||||
|
||||
### new MenuItem(options)
|
||||
|
||||
* `options` Object
|
||||
* `click` Function - メニューアイテムがクリックされたとき、`click(menuItem, browserWindow)`がコールされます。
|
||||
* `role` String - 指定されたとき、メニューアイテムの動作が定義され、`click`プロパティは無視されます。
|
||||
* `type` String - `normal`と `separator`、`submenu`、`checkbox`、`radio`を指定できます。
|
||||
* `label` String
|
||||
* `sublabel` String
|
||||
* `accelerator` [Accelerator](accelerator.md)
|
||||
* `icon` [NativeImage](native-image.md)
|
||||
* `enabled` Boolean
|
||||
* `visible` Boolean
|
||||
* `checked` Boolean
|
||||
* `submenu` Menu - メニューアイテムを省略できる`type: 'submenu'`を指定したとき、`submenu`種類のメニューアイテムを指定すべきです。値が`Menu`でないとき、`Menu.buildFromTemplate`を使用して自動的に変換されます。
|
||||
* `id` String - 1つのメニュー内で一意です。定義されていたら、position属性によってアイテムへの参照として使用できます。
|
||||
* `position` String - このフィールドは、指定されたメニュー内の特定の位置を細かく定義できます。
|
||||
|
||||
メニューアイテムを作成するとき、適切な動作がある場合は、メニューでベストな自然な体験を提供するために、手動で実装する代わりに`role`を指定することを推奨します。
|
||||
|
||||
`role` プロパティは次の値を持ちます:
|
||||
|
||||
* `undo`
|
||||
* `redo`
|
||||
* `cut`
|
||||
* `copy`
|
||||
* `paste`
|
||||
* `selectall`
|
||||
* `minimize` - 現在のウィンドウの最小化
|
||||
* `close` - 現在のウィンドウを閉じます
|
||||
|
||||
OS Xでは、`role`は次の追加の値を取れます:
|
||||
|
||||
* `about` - `orderFrontStandardAboutPanel`動作に紐づけられます
|
||||
* `hide` - `hide`動作に紐づけられます
|
||||
* `hideothers` - `hideOtherApplications`動作に紐づけられます
|
||||
* `unhide` - `unhideAllApplications`動作に紐づけられます
|
||||
* `front` - `arrangeInFront`動作に紐づけられます
|
||||
* `window` - サブメニューは "Window"メニューです。
|
||||
* `help` - サブメニューは "Help"メニューです。
|
||||
* `services` - サブメニューは "Services"メニューです。
|
||||
199
docs-translations/jp/api/tray.md
Normal file
199
docs-translations/jp/api/tray.md
Normal file
|
|
@ -0,0 +1,199 @@
|
|||
# Tray
|
||||
|
||||
`Tray`は、オペレーティングシステムの通知エリアでアイコンで表示され、通常コンテキストメニューが付随します。
|
||||
|
||||
```javascript
|
||||
const electron = require('electron');
|
||||
const app = electron.app;
|
||||
const Menu = electron.Menu;
|
||||
const Tray = electron.Tray;
|
||||
|
||||
var appIcon = null;
|
||||
app.on('ready', function(){
|
||||
appIcon = new Tray('/path/to/my/icon');
|
||||
var contextMenu = Menu.buildFromTemplate([
|
||||
{ label: 'Item1', type: 'radio' },
|
||||
{ label: 'Item2', type: 'radio' },
|
||||
{ label: 'Item3', type: 'radio', checked: true },
|
||||
{ label: 'Item4', type: 'radio' }
|
||||
]);
|
||||
appIcon.setToolTip('This is my application.');
|
||||
appIcon.setContextMenu(contextMenu);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
__プラットフォームの制限:__
|
||||
|
||||
* Linuxでは、サポートしている場合アプリインディケーターが使われ、サポートされていなければ代わりに`GtkStatusIcon`が使われます。
|
||||
* アプリインディケーターを持っているLinuxディストリビューションでは、トレイアイコンを動作させるために`libappindicator1`をインストールする必要があります。
|
||||
* コンテキストメニューがあるときは、インディケーターのみが表示されます。
|
||||
* アプリインディケーターがLinuxで使われると、`click`イベントは無視されます。
|
||||
|
||||
すべてのプラットフォームで正確に同じ挙動を維持したい場合は、`click`イベントに依存せず、常にトレイアイコンにコンテキストメニューを付随させるようにします。
|
||||
|
||||
## クラス: Tray
|
||||
|
||||
`Tray`は[EventEmitter][event-emitter]です。
|
||||
|
||||
### `new Tray(image)`
|
||||
|
||||
* `image` [NativeImage](native-image.md)
|
||||
|
||||
`image`で新しいトレイアイコンを作成します。
|
||||
|
||||
## イベント
|
||||
|
||||
`Tray`モジュールは次のイベントを出力します。
|
||||
|
||||
**Note:** いくつかのイベントは、特定のオペレーティングシステム向けに提供され、そのようにラベルで表示します。
|
||||
|
||||
### イベント: 'click'
|
||||
|
||||
* `event` Event
|
||||
* `altKey` Boolean
|
||||
* `shiftKey` Boolean
|
||||
* `ctrlKey` Boolean
|
||||
* `metaKey` Boolean
|
||||
* `bounds` Object - トレイアイコンのバウンド
|
||||
* `x` Integer
|
||||
* `y` Integer
|
||||
* `width` Integer
|
||||
* `height` Integer
|
||||
|
||||
トレイアイコンがクリックされたときに出力されます。
|
||||
|
||||
__Note:__ `バウンド` 再生はOS XとWindoesのみで実装されています。
|
||||
|
||||
### イベント: 'right-click' _OS X_ _Windows_
|
||||
|
||||
* `event` Event
|
||||
* `altKey` Boolean
|
||||
* `shiftKey` Boolean
|
||||
* `ctrlKey` Boolean
|
||||
* `metaKey` Boolean
|
||||
* `bounds` Object - トレイアイコンのバウンド
|
||||
* `x` Integer
|
||||
* `y` Integer
|
||||
* `width` Integer
|
||||
* `height` Integer
|
||||
|
||||
トレイアイコンが右クリックされると出力されます。
|
||||
|
||||
### イベント: 'double-click' _OS X_ _Windows_
|
||||
|
||||
* `event` Event
|
||||
* `altKey` Boolean
|
||||
* `shiftKey` Boolean
|
||||
* `ctrlKey` Boolean
|
||||
* `metaKey` Boolean
|
||||
* `bounds` Object - トレイアイコンのバウンド
|
||||
* `x` Integer
|
||||
* `y` Integer
|
||||
* `width` Integer
|
||||
* `height` Integer
|
||||
|
||||
トレイアイコンがダブルクリックされたら出力されます。
|
||||
|
||||
### イベント: 'balloon-show' _Windows_
|
||||
|
||||
トレイバルーンを表示したときに出力されます。
|
||||
|
||||
### イベント: 'balloon-click' _Windows_
|
||||
|
||||
トレイバルーンがクリックされたときに出力されます。
|
||||
|
||||
### イベント: 'balloon-closed' _Windows_
|
||||
|
||||
タイムアウトもしくはユーザーの操作で閉じて、トレイバルーンがクロースされたときに出力されます。
|
||||
|
||||
### イベント: 'drop' _OS X_
|
||||
|
||||
トレイアイコンでアイテムがドラグアンドドロップされたときに出力されます。
|
||||
|
||||
### イベント: 'drop-files' _OS X_
|
||||
|
||||
* `event`
|
||||
* `files` Array - ドロップされたアイテムのフルパス
|
||||
|
||||
トレイアイコンでファイルがドロップされたときに出力されます。
|
||||
|
||||
### イベント: 'drag-enter' _OS X_
|
||||
|
||||
トレイアイコンにドラッグ操作が入ったときに出力されます。
|
||||
|
||||
### イベント: 'drag-leave' _OS X_
|
||||
|
||||
トレイアイコンででドラッグ操作が行われたときに出力されます。
|
||||
|
||||
### イベント: 'drag-end' _OS X_
|
||||
|
||||
トレイ上でドラッグ操作が終了したか、ほかの場所で終了したときに出力されます。
|
||||
|
||||
## Methods
|
||||
|
||||
`Tray`モジュールは次のメソッドを持ちます。
|
||||
|
||||
**Note:** いくつかのメソッドは、特定のオペレーティングシステム向けに提供され、そのようにラベルで表示します。
|
||||
|
||||
### `Tray.destroy()`
|
||||
|
||||
ただちにトレイアイコンを終了します。
|
||||
|
||||
### `Tray.setImage(image)`
|
||||
|
||||
* `image` [NativeImage](native-image.md)
|
||||
|
||||
トレイアイコンの`image`を設定します。
|
||||
|
||||
### `Tray.setPressedImage(image)` _OS X_
|
||||
|
||||
* `image` [NativeImage](native-image.md)
|
||||
|
||||
OS Xで押されたときにトレイアイコンの`image`を設定します。
|
||||
|
||||
### `Tray.setToolTip(toolTip)`
|
||||
|
||||
* `toolTip` String
|
||||
|
||||
トレイアイコン用のホバーテキストを設定します。
|
||||
|
||||
### `Tray.setTitle(title)` _OS X_
|
||||
|
||||
* `title` String
|
||||
|
||||
ステータスバーで、トレイアイコンのわきに表示するタイトルを設定します。
|
||||
|
||||
### `Tray.setHighlightMode(highlight)` _OS X_
|
||||
|
||||
* `highlight` Boolean
|
||||
|
||||
トレイアイコンがクリックされた時、トレイアイコンの背景をハイライト（青色）するかどうかを設定します。既定ではTrueです。
|
||||
|
||||
### `Tray.displayBalloon(options)` _Windows_
|
||||
|
||||
* `options` Object
|
||||
* `icon` [NativeImage](native-image.md)
|
||||
* `title` String
|
||||
* `content` String
|
||||
|
||||
トレイバルーンを表示します。
|
||||
|
||||
### `Tray.popUpContextMenu([menu, position])` _OS X_ _Windows_
|
||||
|
||||
* `menu` Menu (optional)
|
||||
* `position` Object (optional) - ポップアップ位置
|
||||
* `x` Integer
|
||||
* `y` Integer
|
||||
|
||||
トレイアイコンのコンテキストメニューをポップアップします。`menu`が渡されたとき、`menu`はトレイコンテキストメニューの代わりに表示されます。
|
||||
|
||||
`position`はWindowsのみで提供され、既定では(0, 0) です。
|
||||
|
||||
### `Tray.setContextMenu(menu)`
|
||||
|
||||
* `menu` Menu
|
||||
|
||||
アイコン用のコンテキストメニューを設定します。
|
||||
|
||||
[event-emitter]: http://nodejs.org/api/events.html#events_class_events_eventemitter
|
||||
Loading…
Reference in a new issue