tkLauncherApp プログラム仕様

概要:

tkLauncherApp は、Pythonスクリプトランチャー機能を提供するTkinterアプリケーションです。

詳細説明:

このモジュールは、tkApplication_GUIを継承し、スクリプトの実行、設定の管理、 各種ダイアログの表示、ファイルの操作など、幅広い機能を提供します。 ユーザーはINIファイルを介してアプリケーションの動作をカスタマイズでき、 スクリプト変数を介してスクリプトとアプリケーション間でデータをやり取りできます。

主な機能:

• スクリプト変数の設定と管理

• OSパス区切り文字の自動変換

• INIファイルの読み書き

• ファイル/ディレクトリ選択ダイアログの表示

• カスタムダイアログ、選択ダイアログ、入力ダイアログの表示

• ツールチップとコンテキストメニューの管理

• ウィンドウ状態の制御 (最小化、最大化、最前面表示など)

• ファイルの検索とリスト取得

関連リンク:

tkLauncherApp_usage

class Launcher.tkLauncherApp.tkLauncherApp(**args)

ベースクラス: tkApplication_GUI

概要:

Pythonスクリプトの実行と管理を行うためのGUIアプリケーションクラスです。

詳細説明:

tkApplication_GUIを継承し、スクリプト変数の設定、INIファイルの操作、 各種ダイアログの表示、GUI要素へのツールチップやコンテキストメニューの追加、 ウィンドウ状態の制御など、ランチャーアプリケーションとして必要な機能を提供します。

引数:

param args:

アプリケーション初期化のためのキーワード引数。

type args:

dict

add_context_menu(args)

概要:

指定されたウィジェットにコンテキストメニューをバインドします。

引数:

param args:

最初の要素がメニューの変数名、二番目の要素がバインドするボタンの識別子。

type args:

list of str

add_dialog(args)

概要:

カスタムダイアログにウィジェットの設定を追加します。

詳細説明:

引数で指定されたウィジェットタイプ、変数名、およびその他のオプションを解析し、 dialog_configリストに追加してカスタムダイアログの構成要素とします。

引数:

param args:

ウィジェットの設定情報を含むリスト。最初の要素はウィジェットタイプ、 二番目の要素は関連する変数名、以降はキー=値の形式でオプションを指定。

type args:

list of str

add_path(args)

概要:

指定されたパスを環境変数PATHまたは指定された変数に追加します。

引数:

param args:

パス追加の引数リスト。 args[0]がパスの場合、PATHに追加。 args[0]が変数名、args[1]がパスの場合、変数名にパスを追加。

type args:

list of str

add_tooltip(args)

概要:

指定されたウィジェットにツールチップを追加します。

引数:

param args:

最初の要素がツールチップを付けるボタンの識別子、二番目の要素がツールチップのテキスト。 オプションで三番目の要素が背景色、四番目の要素が前景色。

type args:

list of str

ask_okcancel_dialog(message)

概要:

OK/キャンセルダイアログを表示します。

詳細説明:

メッセージから引用符を削除して表示します。

引数:

param app:

アプリケーションのインスタンス。

type app:

tkLauncherApp

param message:

ダイアログに表示するメッセージ。

type message:

str

戻り値:

returns:

ユーザーがOKをクリックした場合はTrue、キャンセルした場合はFalse。

rtype:

bool

ask_okcancel_dialog2(message)

概要:

OK/キャンセルダイアログを表示します。

引数:

param app:

アプリケーションのインスタンス。

type app:

tkLauncherApp

param message:

ダイアログに表示するメッセージ。

type message:

str

戻り値:

returns:

ユーザーがOKをクリックした場合はTrue、キャンセルした場合はFalse。

rtype:

bool

ask_yesno_dialog(message)

概要:

Yes/Noダイアログを表示します。

詳細説明:

メッセージから引用符を削除して表示します。

引数:

param app:

アプリケーションのインスタンス。

type app:

tkLauncherApp

param message:

ダイアログに表示するメッセージ。

type message:

str

戻り値:

returns:

ユーザーがYesをクリックした場合はTrue、Noをクリックした場合はFalse。

rtype:

bool

ask_yesno_dialog2(message)

概要:

Yes/Noダイアログを表示します。

引数:

param app:

アプリケーションのインスタンス。

type app:

tkLauncherApp

param message:

ダイアログに表示するメッセージ。

type message:

str

戻り値:

returns:

ユーザーがYesをクリックした場合はTrue、Noをクリックした場合はFalse。

rtype:

bool

check_exist(args)

概要:

ファイルまたはディレクトリの存在をチェックします。

詳細説明:

check_file_modeの設定や実際のファイル存在状況に基づいて、 メッセージダイアログを表示したり、ボタンの表示を変更したりします。

引数:

param args:

最初の要素がチェック対象のファイルまたはディレクトリのパス。 オプションで二番目の要素に表示するメッセージ。

type args:

list of str

戻り値:

returns:

ファイルまたはディレクトリが存在し、チェックモードが許可する場合はTrue、それ以外はFalse。

rtype:

bool

check_file_mode(args)

概要:

ファイル存在チェックモードを設定します。

詳細説明:

このモードは、check_existメソッドの動作に影響を与えます。 'true'または'false'で設定されます。

引数:

param args:

最初の要素がファイルチェックモードを示す文字列（例: 'auto', 'true', 'false'）。

type args:

list of str

choose_if_not_exist(args)

概要:

指定されたファイルが存在しない場合、ファイル選択ダイアログを表示してユーザーに選択を促します。

詳細説明:

ファイルが選択された場合、そのパスを指定された変数に設定します。

引数:

param args:

最初の要素がパスを格納する変数名、二番目の要素がファイルマスク、 三番目の要素がダイアログのタイトルメッセージ。

type args:

list of str

戻り値:

returns:

ファイルが選択された場合1、ユーザーがキャンセルした場合-1。

rtype:

int

confirm()

概要:

確認モードの状態を返します。

戻り値:

returns:

確認モードが有効な場合はTrue、それ以外はFalse。

rtype:

bool

convert_os_path_sep(path)

概要:

指定されたパスの区切り文字を現在のOSに適した形式に変換します。

引数:

param path:

変換するパス文字列。

type path:

str

戻り値:

returns:

OSのパス区切り文字に変換されたパス文字列。

rtype:

str

copy_config2scars(args)

概要:

アプリケーションの設定値をスクリプト変数にコピーします。

詳細説明:

copy_config2svarsメソッドのエイリアスです。

引数:

param args:

使用しない。

type args:

list

copy_config2svars(args)

概要:

アプリケーションの設定値をスクリプト変数にコピーします。

詳細説明:

configオブジェクト内の全てのキーと値を、"config.キー名" の形式でスクリプト変数に設定します。

引数:

param args:

使用しない。

type args:

list

copy_svars2config(args)

概要:

スクリプト変数のうち"config."プレフィックスを持つ値をアプリケーションの設定にコピーします。

引数:

param args:

使用しない。

type args:

list

create_menu(args, s_engine, cparams, fp)

概要:

ポップアップメニューを作成し、Tkinter変数に格納します。

詳細説明:

引数で指定されたラベルとコマンドを持つサブメニュー項目を作成し、 指定された変数名でポップアップメニューオブジェクトを管理します。

引数:

param args:

最初の要素がメニューを格納する変数名、二番目の要素がメニューのタイトル。 以降は「キー=ラベル」「キー=コマンド」のペアでサブメニュー項目を指定。

type args:

list of str

param s_engine:

スクリプト実行エンジンオブジェクト。

type s_engine:

object

param cparams:

コマンドパラメータオブジェクト。

type cparams:

object

param fp:

ファイルポインタまたは関連オブジェクト。

type fp:

object

create_script()

概要:

スクリプトファイルからtkScriptオブジェクトを生成します。

戻り値:

returns:

生成されたtkScriptオブジェクト。

rtype:

tkScript

debug()

概要:

デバッグモードの状態を返します。

戻り値:

returns:

デバッグモードが有効な場合はTrue、それ以外はFalse。

rtype:

bool

del_quote(var)

概要:

指定された変数に格納されている文字列から引用符を削除し、変数を更新します。

引数:

param var:

引用符を削除する対象の変数名。

type var:

str

echo(arg)

概要:

警告メッセージを出力します。

引数:

param arg:

出力するメッセージ。

type arg:

str

escape_reg(args)

概要:

文字列を正規表現の特殊文字からエスケープし、結果を変数に設定します。

引数:

param args:

最初の要素が結果を格納する変数名、二番目の要素がエスケープ対象の文字列。

type args:

list of str

eval(args)

概要:

指定された式を評価し、結果を変数に設定します。

引数:

param args:

最初の要素が結果を格納する変数名、二番目の要素が評価する式。

type args:

list of str

exit_if_defined(mode, var)

概要:

指定された変数が定義されているか否かに応じて、アプリケーションの終了を制御します。

詳細説明:

modeがTrueで変数が定義されている場合、またはmodeがFalseで変数が未定義の場合に、 エラーダイアログを表示し、Falseを返します。 このメソッド自体はアプリケーションを終了させません。

引数:

param mode:

Trueの場合「定義されている場合に終了」、Falseの場合「未定義の場合に終了」。

type mode:

bool

param var:

チェックする変数名。

type var:

str

戻り値:

returns:

終了条件に合致しなかった場合はTrue、合致した場合はFalse。

rtype:

bool

exit_if_exist(mode, path)

概要:

指定されたファイルの存在状況に応じて、アプリケーションの終了を制御します。

詳細説明:

modeがTrueでファイルが存在する場合、またはmodeがFalseでファイルが存在しない場合に、 エラーダイアログを表示し、Falseを返します。 このメソッド自体はアプリケーションを終了させません。

引数:

param mode:

Trueの場合「存在する場合に終了」、Falseの場合「存在しない場合に終了」。

type mode:

bool

param path:

チェックするファイルパス。

type path:

str

戻り値:

returns:

終了条件に合致しなかった場合はTrue、合致した場合はFalse。

rtype:

bool

get_app_path(args)

概要:

アプリケーションの実行可能ファイルのパスを取得します。

詳細説明:

指定された変数にパスが設定されていないか、ファイルが存在しない場合、 ファイル選択ダイアログを表示してユーザーに選択を促し、結果を変数に保存します。

引数:

param args:

最初の要素がパスを格納する変数名、二番目の要素がファイルマスク、 三番目の要素がダイアログのメッセージ。

type args:

list of str

戻り値:

returns:

パスが正常に取得または設定された場合はTrue、ユーザーがキャンセルした場合はFalse。

rtype:

bool

get_button(button_idx0)

概要:

指定されたインデックスまたは名前のボタンウィジェットを取得します。

引数:

param button_idx0:

ボタンのインデックス（1から始まる数値）またはボタン名（例: "RButton1", "TButton2"）。

type button_idx0:

str or int

戻り値:

returns:

対応するボタンウィジェットオブジェクト、見つからない場合はNone。

rtype:

object or None

get_cur_button_caption(var)

概要:

最後に押されたボタンのキャプション（テキスト）を取得し、変数に設定します。

引数:

param var:

ボタンのキャプションを格納する変数名。

type var:

str

戻り値:

returns:

最後に押されたボタンのキャプション。

rtype:

str

get_cur_button_idx(var)

概要:

最後に押されたボタンのインデックスを取得し、変数に設定します。

引数:

param var:

ボタンのインデックスを格納する変数名。

type var:

str

戻り値:

returns:

最後に押されたボタンのインデックス。

rtype:

int

get_cur_dir(var)

概要:

現在の作業ディレクトリを取得し、指定された変数に設定します。

引数:

param var:

現在の作業ディレクトリを格納する変数名。

type var:

str

get_cur_menu(var)

概要:

現在選択されているメニュー項目を取得し、指定された変数に設定します。

引数:

param var:

選択されたメニュー項目を格納する変数名。

type var:

str

get_cur_menu_file(var)

概要:

現在選択されているメニュー項目に関連付けられたファイルパスを取得し、変数に設定します。

引数:

param var:

ファイルパスを格納する変数名。

type var:

str

戻り値:

returns:

関連付けられたファイルパス。

rtype:

str

get_file_list(args, target='file')

概要:

指定されたディレクトリからファイルまたはディレクトリのリストを取得します。

詳細説明:

指定されたファイルマスクに一致するファイルまたはディレクトリを検索し、 結果をソートして'##'で連結された文字列として変数に設定します。

引数:

param args:

最初の要素が結果を格納する変数名、二番目の要素が検索対象ディレクトリ、 三番目以降の要素がファイルマスクのリスト。

type args:

list of str

param target:

'file'でファイルを検索、'dir'でディレクトリを検索。両方含む場合は'filedir'など。

type target:

str

戻り値:

returns:

検索結果を'##'で連結した文字列。

rtype:

str

get_first_word(args)

概要:

指定された文字列から、最初の区切り文字までの部分（最初の単語）を取得し、変数に設定します。

引数:

param args:

最初の要素が対象文字列、二番目の要素が区切り文字、三番目の要素が結果を格納する変数名。

type args:

list of str

get_last_word(args)

概要:

指定された文字列から、最後の区切り文字以降の部分（最後の単語）を取得し、変数に設定します。

引数:

param args:

最初の要素が対象文字列、二番目の要素が区切り文字、三番目の要素が結果を格納する変数名。

type args:

list of str

get_open_dir_name(args, stop_on_cancel=True)

概要:

ディレクトリ選択ダイアログを表示し、選択されたディレクトリパスを変数に設定します。

引数:

param args:

オプションで最初の要素に初期ディレクトリ、二番目以降の要素にダイアログのタイトル。

type args:

list of str

param stop_on_cancel:

Trueの場合、ユーザーがキャンセルすると-1を返します。

type stop_on_cancel:

bool

戻り値:

returns:

ディレクトリが選択された場合1、キャンセルされた場合は-1。

rtype:

int

get_open_file_name(args, stop_on_cancel=True)

概要:

ファイルオープンダイアログを表示し、選択されたファイルパスを変数に設定します。

引数:

param args:

オプションで最初の要素にファイルマスク、二番目の要素に初期ディレクトリ、 三番目以降の要素にダイアログのタイトル。

type args:

list of str

param stop_on_cancel:

Trueの場合、ユーザーがキャンセルすると-1を返します。

type stop_on_cancel:

bool

戻り値:

returns:

ファイルが選択された場合1、キャンセルされた場合は-1。

rtype:

int

get_path_part(key, path, var)

概要:

指定されたパスから特定の要素（ドライブ、ディレクトリ名、ファイル名など）を抽出し、変数に設定します。

引数:

param key:

抽出するパスの要素を指定するキー（'drive', 'dir', 'filename'など）。

type key:

str

param path:

解析対象のパス文字列。

type path:

str

param var:

結果を格納する変数名。

type var:

str

get_save_file_name(args, stop_on_cancel=True)

概要:

ファイル保存ダイアログを表示し、選択された保存ファイルパスを変数に設定します。

引数:

param args:

オプションで最初の要素にファイルマスク、二番目の要素に初期ディレクトリ、 三番目以降の要素にダイアログのタイトル。

type args:

list of str

param stop_on_cancel:

Trueの場合、ユーザーがキャンセルすると-1を返します。

type stop_on_cancel:

bool

戻り値:

returns:

ファイルが選択された場合1、キャンセルされた場合は-1。

rtype:

int

input(args)

概要:

ユーザーからの複数行入力を受け付けるダイアログを表示します。

詳細説明:

ユーザーが入力したテキストは、指定された変数に設定されます。 入力内容に "@var=value" の形式が含まれる場合、それも変数として設定されます。

引数:

param args:

最初の要素が入力結果を格納する変数名。 オプションで二番目の要素にメッセージ、三番目の要素にタイトル。

type args:

list of str

戻り値:

returns:

ユーザーが入力した場合1、キャンセルした場合-1。

rtype:

int

join_path(args)

概要:

複数のパス要素を結合し、OSのパス区切り文字に変換して変数に設定します。

引数:

param args:

最初の要素が結果を格納する変数名、以降の要素が結合するパス。

type args:

list of str

list_append(args, check_exist=False)

概要:

指定された変数に、複数の値をリスト形式（区切り文字は'#'）で追加します。

引数:

param args:

最初の要素が変数名、以降の要素が追加する値のリスト。

type args:

list of str

param check_exist:

Trueの場合、追加する値がファイルとして存在するかチェックします。

type check_exist:

bool

move_top(f=True)

概要:

アプリケーションのメインウィンドウを常に最前面に表示するかどうかを設定します。

引数:

param f:

Trueの場合、最前面に表示。Falseの場合、通常表示。

type f:

bool

new_dialog()

概要:

カスタムダイアログの設定を初期化します。

詳細説明:

以前の設定をクリアし、新しいダイアログ設定のためにdialog_configリストを空にします。

post_custom_dialog(vars)

概要:

カスタムダイアログからの戻り値を変数に設定します。

引数:

param vars:

ダイアログから返された変数名の辞書と値。

type vars:

dict

post_custom_dialog_modeless(vars)

概要:

モーダルレスなカスタムダイアログからの戻り値を変数に設定します。

引数:

param vars:

ダイアログから返された変数名の辞書と値。

type vars:

dict

print_all(args)

概要:

指定されたプレフィックスを持つ全てのスクリプト変数を警告として出力します。

引数:

param args:

最初の要素がプレフィックスとなる変数名。

type args:

list of str

read_ini(args)

概要:

INIファイルから指定されたセクションとキーの値を変数に読み込みます。

引数:

param args:

最初の要素がINIファイルのパス、二番目の要素がセクション名、 三番目の要素がキー名、四番目の要素が結果を格納する変数名。 五番目の要素はオプションで、デフォルト値を指定できます。

type args:

list of str

read_ini_all(args)

概要:

INIファイルからすべてのセクションとキーを読み込み、変数に設定します。

詳細説明:

読み込まれた各キーと値は、指定された変数名プレフィックスを付けて スクリプト変数として格納されます。

引数:

param args:

最初の要素がINIファイルのパス、二番目の要素が変数名プレフィックス。

type args:

list of str

read_ini_to_vars(args)

概要:

INIファイルの内容を読み込み、各行を「キー=値」として解析し、変数に設定します。

引数:

param args:

最初の要素がINIファイルのパス、オプションで二番目の要素にdel_quoteを指定できます。

type args:

list of str

戻り値:

returns:

ファイルが正常に読み込まれた場合はTrue、それ以外はFalse。

rtype:

bool

read_labels(args)

概要:

ExcelまたはCSVファイルからヘッダーラベルを読み込み、指定された変数に設定します。

詳細説明:

tkExcelDBを使用してファイルのシートを読み込み、最初の行のラベルを取得します。 取得したラベルは'##'で連結された文字列として変数に設定されます。

引数:

param args:

最初の要素がファイルパス、二番目の要素がラベルを格納する変数名。

type args:

list of str

戻り値:

returns:

読み込まれたラベルの文字列、またはエラーが発生した場合は-1。

rtype:

str or int

remove_comment(var)

概要:

指定された変数に格納されている文字列から、コメント部分（#以降）を削除し、変数を更新します。

引数:

param var:

コメントを削除する対象の変数名。

type var:

str

replace(args)

概要:

文字列内の部分文字列を置換し、結果を変数に設定します。

引数:

param args:

最初の要素が結果を格納する変数名、二番目の要素が対象文字列、 三番目の要素が置換元の部分文字列、四番目の要素が置換後の部分文字列。

type args:

list of str

save_config(argline)

概要:

アプリケーションの設定をINIファイルに保存します。

詳細説明:

現在のウィンドウのジオメトリ情報も設定にコピーされ、 指定されたINIファイルにすべての設定がソートされて書き込まれます。

引数:

param argline:

使用しない（将来の拡張用）。

type argline:

str

search_files(args)

概要:

指定された開始パスからファイルパターンに一致するファイルを検索します。

詳細説明:

検索されたファイルパスのリストを'##'で連結した文字列として指定された変数に設定します。

引数:

param args:

最初の要素が結果を格納する変数名、二番目の要素が検索対象のファイルパターン、 三番目の要素が検索開始パス。

type args:

list of str

search_latest_file(args)

概要:

指定された開始パスからファイルパターンに一致する最新のファイルを検索します。

詳細説明:

検索された最新のファイルパスを、指定された変数に設定します。

引数:

param args:

最初の要素が結果を格納する変数名、二番目の要素が検索対象のファイルパターン、 三番目の要素が検索開始パス。

type args:

list of str

set(argline, do_set=True)

概要:

指定された引数行から変数名と値を解析し、変数を設定します。

引数:

param argline:

設定する変数と値を含む文字列（例: "VAR_NAME=VALUE"）。

type argline:

str

param do_set:

Trueの場合、実際に変数を設定します。Falseの場合、解析のみ行います。

type do_set:

bool

set_argument(message)

概要:

引数文字列を示す変数にメッセージを設定します。

引数:

param message:

設定する引数文字列。

type message:

str

set_command_line(message)

概要:

コマンドライン文字列を示す変数にメッセージを設定します。

引数:

param message:

設定するコマンドライン文字列。

type message:

str

set_command_line_org(message)

概要:

元のコマンドライン文字列を示す変数にメッセージを設定します。

引数:

param message:

設定する元のコマンドライン文字列。

type message:

str

set_confirm(f)

概要:

確認モードを設定します。

引数:

param f:

確認モードをTrueまたはFalseで設定します。

type f:

bool

set_debug(f)

概要:

デバッグモードを設定します。

引数:

param f:

デバッグモードをTrueまたはFalseで設定します。

type f:

bool

set_dialog_values(args)

概要:

カスタムダイアログ内のウィジェット（例: ComboBox）の選択肢を設定します。

引数:

param args:

最初の要素がウィジェットに関連付けられた変数名、二番目の要素が'##'で区切られた選択肢の文字列。

type args:

list of str

戻り値:

returns:

ウィジェットの値が正常に設定された場合はTrue、それ以外はFalse。

rtype:

bool

set_dialog_var(args)

概要:

カスタムダイアログ内のTkinter変数（StringVarなど）の値を設定します。

引数:

param args:

最初の要素が変数名、二番目の要素が設定する値の文字列。

type args:

list of str

set_if_blank(argline)

概要:

指定された変数がNoneまたは空白の場合に、コマンドを実行して変数を設定します。

引数:

param argline:

変数名と設定コマンドを含む文字列。

type argline:

str

set_if_not_blank(argline)

概要:

指定された変数に値があり、かつ空白でない場合に、コマンドを実行して変数を設定します。

引数:

param argline:

変数名と設定コマンドを含む文字列（例: "VAR_NAME NEW_VAR=NEW_VALUE"）。

type argline:

str

set_if_not_null(argline)

概要:

指定された変数がNoneでない場合に、コマンドを実行して変数を設定します。

引数:

param argline:

変数名と設定コマンドを含む文字列。

type argline:

str

set_if_null(argline)

概要:

指定された変数がNoneの場合に、コマンドを実行して変数を設定します。

引数:

param argline:

変数名と設定コマンドを含む文字列。

type argline:

str

set_message(message)

概要:

アプリケーションのステータスバー（またはメッセージ表示領域）にメッセージを設定します。

引数:

param message:

表示するメッセージ。

type message:

str

set_path(argline)

概要:

引数行からパス変数とその値を設定し、OSのパス区切り文字に変換します。

引数:

param argline:

設定するパス変数と値を含む文字列（例: "PATH_VAR=C:/path/to/dir"）。

type argline:

str

set_selected_file(message)

概要:

選択されたファイル名を示す変数にメッセージを設定します。

引数:

param message:

選択されたファイル名または関連メッセージ。

type message:

str

set_var(var, val, set_env=False)

概要:

指定された変数に値を設定します。

詳細説明:

内部のスクリプト変数管理システムと、必要に応じて環境変数に値を設定します。

引数:

param var:

設定する変数名。

type var:

str

param val:

変数に設定する値。

type val:

str

param set_env:

Trueの場合、環境変数にも設定します。

type set_env:

bool

set_window_title(title)

概要:

アプリケーションのメインウィンドウのタイトルを設定します。

引数:

param title:

設定する新しいウィンドウタイトル。

type title:

str

setup(args=None)

概要:

アプリケーションのセットアップダイアログを表示します。

詳細説明:

設定可能なウィジェットのリストに基づいてダイアログを構築し、 ログの出力先を設定します。

引数:

param args:

使用しない（将来の拡張用）。

type args:

list or None

show_color_dialog(args)

概要:

色選択ダイアログを表示し、選択された色を変数に設定します。

引数:

param args:

最初の要素が色名を格納する変数名。

type args:

list of str

戻り値:

returns:

ユーザーが選択した場合1、キャンセルした場合-1。

rtype:

int

show_context_menu(args, event)

概要:

指定されたコンテキストメニューをイベント発生位置に表示します。

引数:

param args:

最初の要素が表示するメニューの変数名。

type args:

list of str

param event:

Tkinterイベントオブジェクト。メニューの表示位置に使用されます。

type event:

tkinter.Event

show_custom_dialog(args)

概要:

構成済みのカスタムダイアログをモーダルで表示します。

詳細説明:

ユーザーがダイアログで入力した値は、post_custom_dialogを通じてスクリプト変数に反映されます。

引数:

param args:

最初の要素がダイアログのタイトル。オプションで二番目の要素にボタンの定義。

type args:

list of str

戻り値:

returns:

ユーザーが確定した場合1、キャンセルした場合-1。

rtype:

int

show_custom_dialog_modeless(args)

概要:

構成済みのカスタムダイアログをモーダルレスで表示します。

詳細説明:

ユーザーがダイアログで入力した値は、post_custom_dialog_modelessを通じてスクリプト変数に反映されます。

引数:

param args:

最初の要素がダイアログのタイトル。オプションで二番目の要素にボタンの定義。

type args:

list of str

戻り値:

returns:

ユーザーが確定した場合1、キャンセルした場合-1。

rtype:

int

show_error_dialog(message, terminate=False)

概要:

エラーメッセージダイアログを表示します。

詳細説明:

メッセージから引用符を削除して表示し、必要に応じてアプリケーションを終了させます。

引数:

param app:

アプリケーションのインスタンス。

type app:

tkLauncherApp

param message:

表示するエラーメッセージ。

type message:

str

param terminate:

Trueの場合、ダイアログ表示後にアプリケーションを終了させます。

type terminate:

bool

show_error_dialog2(message, terminate=False)

概要:

エラーメッセージダイアログを表示します。

詳細説明:

必要に応じてアプリケーションを終了させます。

引数:

param app:

アプリケーションのインスタンス。

type app:

tkLauncherApp

param message:

表示するエラーメッセージ。

type message:

str

param terminate:

Trueの場合、ダイアログ表示後にアプリケーションを終了させます。

type terminate:

bool

show_font_dialog(args)

概要:

フォント選択ダイアログを表示し、選択されたフォントを変数に設定します。

引数:

param args:

最初の要素がフォント名を格納する変数名。

type args:

list of str

戻り値:

returns:

ユーザーが選択した場合1、キャンセルした場合-1。

rtype:

int

show_message(message)

概要:

アプリケーションのメッセージ表示領域にメッセージを表示します。

引数:

param message:

表示するメッセージ。

type message:

str

show_message_dialog(message)

概要:

情報メッセージダイアログを表示します。

詳細説明:

メッセージから引用符を削除して表示します。

引数:

param app:

アプリケーションのインスタンス。

type app:

tkLauncherApp

param message:

表示するメッセージ。

type message:

str

show_message_dialog2(message)

概要:

情報メッセージダイアログを表示します。

引数:

param app:

アプリケーションのインスタンス。

type app:

tkLauncherApp

param message:

表示するメッセージ。

type message:

str

show_select_dialog(args)

概要:

複数の選択肢から一つを選ぶダイアログを表示します。

詳細説明:

指定されたオプションリストの中からユーザーに選択を促し、 選択された値を変数に設定します。

引数:

param args:

最初の要素が選択結果を格納する変数名、二番目の要素がダイアログのタイトル、 三番目の要素がメッセージ、四番目以降の要素が選択肢のリスト。

type args:

list of str

戻り値:

returns:

ユーザーが選択した場合1、キャンセルした場合-1。

rtype:

int

show_window(mode)

概要:

アプリケーションのメインウィンドウの状態を変更します。

詳細説明:

指定されたモードに応じて、ウィンドウを最小化、最大化、通常表示、非表示、 または最前面表示/解除に切り替えます。

引数:

param mode:

ウィンドウの状態を指定する文字列 ('minimize', 'maximize', 'normal', 'hide', 'topmost', 'notopmost')。

type mode:

str

split_argline(argline)

概要:

引数行を解析し、変数名、現在の値、コマンド部分を抽出します。

引数:

param argline:

解析する引数行文字列（例: "VAR_NAME SOME_COMMAND=VALUE"）。

type argline:

str

戻り値:

returns:

(変数名, 変数の現在の値, コマンド部分) のタプル。解析に失敗した場合は (None, None, None)。

rtype:

tuple or None

split_str(args)

概要:

指定された文字列を区切り文字で分割し、指定されたインデックスの要素を変数に設定します。

引数:

param args:

最初の要素が対象文字列、二番目の要素が区切り文字、三番目の要素が取得するインデックス、 四番目の要素が結果を格納する変数名。

type args:

list of str

戻り値:

returns:

分割された文字列の指定インデックスの要素。

rtype:

str

update_script_vars(cparams)

概要:

スクリプトで使用される変数をアプリケーションの状態に基づいて更新します。

詳細説明:

環境変数、設定値、Tkinter変数の値などを収集し、 スクリプトエンジンとアプリケーションの変数辞書を更新します。

引数:

param cparams:

コマンドパラメータを含むオブジェクト。

type cparams:

object

use_os_path_sep(var)

概要:

指定された変数に格納されているパスの区切り文字を現在のOSに適した形式に変換し、 その変数を更新します。

引数:

param var:

パスが格納されている変数名。

type var:

str

write_ini(args)

概要:

INIファイルに指定されたセクションとキーの値を書き込みます。

引数:

param args:

最初の要素がINIファイルのパス、二番目の要素がセクション名、 三番目の要素がキー名、四番目の要素が書き込む値。

type args:

list of str