Directory treeview with filetype filter and checkbox using ttk

Question

I have a GUI in python using Tkinter with multiple frames inside the main GUI. Added another frame to show a treeview of a directory (which will have sub directories as well) and filter to show only files of specific type. Then user selects file(s) by clicking on the checkbox shown to the left of every file to do further processing. I started off with this sample. Is it possible to use ttk treeview with a checkbox to the left of each entry like in tix as shown here?

Basically would like to have all the subitems auto checked when a folder is checked etc. Just like how a windows explorer dialogs work.

any suggestions?

Answer 1

This is possible with the CheckboxTreeview widget from the ttkwidgets module. The documentation is available here.

CheckboxTreeview inherits from ttk.Treeview, so you can create a column for the file size just like in a regular ttk.Treeview, with the columns option. Then you can set the columns' labels with the

tree.heading(<column>, text=<label>)

Finally if you want to change the style of the checkboxes, you can do so by replacing them with you own images. The 3 checkbox states are done using the images: tree.im_checked, tree.im_unchecked, tree.im_tristate. You can replace them with

tree.im_checked.paste(<new PIL image>)

Here is the full code:

from ttkwidgets import CheckboxTreeview
import tkinter as tk
from PIL import Image

root = tk.Tk()

tree = CheckboxTreeview(root, columns=['Size'])
tree.im_checked.paste(Image.open('path/to/image'))
tree.im_unchecked.paste(Image.open('path/to/image'))
tree.im_tristate.paste(Image.open('path/to/image'))
tree.pack()

tree.heading('#0', text='Directory structure', anchor='w')
tree.heading('#1', text='File size', anchor='w')
tree.insert("", "end", "1", text="1")
tree.insert("1", "end", "11", text="11")
tree.insert("1", "end", "12",  text="12", values=['2 bytes'])
tree.insert("11", "end", "111", text="111", values=['100 bytes'])
tree.insert("", "end", "2", text="2", values=['20 bytes'])

root.mainloop()