tktkinter プログラム仕様

概要:

Tkinterウィジェットのラッパー関数とカスタムウィジェットを提供するモジュールです。

詳細説明:

このモジュールは、Tkinterアプリケーション開発を簡素化し、 共通のUIコンポーネント、ファイル/フォルダ選択ダイアログ、メッセージボックス、 カスタム入力ウィジェットなどを提供します。 Matplotlibの埋め込みキャンバスや、右クリックメニュー付きのEntry/Spinbox、 設定ダイアログジェネレータなど、より高度な機能も含まれています。

関連リンク:

tktkinter_usage

tklib.tkgui.tktkinter.Button(app, parent=None, **kwargs)

概要:

Tkinterのボタンウィジェットを作成します。

詳細説明:

tkButtonカスタムクラスのインスタンスを生成します。ボタンのテキストはapp.p()で処理されます。

引数:

param app:

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

type app:

object

param parent:

(オプション) ボタンの親ウィジェット。

type parent:

tkinter.Widget or None

param **kwargs:

tkButtonに渡される追加のキーワード引数。textは国際化処理されます。

type **kwargs:

dict

戻り値:

returns:

作成されたボタンウィジェット。

rtype:

tkButton

tklib.tkgui.tktkinter.Canvas(app, parent=None, canvas_args={}, **kwargs)

概要:

Matplotlibの図を埋め込むことができるTkinterキャンバスウィジェットを作成します。

詳細説明:

matplotlib.backends.backend_tkagg.FigureCanvasTkAggを使用してMatplotlibのFigureを Tkinterフレームに埋め込みます。スクロールバーの有無、サイズ、イベントハンドリングを設定します。

引数:

param app:

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

type app:

object

param parent:

(オプション) キャンバスを配置する親ウィジェット。

type parent:

tkinter.Widget or None

param canvas_args:

(オプション) キャンバスの動作に関する辞書型引数。 use_scrollbar: (bool) スクロールバーを使用するかどうか。 figsize: (list) MatplotlibのFigureサイズ (幅, 高さ) in inches。 min_canvas_size: (list) キャンバスの最小サイズ (幅, 高さ) in pixels。

type canvas_args:

dict

param **kwargs:

その他のキーワード引数（現在使用されていません）。

type **kwargs:

dict

戻り値:

returns:

作成されたMatplotlibキャンバスウィジェット。

rtype:

FigureCanvasTkAgg

tklib.tkgui.tktkinter.CheckButton(app, parent=None, variable=None, defvalue=False, command=None, onvalue=True, offvalue=False, **kwargs)

概要:

Tkinterのチェックボタンウィジェットを作成します。

詳細説明:

tkinter.Checkbuttonインスタンスを生成し、必要に応じてtkinter.BooleanVarを自動的に作成して関連付けます。

引数:

param app:

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

type app:

object

param parent:

(オプション) チェックボタンの親ウィジェット。

type parent:

tkinter.Widget or None

param variable:

(オプション) チェックボタンの状態を管理するTkinter変数（BooleanVarなど）。指定されない場合、自動生成されます。

type variable:

tkinter.Variable or None

param defvalue:

(オプション) variableが自動生成される場合の初期値。デフォルトはFalse。

type defvalue:

bool

param command:

(オプション) チェックボタンがクリックされたときに実行されるコールバック関数。

type command:

callable or None

param onvalue:

(オプション) チェックされたときにvariableに設定される値。デフォルトはTrue。

type onvalue:

any

param offvalue:

(オプション) チェックが外されたときにvariableに設定される値。デフォルトはFalse。

type offvalue:

any

param **kwargs:

tkinter.Checkbuttonに渡される追加のキーワード引数。

type **kwargs:

dict

戻り値:

returns:

作成されたチェックボタンウィジェット。

rtype:

tkinter.Checkbutton

tklib.tkgui.tktkinter.Combobox(app, parent=None, **kwargs)

概要:

Tkinterのコンボボックスウィジェットを作成します。

詳細説明:

tkinter.ttk.Comboboxインスタンスを生成し、親ウィジェットと追加のオプションを受け取ります。

引数:

param app:

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

type app:

object

param parent:

(オプション) コンボボックスの親ウィジェット。

type parent:

tkinter.Widget or None

param **kwargs:

tkinter.ttk.Comboboxに渡される追加のキーワード引数。

type **kwargs:

dict

戻り値:

returns:

作成されたコンボボックスウィジェット。

rtype:

tkinter.ttk.Combobox

tklib.tkgui.tktkinter.ComboboxFrame(app, parent, frame_args={'bg': 'dim gray'}, head_label_args={'text': 'Input module:'}, combobox_args={'default': 'def', 'textvariable': ['varname', None], 'values': ['abc', 'def'], 'width': 10}, tail_label_args={'text': ''}, gridframe=None, igridrow=None, is_print=False, **kwargs)

概要:

ラベルとコンボボックスを組み合わせたフレームウィジェットを作成します。

詳細説明:

オプションで先頭と末尾にラベルを持ち、中央にコンボボックスを配置します。 コンボボックスのtextvariableはapp.tkvarsに登録されます。

引数:

param app:

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

type app:

object

param parent:

フレームの親ウィジェット。

type parent:

tkinter.Widget

param frame_args:

(オプション) メインフレームのキーワード引数。

type frame_args:

dict

param head_label_args:

(オプション) 先頭のラベルウィジェットのキーワード引数。

type head_label_args:

dict

param combobox_args:

(オプション) コンボボックスウィジェットのキーワード引数。textvariableはリスト形式[key, var]で指定可能。

type combobox_args:

dict

param tail_label_args:

(オプション) 末尾のラベルウィジェットのキーワード引数。

type tail_label_args:

dict

param gridframe:

(オプション) 既存のグリッドフレームを使用する場合、そのインスタンス。

type gridframe:

tkinter.Frame or None

param igridrow:

(オプション) gridframeを使用する場合の行インデックス。

type igridrow:

int or None

param is_print:

(オプション) デバッグ情報を出力するかどうか。

type is_print:

bool

param **kwargs:

その他のキーワード引数（現在使用されていません）。

type **kwargs:

dict

戻り値:

returns:

作成されたコンボボックスフレームウィジェット。

rtype:

tkinter.Frame

tklib.tkgui.tktkinter.Editor(app, parent=None, frame_args={}, head_label_args={}, entry_args={}, tail_label_args=None, button_args={}, eval_button_args=None, **kwargs)

概要:

パス入力フィールドとテキストエリアを組み合わせた簡単なエディタウィジェットを作成します。

詳細説明:

PathFrameとtkinter.Textを組み合わせて、ファイルパスの指定、外部ツールでの編集、 テキストエリアでの内容表示・編集を可能にします。テキストエリアには右クリックメニューも実装されています。

引数:

param app:

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

type app:

object

param parent:

(オプション) エディタウィジェットの親。

type parent:

tkinter.Widget or None

param frame_args:

(オプション) 全体を囲むフレームのキーワード引数。

type frame_args:

dict

param head_label_args:

(オプション) PathFrameの先頭ラベルのキーワード引数。

type head_label_args:

dict

param entry_args:

(オプション) PathFrameの入力フィールドのキーワード引数。

type entry_args:

dict

param tail_label_args:

(オプション) PathFrameの末尾ラベルのキーワード引数。

type tail_label_args:

dict or None

param button_args:

(オプション) PathFrameのファイル参照ボタンのキーワード引数。

type button_args:

dict

param eval_button_args:

(オプション) PathFrameのシェル実行ボタンのキーワード引数。

type eval_button_args:

dict or None

param **kwargs:

tkinter.Textウィジェットに渡される追加のキーワード引数。

type **kwargs:

dict

戻り値:

returns:

作成されたエディタフレームウィジェット。

rtype:

tkinter.Frame

tklib.tkgui.tktkinter.Entry(app, parent=None, **kwargs)

概要:

Tkinterの入力フィールドウィジェットを作成します。

詳細説明:

tkinter.Entryインスタンスを生成し、親ウィジェットと追加のオプションを受け取ります。

引数:

param app:

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

type app:

object

param parent:

(オプション) エントリウィジェットの親。

type parent:

tkinter.Widget or None

param **kwargs:

tkinter.Entryに渡される追加のキーワード引数。

type **kwargs:

dict

戻り値:

returns:

作成されたエントリウィジェット。

rtype:

tkinter.Entry

tklib.tkgui.tktkinter.Frame(app, parent=None, **kwargs)

概要:

Tkinterのフレームウィジェットを作成します。

詳細説明:

tkinter.Frameインスタンスを生成し、親ウィジェットと追加のオプションを受け取ります。

引数:

param app:

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

type app:

object

param parent:

(オプション) フレームの親ウィジェット。

type parent:

tkinter.Widget or None

param **kwargs:

tkinter.Frameに渡される追加のキーワード引数。

type **kwargs:

dict

戻り値:

returns:

作成されたフレームウィジェット。

rtype:

tkinter.Frame

tklib.tkgui.tktkinter.LabelEntryFrame(app, parent=None, frame_args={}, label_args=None, entry_args=None, combobox_args=None, spinbox_args=None, gridframe=None, grid_args={}, igridrow=0)

概要:

ラベルと入力フィールド（Entry, Combobox, Spinboxのいずれか）を組み合わせたフレームウィジェットを作成します。

詳細説明:

PathFrame関数を内部的に呼び出すことで、シンプルにラベルと単一の入力フィールドを配置するUIを提供します。

引数:

param app:

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

type app:

object

param parent:

(オプション) フレームの親ウィジェット。

type parent:

tkinter.Widget or None

param frame_args:

(オプション) メインフレームのキーワード引数。

type frame_args:

dict

param label_args:

(オプション) ラベルウィジェットのキーワード引数。PathFrameのhead_label_argsに相当。

type label_args:

dict or None

param entry_args:

(オプション) Entryウィジェットのキーワード引数。

type entry_args:

dict or None

param combobox_args:

(オプション) Comboboxウィジェットのキーワード引数。

type combobox_args:

dict or None

param spinbox_args:

(オプション) Spinboxウィジェットのキーワード引数。

type spinbox_args:

dict or None

param gridframe:

(オプション) 既存のグリッドフレームを使用する場合、そのインスタンス。

type gridframe:

tkinter.Frame or None

param grid_args:

(オプション) グリッドレイアウトのキーワード引数。

type grid_args:

dict

param igridrow:

(オプション) gridframeを使用する場合の行インデックス。

type igridrow:

int

戻り値:

returns:

作成されたラベル・エントリフレームウィジェット。

rtype:

tkinter.Frame

tklib.tkgui.tktkinter.Menu(app, parent=None, **kwargs)

概要:

Tkinterのメニューウィジェットを作成します。

詳細説明:

tkinter.Menuインスタンスを生成し、親ウィジェットと追加のオプションを受け取ります。

引数:

param app:

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

type app:

object

param parent:

(オプション) メニューの親ウィジェット。

type parent:

tkinter.Widget or None

param **kwargs:

tkinter.Menuに渡される追加のキーワード引数。

type **kwargs:

dict

戻り値:

returns:

作成されたメニューウィジェット。

rtype:

tkinter.Menu

tklib.tkgui.tktkinter.PathFrame(app, parent=None, frame_args={}, head_label_args=None, entry_args=None, combobox_args=None, spinbox_args=None, tail_label_args=None, button_args=None, save_button_args=None, edit_button_args=None, copy_button_args=None, optionmenu_args=None, menubotton_args=None, shell_button_args=None, font_size=10, gridframe=None, grid_args={}, igridrow=None, is_print=False, **kwargs)

概要:

ファイルパスの入力、参照、編集、実行などをサポートする多機能なフレームウィジェットを作成します。

詳細説明:

ラベル、入力フィールド（Entry, Combobox, Spinboxのいずれか）、参照ボタン、 編集ボタン、コピーボタン、外部アプリケーション選択メニュー、シェル実行ボタンなどを組み合わせて、 ファイルパス関連のUIを構築します。

引数:

param app:

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

type app:

object

param parent:

(オプション) フレームの親ウィジェット。

type parent:

tkinter.Widget or None

param frame_args:

(オプション) メインフレームのキーワード引数。

type frame_args:

dict

param head_label_args:

(オプション) 先頭のラベルウィジェットのキーワード引数。

type head_label_args:

dict or None

param entry_args:

(オプション) Entryウィジェットのキーワード引数。textvariableはリスト形式[key, var]で指定可能。

type entry_args:

dict or None

param combobox_args:

(オプション) Comboboxウィジェットのキーワード引数。textvariableはリスト形式[key, var]で指定可能。

type combobox_args:

dict or None

param spinbox_args:

(オプション) Spinboxウィジェットのキーワード引数。textvariableはリスト形式[key, var]で指定可能。

type spinbox_args:

dict or None

param tail_label_args:

(オプション) 末尾のラベルウィジェットのキーワード引数。

type tail_label_args:

dict or None

param button_args:

(オプション) ファイル参照ボタンのキーワード引数。

type button_args:

dict or None

param save_button_args:

(オプション) ファイル保存ボタンのキーワード引数。

type save_button_args:

dict or None

param edit_button_args:

(オプション) 編集ボタンのキーワード引数。

type edit_button_args:

dict or None

param copy_button_args:

(オプション) パスをクリップボードにコピーするボタンのキーワード引数。

type copy_button_args:

dict or None

param optionmenu_args:

(オプション) 外部アプリケーション選択OptionMenuのキーワード引数。textvariableはリスト形式[key, var]で指定可能。

type optionmenu_args:

dict or None

param menubotton_args:

(オプション) Menubuttonウィジェットのキーワード引数（現在フレーム内で動作しません）。

type menubotton_args:

dict or None

param shell_button_args:

(オプション) シェル実行ボタンのキーワード引数。

type shell_button_args:

dict or None

param font_size:

(オプション) ウィジェットのフォントサイズ。

type font_size:

int

param gridframe:

(オプション) 既存のグリッドフレームを使用する場合、そのインスタンス。

type gridframe:

tkinter.Frame or None

param grid_args:

(オプション) グリッドレイアウトのキーワード引数。

type grid_args:

dict

param igridrow:

(オプション) gridframeを使用する場合の行インデックス。

type igridrow:

int or None

param is_print:

(オプション) デバッグ情報を出力するかどうか。

type is_print:

bool

param **kwargs:

path_button_clickなどに渡される追加のキーワード引数（ini_dir, file_typeなど）。

type **kwargs:

dict

戻り値:

returns:

作成されたパスフレームウィジェット。

rtype:

tkinter.Frame

tklib.tkgui.tktkinter.RangeFrame(app, parent=None, frame_args={}, head_label_args={}, x0_entry_args={}, center_label_args={}, x1_entry_args={}, gridframe=None, igridrow=None)

概要:

2つのSpinbox（またはEntry）ウィジェットで範囲を指定するためのフレームウィジェットを作成します。

詳細説明:

ラベルと2つの入力フィールド（通常はtkSpinbox）を水平に配置し、範囲入力UIを提供します。 変数をapp.tkvarsに登録します。

引数:

param app:

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

type app:

object

param parent:

(オプション) フレームの親ウィジェット。

type parent:

tkinter.Widget or None

param frame_args:

(オプション) メインフレームのキーワード引数。

type frame_args:

dict

param head_label_args:

(オプション) 先頭のラベルウィジェットのキーワード引数。

type head_label_args:

dict

param x0_entry_args:

(オプション) 最初の入力フィールド（下限）のキーワード引数。textvariableはリスト形式[key, var]で指定可能。

type x0_entry_args:

dict

param center_label_args:

(オプション) 中央のラベルウィジェットのキーワード引数。

type center_label_args:

dict

param x1_entry_args:

(オプション) 2番目の入力フィールド（上限）のキーワード引数。textvariableはリスト形式[key, var]で指定可能。

type x1_entry_args:

dict

param gridframe:

(オプション) 既存のグリッドフレームを使用する場合、そのインスタンス。

type gridframe:

tkinter.Frame or None

param igridrow:

(オプション) gridframeを使用する場合の行インデックス。

type igridrow:

int or None

戻り値:

returns:

作成された範囲入力フレームウィジェット。

rtype:

tkinter.Frame

tklib.tkgui.tktkinter.Text(app, parent=None, **kwargs)

概要:

Tkinterのテキストウィジェットを作成します。

詳細説明:

tkinter.Textインスタンスを生成し、親ウィジェットと追加のオプションを受け取ります。

引数:

param app:

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

type app:

object

param parent:

(オプション) テキストウィジェットの親。

type parent:

tkinter.Widget or None

param **kwargs:

tkinter.Textに渡される追加のキーワード引数。

type **kwargs:

dict

戻り値:

returns:

作成されたテキストウィジェット。

rtype:

tkinter.Text

tklib.tkgui.tktkinter.add_widget(self, c)

概要:

tkCustomDialog_by_config内で使用される、設定に基づいてGUIウィジェットを追加するヘルパー関数です。

詳細説明:

configオブジェクトによって定義されたウィジェットのタイプと引数に従って、 様々なTkinterウィジェット（タブ、ラベル、フレーム、ボタン、エントリ、テキスト、 チェックボックス、リストボックス、コンボボックス、ラジオボタン、Spinbox、 ファイル/ディレクトリ選択）を動的に生成し、ダイアログに配置します。

引数:

param self:

tkCustomDialog_by_configのインスタンス。

type self:

tkCustomDialog_by_config

param c:

ウィジェットの設定情報を含むオブジェクト。このオブジェクトはwidgetタイプ、var名、args（キーワード引数）、vars（値のリスト）などの属性を持ちます。

type c:

object

tklib.tkgui.tktkinter.askinteger(app, title='Input float value', message='Input float value', initialvalue=None, minvalue=None, maxvalue=None)

概要:

整数入力を求めるダイアログを表示します。

詳細説明:

tkinter.simpledialog.askintegerを使用して、タイトル、メッセージ、 初期値、最小値、最大値を含む入力ダイアログを表示します。

引数:

param app:

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

type app:

object

param title:

(オプション) ダイアログのタイトル。

type title:

str

param message:

(オプション) ダイアログに表示するメッセージ。

type message:

str

param initialvalue:

(オプション) 入力フィールドの初期値。

type initialvalue:

int or None

param minvalue:

(オプション) 許容される最小値。

type minvalue:

int or None

param maxvalue:

(オプション) 許容される最大値。

type maxvalue:

int or None

戻り値:

returns:

ユーザーが入力した整数、またはキャンセルされた場合はNone。

rtype:

int or None

tklib.tkgui.tktkinter.askstring(app, title='Input text', message='Input float value', initialvalue=None)

概要:

文字列入力を求めるダイアログを表示します。

詳細説明:

tkinter.simpledialog.askstringを使用して、タイトル、メッセージ、 初期値を含む入力ダイアログを表示します。

引数:

param app:

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

type app:

object

param title:

(オプション) ダイアログのタイトル。

type title:

str

param message:

(オプション) ダイアログに表示するメッセージ。

type message:

str

param initialvalue:

(オプション) 入力フィールドの初期値。

type initialvalue:

str or None

戻り値:

returns:

ユーザーが入力した文字列、またはキャンセルされた場合はNone。

rtype:

str or None

tklib.tkgui.tktkinter.color_dialog(app=None, parent=None, title=None, color=None)

概要:

色選択ダイアログを表示します。

詳細説明:

tkinter.colorchooser.askcolorを呼び出し、ユーザーが色を選択できるようにします。

引数:

param app:

(オプション) アプリケーションのインスタンス。主にparentの指定に使用されます。

type app:

object or None

param parent:

(オプション) ダイアログの親ウィジェット。

type parent:

tkinter.Widget or None

param title:

(オプション) ダイアログのタイトル。

type title:

str or None

param color:

(オプション) ダイアログの初期色。

type color:

str or tuple or None

戻り値:

returns:

((R, G, B), '#RRGGBB')形式の選択された色情報、または選択がキャンセルされた場合は(None, None)。

rtype:

tuple

tklib.tkgui.tktkinter.dialog_askfloat(app, title='Input float value', message='Input float value', initialvalue=None, minvalue=None, maxvalue=None)

概要:

浮動小数点数入力を求めるダイアログを表示します。

詳細説明:

tkinter.simpledialog.askfloatを使用して、タイトル、メッセージ、 初期値、最小値、最大値を含む入力ダイアログを表示します。

引数:

param app:

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

type app:

object

param title:

(オプション) ダイアログのタイトル。

type title:

str

param message:

(オプション) ダイアログに表示するメッセージ。

type message:

str

param initialvalue:

(オプション) 入力フィールドの初期値。

type initialvalue:

float or None

param minvalue:

(オプション) 許容される最小値。

type minvalue:

float or None

param maxvalue:

(オプション) 許容される最大値。

type maxvalue:

float or None

戻り値:

returns:

ユーザーが入力した浮動小数点数、またはキャンセルされた場合はNone。

rtype:

float or None

tklib.tkgui.tktkinter.dialog_okcancel(app, title='Quit', message='Do you really quit the program?')

概要:

「OK」または「キャンセル」を選択するダイアログを表示します。

詳細説明:

tkinter.messagebox.askokcancelを使用して、タイトルとメッセージを含む確認ダイアログを表示します。

引数:

param app:

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

type app:

object

param title:

(オプション) メッセージボックスのタイトル。

type title:

str

param message:

(オプション) メッセージボックスに表示するメッセージ。

type message:

str

戻り値:

returns:

ユーザーが「OK」を選択した場合はTrue、「キャンセル」を選択した場合はFalse。

rtype:

bool

tklib.tkgui.tktkinter.dialog_retrycancel(app, title='Retry?', message='Do you want to retry?')

概要:

「再試行」または「キャンセル」を選択するダイアログを表示します。

詳細説明:

tkinter.messagebox.askretrycancelを使用して、タイトルとメッセージを含む確認ダイアログを表示します。

引数:

param app:

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

type app:

object

param title:

(オプション) メッセージボックスのタイトル。

type title:

str

param message:

(オプション) メッセージボックスに表示するメッセージ。

type message:

str

戻り値:

returns:

ユーザーが「再試行」を選択した場合はTrue、「キャンセル」を選択した場合はFalse。

rtype:

bool

tklib.tkgui.tktkinter.dialog_showerror(app, title='Error', message='no message')

概要:

エラーメッセージボックスを表示します。

詳細説明:

tkinter.messagebox.showerrorを使用して、タイトルとメッセージを含むエラーダイアログを表示します。

引数:

param app:

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

type app:

object

param title:

(オプション) メッセージボックスのタイトル。

type title:

str

param message:

(オプション) メッセージボックスに表示するメッセージ。

type message:

str

tklib.tkgui.tktkinter.dialog_showinfo(app, title='Information', message='no message')

概要:

情報メッセージボックスを表示します。

詳細説明:

tkinter.messagebox.showinfoを使用して、タイトルとメッセージを含む情報ダイアログを表示します。

引数:

param app:

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

type app:

object

param title:

(オプション) メッセージボックスのタイトル。

type title:

str

param message:

(オプション) メッセージボックスに表示するメッセージ。

type message:

str

tklib.tkgui.tktkinter.dialog_showwarning(app, title='Warning', message='no message')

概要:

警告メッセージボックスを表示します。

詳細説明:

tkinter.messagebox.showwarningを使用して、タイトルとメッセージを含む警告ダイアログを表示します。

引数:

param app:

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

type app:

object

param title:

(オプション) メッセージボックスのタイトル。

type title:

str

param message:

(オプション) メッセージボックスに表示するメッセージ。

type message:

str

tklib.tkgui.tktkinter.dialog_yesno(app, title='Quit', message='Do you really quit the program?')

概要:

「はい」または「いいえ」を選択するダイアログを表示します。

詳細説明:

tkinter.messagebox.askyesnoを使用して、タイトルとメッセージを含む確認ダイアログを表示します。

引数:

param app:

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

type app:

object

param title:

(オプション) メッセージボックスのタイトル。

type title:

str

param message:

(オプション) メッセージボックスに表示するメッセージ。

type message:

str

戻り値:

returns:

ユーザーが「はい」を選択した場合はTrue、「いいえ」を選択した場合はFalse。

rtype:

bool

tklib.tkgui.tktkinter.edit_button_click(app, entry_variable, editor_path=None)

概要:

指定されたエディタでファイルを開きます。

詳細説明:

entry_variableからファイルパスを取得し、editor_pathで指定されたエディタで os.systemを使ってファイルを開きます。editor_pathがNoneの場合、app.get_editor()から取得します。

引数:

param app:

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

type app:

object

param entry_variable:

編集するファイルパスを含むTkinter変数。

type entry_variable:

tkinter.Variable

param editor_path:

(オプション) 使用するエディタのパス。Noneの場合、app.get_editor()を使用。

type editor_path:

str or None

tklib.tkgui.tktkinter.execute_command(app, command, working_dir=None, is_print=False, files=[])

概要:

外部コマンドを実行します。

詳細説明:

コマンド文字列を解析し、オプションの作業ディレクトリとファイル引数を適用してos.systemで実行します。

引数:

param app:

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

type app:

object

param command:

実行するコマンド文字列。角括弧で囲まれた引数を含めることができます。

type command:

str

param working_dir:

(オプション) コマンドを実行する作業ディレクトリ。デフォルトはNone。

type working_dir:

str or None

param is_print:

(オプション) 実行するコマンドを標準出力に表示するかどうか。デフォルトはFalse。

type is_print:

bool

param files:

(オプション) コマンドに追加するファイルパスのリスト。デフォルトは空のリスト。

type files:

list

戻り値:

returns:

os.systemの戻り値（通常はコマンドの終了ステータス）。

rtype:

int

tklib.tkgui.tktkinter.folder_button_click(app, entry_variable, ini_dir='.', title=None, mustexist=True, entry_type='entry', entry_filemask='*;*.*')

概要:

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

詳細説明:

tkinter.filedialog.askdirectoryを使用してフォルダを選択させ、結果をentry_variableに格納します。 entry_typeが'combobox'の場合、選択されたパス内のファイルリストでコンボボックスの値を更新します。

引数:

param app:

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

type app:

object

param entry_variable:

選択されたフォルダパスを格納するTkinter変数、またはComboboxウィジェット。

type entry_variable:

tkinter.Variable or tkinter.ttk.Combobox

param ini_dir:

(オプション) ダイアログの初期ディレクトリ。デフォルトは'.'。

type ini_dir:

str

param title:

(オプション) ダイアログのタイトル。デフォルトはNone。

type title:

str or None

param mustexist:

(オプション) 選択されたディレクトリが存在しなければならないか。デフォルトはTrue。

type mustexist:

bool

param entry_type:

(オプション) entry_variableのタイプ ('entry'または'combobox')。'combobox'の場合、ファイルリストで更新されます。

type entry_type:

str

param entry_filemask:

(オプション) entry_typeが'combobox'の場合にファイルリスト取得に使用するファイルマスク。

type entry_filemask:

str

tklib.tkgui.tktkinter.font_dialog(app=None, parent=None, title=None, color=None)

概要:

フォント選択ダイアログを表示します。

詳細説明:

tk fontchooserコマンドを呼び出し、ユーザーがフォントを選択できるようにします。 選択されたフォントはtkParamsインスタンスを通じて返されます。

引数:

param app:

(オプション) アプリケーションのインスタンス。主にroot_windowの指定に使用されます。

type app:

object or None

param parent:

(オプション) ダイアログの親ウィジェット。

type parent:

tkinter.Widget or None

param title:

(オプション) ダイアログのタイトル。

type title:

str or None

param color:

(オプション) 現在使用されていません。

type color:

any

戻り値:

returns:

選択されたフォントオブジェクト。

rtype:

tkinter.font.Font

tklib.tkgui.tktkinter.make_check_box(app, cparams, tkvars, parent, grid_frame, varname='none', label=None, values=None, defval=True, reset_val=True, help_text=None, button1_args=None, button2_args=None, onvalue=True, offvalue=False, igridrow=0)

概要:

アプリケーションの設定値に基づいたチェックボックスウィジェットを作成します。

詳細説明:

app.tkvarsに管理されるtkinter.BooleanVarまたはtkinter.IntVarに関連付けられたチェックボックスと、 オプションで「デフォルト設定」ボタン、「ヘルプ」ボタンを配置します。

引数:

param app:

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

type app:

object

param cparams:

設定パラメータを保持するオブジェクト。

type cparams:

object

param tkvars:

Tkinter変数を管理する辞書またはオブジェクト。

type tkvars:

object

param parent:

チェックボックスを配置する親ウィジェット。

type parent:

tkinter.Widget

param grid_frame:

チェックボックスを配置するグリッドフレーム。

type grid_frame:

tkinter.Frame

param varname:

(オプション) Tkinter変数の名前（キー）。デフォルトは'none'。

type varname:

str

param label:

(オプション) チェックボックスに表示するテキスト。Noneの場合、varnameが使用されます。

type label:

str or None

param values:

(オプション) 現在使用されていません。

type values:

any

param defval:

(オプション) tkvars[varname]の初期値。デフォルトはTrue。

type defval:

bool

param reset_val:

(オプション) 「デフォルト設定」ボタンがクリックされたときに設定される値。デフォルトはTrue。

type reset_val:

bool

param help_text:

(オプション) 「ヘルプ」ボタンがクリックされたときに表示されるヘルプテキスト。Noneの場合、f"help_{varname}"が使用されます。

type help_text:

str or None

param button1_args:

(オプション) 最初の追加ボタンのキーワード引数。commandとして'set_default'または'show_help'を指定可能。

type button1_args:

dict or None

param button2_args:

(オプション) 2番目の追加ボタンのキーワード引数。commandとして'set_default'または'show_help'を指定可能。

type button2_args:

dict or None

param onvalue:

(オプション) チェックされたときにvariableに設定される値。デフォルトはTrue。

type onvalue:

any

param offvalue:

(オプション) チェックが外されたときにvariableに設定される値。デフォルトはFalse。

type offvalue:

any

param igridrow:

(オプション) グリッドレイアウトを使用する場合の行インデックス。

type igridrow:

int

tklib.tkgui.tktkinter.make_path_frame(app, cparams, parent, grid_frame, tkvar, varname, file_type=[('All', '*.*')], working_dir='.', open_command=None, post_open_command=None, head_label_width=10, entry_width=60, button_width=12, button_args=None, copy_button_args=None, edit_button_width=6, edit_button_args=None, shell_button_width=2, optionmenu_width=3, font_size=10, is_print=True, igridrow=0)

概要:

ファイルパスの入力、参照、外部アプリケーションでの開く操作などを可能にする複合ウィジェットフレームを作成します。

詳細説明:

PathFrameを内部的に利用し、パス変数、ファイル選択ダイアログ、外部エディタ/ビューアでの開く機能、 シェル実行機能などを組み合わせてパス管理UIを生成します。app.tkvarsにtkinter.StringVarを登録します。

引数:

param app:

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

type app:

object

param cparams:

設定パラメータを保持するオブジェクト。

type cparams:

object

param parent:

フレームの親ウィジェット。

type parent:

tkinter.Widget

param grid_frame:

フレームを配置するグリッドフレーム。

type grid_frame:

tkinter.Frame

param tkvar:

Tkinter変数を管理する辞書またはオブジェクト。

type tkvar:

object

param varname:

Tkinter変数の名前（キー）。

type varname:

str

param file_type:

(オプション) ファイル選択ダイアログに表示するファイルタイプのリスト。

type file_type:

list

param working_dir:

(オプション) コマンドを実行する際の作業ディレクトリ。パスが空の場合、varnameのパスから自動的に設定されます。

type working_dir:

str

param open_command:

(オプション) ファイル選択ボタンが押されたときに実行されるカスタムコマンド。

type open_command:

callable or None

param post_open_command:

(オプション) ファイル選択後に追加で実行されるカスタムコマンド。

type post_open_command:

callable or None

param head_label_width:

(オプション) 先頭ラベルの幅。

type head_label_width:

int

param entry_width:

(オプション) 入力フィールドの幅。

type entry_width:

int

param button_width:

(オプション) 参照ボタンの幅。

type button_width:

int

param button_args:

(オプション) 参照ボタンのキーワード引数。

type button_args:

dict or None

param copy_button_args:

(オプション) コピーボタンのキーワード引数。

type copy_button_args:

dict or None

param edit_button_width:

(オプション) 編集ボタンの幅。

type edit_button_width:

int

param edit_button_args:

(オプション) 編集ボタンのキーワード引数。

type edit_button_args:

dict or None

param shell_button_width:

(オプション) シェルボタンの幅。

type shell_button_width:

int

param optionmenu_width:

(オプション) オプションメニューの幅。

type optionmenu_width:

int

param font_size:

(オプション) フォントサイズ。

type font_size:

int

param is_print:

(オプション) デバッグ情報を出力するかどうか。

type is_print:

bool

param igridrow:

(オプション) グリッドレイアウトを使用する場合の行インデックス。

type igridrow:

int

tklib.tkgui.tktkinter.make_var_box(app, cparams, tkvars, parent, grid_frame, varname='none', vartype='int', label=None, values=None, from_=None, to=100, increment=10, box_width=6, defval=0, reset_val=None, help_text=None, button1_args=None, button2_args=None, igridrow=0)

概要:

アプリケーションの設定値に基づいた変数入力ウィジェット（Entry、Spinbox、Combobox）を作成します。

詳細説明:

app.tkvarsに管理されるtkinter.StringVar、IntVar、DoubleVarに関連付けられた入力フィールドと、 オプションで「デフォルト設定」ボタン、「ヘルプ」ボタンを配置します。

引数:

param app:

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

type app:

object

param cparams:

設定パラメータを保持するオブジェクト。

type cparams:

object

param tkvars:

Tkinter変数を管理する辞書またはオブジェクト。

type tkvars:

object

param parent:

ウィジェットを配置する親ウィジェット。

type parent:

tkinter.Widget

param grid_frame:

ウィジェットを配置するグリッドフレーム。

type grid_frame:

tkinter.Frame

param varname:

(オプション) Tkinter変数の名前（キー）。デフォルトは'none'。

type varname:

str

param vartype:

(オプション) 変数の型 ('int', 'str', 'double', 'float')。デフォルトは'int'。

type vartype:

str

param label:

(オプション) ウィジェットのラベルテキスト。Noneの場合、varnameが使用されます。

type label:

str or None

param values:

(オプション) Comboboxで使用する値のリスト。Noneの場合、EntryまたはSpinboxが使用されます。

type values:

list or None

param from_:

(オプション) Spinboxの最小値。

type from_:

int or float or None

param to:

(オプション) Spinboxの最大値。デフォルトは100。

type to:

int or float

param increment:

(オプション) Spinboxの増分値。デフォルトは10。

type increment:

int or float

param box_width:

(オプション) 入力フィールドの幅。デフォルトは6。

type box_width:

int

param defval:

(オプション) tkvars[varname]の初期値。デフォルトは0。リストまたはタプルで設定オブジェクトとデフォルト値を指定することもできます。

type defval:

any

param reset_val:

(オプション) 「デフォルト設定」ボタンがクリックされたときに設定される値。Noneの場合、defvalが使用されます。

type reset_val:

any or None

param help_text:

(オプション) 「ヘルプ」ボタンがクリックされたときに表示されるヘルプテキスト。Noneの場合、f"help_{varname}"が使用されます。

type help_text:

str or None

param button1_args:

(オプション) 最初の追加ボタンのキーワード引数。commandとして'set_default'または'show_help'を指定可能。

type button1_args:

dict or None

param button2_args:

(オプション) 2番目の追加ボタンのキーワード引数。commandとして'set_default'または'show_help'を指定可能。

type button2_args:

dict or None

param igridrow:

(オプション) グリッドレイアウトを使用する場合の行インデックス。

type igridrow:

int

tklib.tkgui.tktkinter.path_button_click(app, entry_variable, ini_dir='.', title=None, file_type=[('All', '*.*')], entry_type='entry', entry_filemask='*;*.*', check_exist=True)

概要:

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

詳細説明:

tkinter.filedialog.askopenfilenameまたはasksaveasfilenameを使用してファイルを選択させ、 結果をentry_variableに格納します。entry_typeが'combobox'の場合、 選択されたパス内のファイルリストでコンボボックスの値を更新します。

引数:

param app:

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

type app:

object

param entry_variable:

選択されたファイルパスを格納するTkinter変数、またはComboboxウィジェット。

type entry_variable:

tkinter.Variable or tkinter.ttk.Combobox

param ini_dir:

(オプション) ダイアログの初期ディレクトリ。デフォルトは'.'。

type ini_dir:

str

param title:

(オプション) ダイアログのタイトル。デフォルトはNone。

type title:

str or None

param file_type:

(オプション) ダイアログに表示するファイルタイプのリスト。例: [("Text files", "*.txt")]。

type file_type:

list

param entry_type:

(オプション) entry_variableのタイプ ('entry'または'combobox')。'combobox'の場合、ファイルリストで更新されます。

type entry_type:

str

param entry_filemask:

(オプション) entry_typeが'combobox'の場合にファイルリスト取得に使用するファイルマスク。

type entry_filemask:

str

param check_exist:

(オプション) ファイルが存在するかどうかを確認するか（askopenfilenameまたはasksaveasfilenameのどちらを使用するか）。デフォルトはTrue。

type check_exist:

bool

tklib.tkgui.tktkinter.set_variable_from_list(app, key, var)

概要:

Tkinter変数をリストから設定し、アプリケーションの変数管理に登録します。

詳細説明:

app.tkvarsにキーと変数を関連付けて保存します。

引数:

param app:

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

type app:

object

param key:

変数を識別するためのキー文字列。

type key:

str

param var:

設定するTkinter変数（StringVar, IntVar, BooleanVarなど）。

type var:

tkinter.Variable

戻り値:

returns:

設定されたTkinter変数。

rtype:

tkinter.Variable

tklib.tkgui.tktkinter.shell_button_click(app, cmd=None)

概要:

コマンドプロンプトまたはシェルを開きます。

詳細説明:

ComSpec環境変数を参照してシェルコマンド（通常はcmd.exe）を取得し、 os.systemで実行します。cmdが指定されない場合、新しいシェルウィンドウを開きます。

引数:

param app:

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

type app:

object

param cmd:

(オプション) 実行する特定のシェルコマンド。Noneの場合、デフォルトのシェルを開きます。

type cmd:

str or None

class tklib.tkgui.tktkinter.tkButton(master, app, **kwargs)

ベースクラス: Button

概要:

テキストの内容に応じて外観を変化させるTkinterのカスタムボタンウィジェットです。

詳細説明:

tkinter.Buttonを継承し、set_textメソッドでボタンのテキストを設定する際に、 特定のプレフィックス（!!! ）があれば取り消し線と赤色で表示し、 それ以外は標準的な外観に戻します。

get_text()

概要:

ボタンの現在のテキストを取得します。

戻り値:

returns:

ボタンに表示されているテキスト。

rtype:

str

set_text(caption)

概要:

ボタンのテキストを設定し、内容に基づいてスタイルを調整します。

詳細説明:

テキストが"!!! "で始まる場合、取り消し線と赤色フォントを適用します。 それ以外の場合は、標準のフォントスタイルに戻します。 また、app.p()を介してテキストの国際化処理を行います。

引数:

param caption:

ボタンに表示するテキスト。

type caption:

str or None

class tklib.tkgui.tktkinter.tkCustomDialog_by_config(master, app=None, title=None, config=None, buttons=None, modeless=False, callback=None, is_print=False)

ベースクラス: Dialog

概要:

設定オブジェクトに基づいて動的にウィジェットを生成するカスタムダイアログです。

詳細説明:

外部から渡された設定オブジェクト（ウィジェットのタイプ、変数名、引数などを含むリスト）を解析し、 タブ、ラベル、フレーム、ボタン、エントリ、テキスト、チェックボックス、リストボックス、コンボボックス、 ラジオボタン、Spinbox、ファイル/ディレクトリ選択ウィジェットなどを動的に作成して配置します。

属性:

app: アプリケーションのインスタンス。 ret: ダイアログの戻り値。 config: ウィジェット構成を定義するオブジェクトのリスト。 buttons: ダイアログに表示するボタンの種類。 modeless: ダイアログがモーダルかモデルレスかを示すフラグ。 callback: ダイアログが閉じられた後に呼び出されるコールバック関数。 is_print: デバッグ情報を出力するかどうか。 vars: 動的に生成されたウィジェットに関連付けられたPython変数。 tkvars: 動的に生成されたウィジェットに関連付けられたTkinter変数。 widget_vars: 生成されたウィジェット自体を格納するオブジェクト。 frame: 現在のフレームウィジェット。

apply()

概要:

ダイアログが閉じられた後に、ウィジェットの現在の値をself.retに格納します。

body(master) → None

概要:

ダイアログの本体部分にウィジェットを生成します。

詳細説明:

設定オブジェクトself.configに基づいて、add_widget関数を呼び出して 各ウィジェットを動的に配置します。

引数:

param master:

親ウィジェット。

type master:

tkinter.Widget

buttonbox()

概要:

ダイアログの下部にあるボタンボックスを生成します。

詳細説明:

self.buttonsの設定に基づいて、「OK」、「キャンセル」、「はい」、「いいえ」、「閉じる」ボタンを配置します。

update_vars()

概要:

ダイアログ内のウィジェットの現在の値を取得し、self.retに格納します。

class tklib.tkgui.tktkinter.tkEntry(parent=None, app=None, **kwargs)

ベースクラス: Entry

概要:

右クリックメニュー（カット、コピー、ペーストなど）が組み込まれたTkinterのエントリウィジェットです。

詳細説明:

tkinter.ttk.Entryを継承し、右クリック時に標準的なテキスト編集操作 （カット、コピー、ペースト、削除、すべて選択）を提供するコンテキストメニューを表示します。

class tklib.tkgui.tktkinter.tkInputDialog(master, app=None, title=None, message='', width=30, height=10, def_val='', is_print=False)

ベースクラス: Dialog

概要:

テキスト入力を求めるカスタムダイアログです。

詳細説明:

メッセージと複数行入力可能なテキストエリアを表示し、ユーザーにテキストを入力させます。

apply()

概要:

ダイアログが閉じられた後に、テキストエリアの入力内容をself.retに格納します。

body(master) → None

概要:

ダイアログの本体部分にメッセージラベルとテキストエリアを生成します。

引数:

param master:

親ウィジェット。

type master:

tkinter.Widget

class tklib.tkgui.tktkinter.tkScrolledListbox(master, **key)

ベースクラス: Listbox

概要:

スクロールバー付きのTkinterリストボックスウィジェットです。

詳細説明:

tkinter.Listboxとtkinter.Scrollbarを組み合わせて、 リストの内容が多い場合でもスクロールして表示できるようにします。

clear()

概要:

リストボックスの内容をクリアします。

class tklib.tkgui.tktkinter.tkSelectDialog(master, app=None, title=None, varname=None, message='', options=[], width=30, height=5, def_index=None, is_print=False)

ベースクラス: Dialog

概要:

選択肢のリストから項目を選択させるカスタムダイアログです。

詳細説明:

メッセージとスクロール可能なリストボックスを表示し、 ユーザーがリストから1つまたは複数の項目を選択できるようにします。

apply()

概要:

ダイアログが閉じられた後に、選択されたリストボックスの項目をself.retに格納します。

body(master) → None

概要:

ダイアログの本体部分にメッセージラベルとスクロールリストボックスを生成します。

引数:

param master:

親ウィジェット。

type master:

tkinter.Widget

class tklib.tkgui.tktkinter.tkSetupDialog(master, app=None, title=None, entry_width=30, button_width=4, edit_button_width=2, shell_button_width=2, widgets='enditor_path|confirm_on_exit|debug_mode', font_size=10, is_print=False)

ベースクラス: Dialog

概要:

アプリケーションの設定を行うためのカスタムダイアログボックスです。

詳細説明:

外部エディタのパス、Pythonインタープリタのパス、シェル、ファイルマネージャー、 VESTAなどのパス設定や、終了時の確認、デバッグモードなどのブール値設定を行うための 入力フィールドとチェックボックスを生成します。widgets引数で表示する設定項目を制御します。

apply()

概要:

ダイアログが閉じられた後に、変更された設定値をアプリケーションのconfigparamsに適用します。

body(master) → None

概要:

ダイアログの本体部分にウィジェットを生成します。

詳細説明:

設定項目に応じて、PathFrameやCheckButtonを配置します。

引数:

param master:

親ウィジェット。

type master:

tkinter.Widget

buttonbox()

概要:

ダイアログの下部にあるOK/キャンセルボタンボックスを生成します。

switchButtonState()

概要:

Applyボタンの状態を切り替えます（無効/有効）。

class tklib.tkgui.tktkinter.tkSpinbox(parent=None, app=None, **kwargs)

ベースクラス: Spinbox

概要:

右クリックメニュー（カット、コピー、ペーストなど）が組み込まれたTkinterのSpinboxウィジェットです。

詳細説明:

tkinter.Spinboxを継承し、右クリック時に標準的なテキスト編集操作 （カット、コピー、ペースト、削除、すべて選択）を提供するコンテキストメニューを表示します。

class tklib.tkgui.tktkinter.tkdialog_yesno(master, title=None, message=None, width=80)

ベースクラス: Dialog

概要:

「はい」/「いいえ」ボタンを持つシンプルなカスタムダイアログです。

詳細説明:

指定されたメッセージを表示し、ユーザーに「はい」または「いいえ」を選択させます。 結果はself.retに保存されます。

body(master) → None

概要:

ダイアログの本体部分にメッセージラベルを生成します。

引数:

param master:

親ウィジェット。

type master:

tkinter.Widget

buttonbox()

概要:

ダイアログの下部にある「はい」/「いいえ」ボタンボックスを生成します。