TOP/拡張スクリプト/FileDialog クラス

FileDialog クラス

概要

ファイル選択ダイアログボックスを使用する為のクラスになります。 継承関係は以下のようになっています。

また、このクラスのプロパティで設定する特定の拡張子だけを表示するためのフィルタを表すFileDialog::Filter クラスもあります。

FileDialog クラス

このクラスを継承する OpenFileDialogSaveFileDialog の共通部分を処理するクラスとなっています。

コンストラクタ

constructor()

インスタンスを作成します。

プロパティ

multiselect -> boolean

ダイアログにてファイルを複数選択できるかどうかの真偽値です。

filters -> [FileDialog::Filter]

後述する FileDialog::Filter の配列です。 この値によってファイル選択ダイアログにて特定の拡張子のみを表示するのを設定できます。

file_name -> string

show_dialog 関数実行時にこのプロパティに指定したパスで初期に選択されているファイルを指定できます。

show_dialog 関数実行後はこのプロパティにユーザが指定したパスが格納されています。

file_names -> [string]

multiselect が真の場合に show_dialog 関数を実行した場合はこちらが file_name の代わりにユーザが選択したパスの配列になります。

FileDialog::Filter クラス

ダイアログにて設定する特定の拡張子だけを表示するためのフィルタを表すクラスになります。

全てのファイル(*.*) みたいなのを見かける事が多いかと思いますがそれになります。

コンストラクタ

constructor( description, extensions )

description は string 、extensions は string か array です。 extensions は string の場合はその string 1つの array の扱いになります。

インスタンスのプロパティ description を引数 description で、プロパティ extensions を引数 extensions で初期化します。

以下は例になります。

dialog.filters.append( FileDialog.Filter( "wav ファイル(*.wav)", ["*.wav"] ) );
dialog.filters.append( FileDialog.Filter( "bms 系ファイル(*.bms,*.bme)", ["*.bms", "*.bme"] ) );
dialog.filters.append( FileDialog.Filter( "全てのファイル(*.*)", "*.*" ) );

プロパティ

description -> string

フィルタの説明文になります。

extensions -> [string]

実際にフィルタする拡張子の配列になります。

OpenFileDialog クラス

「ファイルを開く」用のファイル選択ダイアログボックスの為のクラスです。

コンストラクタ

constructor()

インスタンスを作成します。

関数

show_dialog() -> boolean

「ファイルを開く」用のファイル選択ダイアログボックスを表示します。

各種プロパティで設定された値を使ってダイアログが設定されます。

ユーザが OK ボタンを押した場合 true が返却されます。 キャンセルされた場合は false が返却されます。

SaveFileDialog クラス

「名前を付けて保存」用のファイル選択ダイアログボックスの為のクラスです。

コンストラクタ

constructor()

インスタンスを作成します。

関数

show_dialog() -> boolean

「名前を付けて保存」用のファイル選択ダイアログボックスを表示します。

各種プロパティで設定された値を使ってダイアログが設定されます。

ユーザが OK ボタンを押した場合 true が返却されます。 キャンセルされた場合は false が返却されます。

TOP/拡張スクリプト/FileDialog クラス