view モジュール

view モジュールは、描画操作を行う関数を管理するモジュールです。

モジュール名

cri.atomcraft.view

次の関数が定義されています。

関数 説明 操作オブジェクト
get_file_path_with_dialog ファイルパスを取得します -
show_dialog ダイアログ表示を行います -



get_file_path_with_dialog

ダイアログを使って選択したファイルのパスを取得します。
入力引数 mode には、表示したいダイアログの種類を指定します。"open"と"save"の2つのmodeがあります。

  • "open": ファイル読み込み用ダイアログ
  • "save": ファイル保存用ダイアログ

入力引数 suffix には、ファイルの拡張子を指定します。以下の3つの指定の仕方があります。

  1. "csv", "txt" などの拡張子のみの指定
  2. "Image (*.png, *.jpg)" などの 種類の名前+ワイルドカード+拡張子
  3. "Images (*.png *.xpm *.jpg);;Text files (*.txt);;XML files (*.xml)" などの複合的な指定

入力引数 folder_pathには、ダイアログで開くフォルダのパスを指定します。引数を省略した場合、Documentsフォルダをダイアログで開きます。

この関数は Ver.3.46.04 から追加されました。

注意
本関数は、コンソール実行時は使用できません。

書式

result = get_file_path_with_dialog(mode, suffix, folder_path = "")

入力パラメーター

名前
modeダイアログの種別
suffixダイアログ上で選択するファイルの拡張子
folder_pathダイアログで開くデフォルトフォルダ

戻り値

名前
result [ "succeed" ] 成功した場合は True, 失敗した場合は False
result [ "data" ] 選択ファイルパスの文字列



show_dialog

ダイアログ表示を行います。

criatom_tools_atomcraft_api_view_show_dialog.png

ダイアログには、クリップボードへのコピーが可能なテキスト領域と、3つまでのボタンが用意されています。
入力引数 message には、表示したい文を指定します。改行は \n と記述します。
入力引数 button_name_list には、ボタンのテキストをリストで指定します。ボタンは最大3つまでです。

  • (例1) 「はい・いいえ・キャンセル」という3つのボタンを用意したい場合は button_name_list["はい", "いいえ", "キャンセル"] を指定します。
  • (例2) OKボタンのみでよい場合は button_name_list["OK"] を指定します。

戻り値は連想配列で与えられます。
連想配列には button_indexbutton_name の2つのキーが含まれます。
button_index キーの値は、押下したボタンのインデックスです。(インデックスは0始まりです。)
button_name キーの値は、押下したボタンのテキストです。
×ボタンを押すなどによりダイアログを閉じた場合、インデックスと名前はそれぞれ -1 と空文字になります。

この関数は Ver.3.45.00 から追加されました。

注意
本関数は、コンソール実行時は使用できません。

書式

result = show_dialog(message, button_name_list)

入力パラメーター

名前
message表示したいテキスト
button_name_listボタン名のリスト(最大3つまで)

戻り値

名前
result [ "succeed" ] 成功した場合は True, 失敗した場合は False
result [ "data" ] button_index, button_name をキーに持つ連想配列
result [ "data" ][ "button_index" ] 押下したボタンのインデックス(0始まり)
押下していない場合、-1
result [ "data" ][ "button_name" ] 押下したボタンのテキスト