atom-shellではよく使うであろう、ダイアログモジュールのAPiの翻訳です。
ダイアログ
dialog
モジュールはネイティブシステムのダイアログを表示するAPIを提供します。
Webアプリケーションはネイティブアプリケーションと同じユーザー体験を提供することができます。
以下はダイアログを表示し複数のファイルやディレクトリを選択する例です。
var win = ...; //ダイアログを表示するウィンドウ
var dialog = require('dialog');
console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]}));
Note for OS X: もしシートのようなダイアログを表示したいなら、BrowserWindowの参照をbrowserWindow引数に与えるだけでよいです。
dialog.showOpenDialog([browserWindow], [options], [callback])
-
browserWindow
ブラウザウィンドウ -
options
Object オプション-
title
String -
defaultPath
String -
filters
Array -
properties
Array - どの機能をダイアログが使うべきかを含む、以下が使用できる。openFile
,openDirectory
,multiSelections
andcreateDirectory
-
-
callback
Function
成功時にはユーザーが選択したファイルパスの配列を返却する、そうでない場合はundefined
を返却する。
filters
は表示や選択ができるファイルの種類を決めます。
以下に例を書きます。
{
filters: [
{ name: 'Images', extensions: ['jpg', 'png', 'gif'] },
{ name: 'Movies', extensions: ['mkv', 'avi', 'mp4'] },
{ name: 'Custom File Type', extensions: ['as'] },
],
}
もし callback
が引数として渡された場合, the APIの呼び出しは非同期になり、callback(filenames)
によって結果が返却されます。
Note: Windows や Linuxではオープンダイアログはファイル選択とディレクトリ選択は同時にできません。
もし、これらのプラットフォームで['openFile', 'openDirectory']`を指定した場合はディレクトリ選択のほうが適用されます。
dialog.showSaveDialog([browserWindow], [options], [callback])
-
browserWindow
ブラウザウィンドウ -
options
Object-
title
String -
defaultPath
String -
filters
Array
-
-
callback
Function
成功した場合はユーザーが選択したファイルのパスを返却し、それ以外の場合はundefined
を返却します。
filters
は見ることができるファイルの種類を特定します。
dialog.showOpenDialog
の例を見てみましょう。
もし callback
が引数として渡された場合, the APIの呼び出しは非同期になり、callback(filenames)
によって結果が返却されます。
dialog.showMessageBox([browserWindow], options, [callback])
-
browserWindow
ブラウザウィンドウ -
options
Object-
type
String -"none"
,"info"
,"warning"
より選べます。 -
buttons
Array - ボタンのための文字列の配列 -
title
String - メッセージボックスのタイトル, プラットフォームによっては表示されないものがあります。 -
message
String - メッセージボックスの内容 -
detail
String - メッセージの追加情報 -
icon
NativeImage
-
-
callback
Function
メッセージボックスを表示し、メッセージボックスが閉じられるまでブロックします。
クリックしたボタンのインデックスを返却します。
もしcallback
が引数に渡された場合, API 呼び出しは非同期となり、
結果は callback(response)
を通じて返却されます。
dialog.showErrorBox(title, content)
エラーメッセージを表示するモーダルダイアログを表示します。
このAPIはよくスタートアップの早い段階で利用されるため、
app
のready
イベントを放つ前に安全に呼ぶことができます。