如何获取Tkinter ttk控件的全部可配置样式选项

问题描述 #

• 需求为查看ttk控件所有支持修改的样式配置选项，最初使用style.layout()方法查询，无法确认是否返回了全部可配置项。
• 修改ttk.Labelframe标签的前景色（fg）与背景色（bg）时，在style.layout()的返回结果中找不到对应配置项；后续验证可通过style.config(TLabelframe.Label, **options)实现该需求且运行正常，但该配置项未在控制台输出，控制台本身无异常，初步判断为查询方法调用有误。
• 使用完全相同的打印语句查询TButton时可正常获取所有配置项，但输出中始终找不到TLabelframe.Label相关内容，需要明确问题原因，以及获取指定控件全部可用样式配置选项的正确方法。

测试代码 #

import tkinter as tk
from tkinter import ttk
from pprint import pprint
from tkinter.font import Font


root = tk.Tk()

lf = ttk.Labelframe(root, text='Labelframe')
btn = ttk.Button(lf, text='Whatever')
btn_font = Font(
    family='Helvetica',
    size=20,
    weight='bold',
    underline=True
)

style = ttk.Style()
style.configure(
    'TButton', font=btn_font,
    foreground='white',
    background='black',
    width=20
)

lf.pack()
btn.pack()

print('----Labelframe----')
print(lf.winfo_class()) 
print(style.layout('TLabelframe'))
print('\nLabelframe.border\n')
print(style.element_options('Labelframe.border'))
print(style.map('TLabelframe'))
print(style.element_options('Labelframe.Label'))

print('----Button----')
print(f'Type:  {type(btn)}')
print(f'Class: {btn.winfo_class()}')
print(f'Layout: {style.layout(btn.winfo_class())}')
btn_label =style.element_options('Button.label')
print(f'Button.label   --->   {btn_label}')
btn_focus = style.element_options('Button.focus')
btn_pad = style.element_options('Button.padding')
btn_border = style.element_options('Button.border')
print(f'Button.focus   --->   {btn_focus}')
print(f'Button.border   --->   {btn_border}')
print(f'Button.padding   --->   {btn_pad}')
print(style.map('TButton'))

root.mainloop()

运行输出 #

----Labelframe----
TLabelframe
[('Labelframe.border', {'sticky': 'nswe'})]

Labelframe.border

('background', 'borderwidth', 'relief')
{}
()
----Button----
Type:  <class 'tkinter.ttk.Button'>
Class: TButton
Layout: [('Button.border', {'sticky': 'nswe', 'border': '1', 'children': [('Button.focus', {'sticky': 'nswe', 'children': [('Button.padding', {'sticky': 'nswe', 'children': [('Button.label', {'sticky': 'nswe'})]})]})]})]
Button.label   --->   ('compound', 'space', 'text', 'font', 'foreground', 'underline', 'width', 'anchor', 'justify', 'wraplength', 'embossed', 'image', 'stipple', 'background')
Button.focus   --->   ('focuscolor', 'focusthickness')
Button.border   --->   ('background', 'borderwidth', 'relief')
Button.padding   --->   ('padding', 'relief', 'shiftrelief')
{'relief': [('!disabled', 'pressed', 'sunken')]}

问题原因与正确查询方法 #

• 核心原因：ttk样式采用懒加载机制，TLabelframe.Label是独立于TLabelframe主类的子样式，默认主题下TLabelframe的layout返回结果不会直接嵌套展示标签元素，未主动触发该子样式加载时，调用style.element_options('Labelframe.Label')只会返回空元组。而TButton的所有子元素都在主类layout中嵌套定义，查询主类时会自动加载所有关联子元素，因此能直接拿到全部配置项。
• 全量样式配置的正确查询流程：
  1. 先通过控件的winfo_class()方法拿到主样式类名
  2. 除主样式类外，主动查询该控件对应的所有关联子样式类的layout，比如Labelframe需要额外查询TLabelframe.Label，Scrollbar需要额外查询对应方向的滚动条滑块等子样式
  3. 提取所有layout返回结果中的元素名，逐个调用style.element_options(元素名)，即可拿到该元素支持的所有可配置选项
  4. 状态相关的动态配置（比如按下、禁用状态的样式）通过style.map(样式类名)查询
• 验证方式：在现有测试代码中先执行print(style.layout('TLabelframe.Label'))触发子样式加载，再调用style.element_options('Labelframe.Label')，就能拿到包含foreground、background、font在内的全部标签可配置项，和Button.label返回的选项结构一致。

内容的提问来源于stack exchange，提问作者KeyShoe