TKinterでチェックボックス付きのリストを表示したい

Question

PythonのTKinterで以下のようなイメージのGUIアプリを作ろうと思っています。

パス入力or参照ボタンでディレクトリ指定すると、そのディレクトリ内の全てのファイル、フォルダが下のボックス内に表示されるようにしたいです。
また、その中にテキストファイル(.txt)があった場合はファイル名の頭にチェックボックスをつけたいです。

現時点では真ん中の表以外のところはできています。「実行」の処理内容は後程実装しようと思い、今は適当なメッセージを出すようにしています。コードは以下です。

import os,sys
from tkinter import *
from tkinter import ttk
from tkinter import messagebox
from tkinter import filedialog

# フォルダ指定の関数
def dirdialog_clicked():
    iDir = os.path.abspath(os.path.dirname(__file__))
    iDirPath = filedialog.askdirectory(initialdir = iDir)
    entry1.set(iDirPath)


# 実行ボタン押下時の実行関数
def conductMain():
    text = ""

    dirPath = entry1.get()

    if dirPath:
        text += "フォルダパス：" + dirPath + "\n"

    if text:
        messagebox.showinfo("info", text)
    else:
        messagebox.showerror("error", "パスの指定がありません。")

if __name__ == "__main__":

    # rootの作成
    root = Tk()
    root.geometry('400x300')
    root.title("サンプル")

    # Frame1の作成
    frame1 = ttk.Frame(root, padding=10)
    frame1.grid(row=0, column=1, sticky=E)

    # 「フォルダ参照」ラベルの作成
    IDirLabel = ttk.Label(frame1, text="フォルダ参照＞＞", padding=(5, 2))
    IDirLabel.pack(side=LEFT)

    # 「フォルダ参照」エントリーの作成
    entry1 = StringVar()
    IDirEntry = ttk.Entry(frame1, textvariable=entry1, width=30)
    IDirEntry.pack(side=LEFT)

    # 「フォルダ参照」ボタンの作成
    IDirButton = ttk.Button(frame1, text="参照", command=dirdialog_clicked)
    IDirButton.pack(side=LEFT)

    # Frame2の作成
    frame2 = ttk.Frame(root, padding=10)
    frame2.grid(row=5,column=1,sticky=W)

    # 実行ボタンの設置
    button1 = ttk.Button(frame3, text="実行", command=conductMain)
    button1.pack(fill = "x", padx=30, side = "left")

    root.mainloop()

詳しい方教えていただけると幸いです。よろしくお願いいたします。

Comments

[teamikl]

変数 frame3 が未定義です。

また、掲載のコードは質問の目的である「チェックボックス付きのリスト」とは
関係のない部分のみで、対象のリストをどのように扱いたいかという部分が抜けています。
(表示だけで良いのか、チェックを外したりする操作が必要か、等により回答が変わってきます）

質問にはリストにファイル名一覧表示するコードを提示した上で
Listboxにチェックボックスを表示する方法や、代替ウィジェット等を質問されると良いと思います。

Answer 1

外部ライブラリ ttkwidgets の CheckboxTreeview を使う

チェックボックスのグラフィックは埋め込み画像の為、ttk のテーマは適応されません。

• example
• source

emoji (check-box, ballot-box) を使う。

チェックボックスのグラフィックはフォント依存。

• ✔️ check-mark
• ☑️ check-box-with-check
• ☐ ballot-box

def _check_txt(filename):
    if filename.endswith(".txt"):
        return f"\u2611 {filename}"
    else:
        return filename

print(_check_txt("a.txt")) # => ☑️ a.txt
print(_check_txt("b.jpg")) # => b.jpg

テキスト情報内にチェックボックスを表示できます。Listbox内でも表示可能。
実装としては一番簡単ですが、emoji に対応してない環境では文字化けするかもしれません。

自作する

チェックボタンをより柔軟にカスタマイズしたい場合は、
ttk.Checkbutton を使い、１から自分で作る事になります。

---

参考:

• tcl/tk CheckedListBox

　tcl言語による実装。Python実装は上記のttkwidgets.CheckboxTreeview

Comments

[mappys]

teamikl様
回答いただき本当にありがとうございます。ttkwidgets の CheckboxTreeview を使う方向でやってみようかなと思います。

また、チェックボックスとはまた違う質問になるのですが、参照ボタンから取得したディレクトリ内を表示する方法がわからないです。
以下のコードのチェックボックスツリー欄に取得したパスのディレクトリを表示したいのですが、どのようにすればよいでしょうか...（txtファイルのみチェックつけるなどの話は一旦置いておいて、ひとまず表示だけできるようにしたいです。）
大変申し訳ございませんがもし可能でしたらご教示いただきたいです。

from tkinter import *
from ttkwidgets import CheckboxTreeview
import tkinter as tk
from tkinter import messagebox
from tkinter import filedialog
import os
import glob

def dirdialog_clicked():
ini_dir = 'D:'
#iDir = os.path.abspath(os.path.dirname(__file__))
iDirPath = filedialog.askdirectory(initialdir = ini_dir)
entry1.set(iDirPath)

# 実行ボタン押下時の実行関数
def conductMain():
text = ""

dirPath = entry1.get()

if dirPath:
text += "フォルダパス：" + dirPath + "\n"

if text:
messagebox.showinfo("info", text)
else:
messagebox.showerror("error", "パスの指定がありません。")

root = Tk()
root.geometry('800x800')
root.title("サンプル")

#フレーム１
frame1 = Frame(root,bd=2,background="red",padx=10,pady=10)
frame1.pack(fill = "x")

label = Label(frame1, text="フォルダ参照＞＞", padx=5,pady=5)
label.pack(side=LEFT)
entry1 = StringVar()
IDirEntry = Entry(frame1, textvariable=entry1, width=50)
IDirEntry.pack(side=LEFT)
button1 = Button(frame1,text="参照", command=dirdialog_clicked)
button1.pack(fill = "x", side=LEFT)

#フレーム２
frame2 = Frame(root, bd=2,background="green",padx=5,pady=5)
frame2.pack(fill = "both")
#チェックボックスツリー
cktree = CheckboxTreeview(frame2)
cktree.grid(row=0, column=0)

scrollbar = Scrollbar(frame2, orient=tk.VERTICAL, command=cktree.yview)
cktree["yscrollcommand"] = scrollbar.set
scrollbar.grid(row=0, column=1, sticky=(tk.N, tk.S))

#フレーム３
frame3 = Frame(root,bd=2,background="blue",padx=10,pady=10)
frame3.pack(fill = "x")

button3_1 = Button(frame3,text="閉じる", command=quit)
button3_1.pack(fill = "x", side=RIGHT)
button3_2 = Button(frame3,text="実行", command=conductMain)
button3_2.pack(fill = "x", side=RIGHT)

root.mainloop()

[teamikl]

> 参照ボタンから取得したディレクトリ内を表示する方法

filedialog.askdirectory でディレクトリのパスが得られるので、
pathlib や glob モジュールを使いファイル一覧を得る → リストに追加

CheckboxTreeview は tkinter.ttk.Treeview を継承しているので、
使い方は ttk.Treeview を参考に、リストへの追加は cktree.insert("", tk.END, text="A")
といった感じですが、表示したい項目の要件次第では columns等 の設定等が必要になるかもしれません。

[mappys]

ありがとうございます！やってみます！ご丁寧に本当にありがとうございました！