Skip to content

StyleBuilderTK

A class for styling legacy tkinter widgets (not ttk).

The methods in this classed are used internally to update tk widget style configurations and are not intended to be called by the end user.

All legacy tkinter widgets are updated with a callback whenever the theme is changed. The color configuration of the widget is updated to match the current theme. Legacy ttk widgets are not the primary focus of this library, however, an attempt was made to make sure they did not stick out amongst ttk widgets if used.

Some ttk widgets contain legacy components that must be updated such as the Combobox popdown, so this ensures they are styled completely to match the current theme.

Source code in src/ttkbootstrap/style.py 
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
class StyleBuilderTK:
    """A class for styling legacy tkinter widgets (not ttk).

    The methods in this classed are used internally to update tk widget
    style configurations and are not intended to be called by the end
    user.

    All legacy tkinter widgets are updated with a callback whenever the
    theme is changed. The color configuration of the widget is updated
    to match the current theme. Legacy ttk widgets are not the primary
    focus of this library, however, an attempt was made to make sure they
    did not stick out amongst ttk widgets if used.

    Some ttk widgets contain legacy components that must be updated
    such as the Combobox popdown, so this ensures they are styled
    completely to match the current theme.
    """

    def __init__(self):
        self.style = Style.get_instance()
        self.master = self.style.master

    @property
    def theme(self) -> ThemeDefinition:
        """A reference to the `ThemeDefinition` object for the current
        theme."""
        return self.style.theme

    @property
    def colors(self) -> Colors:
        """A reference to the `Colors` object for the current theme."""
        return self.style.colors

    @property
    def is_light_theme(self) -> bool:
        """Returns `True` if the theme is _light_, otherwise `False`."""
        return self.style.theme.type == LIGHT

    def update_tk_style(self, widget: tk.Tk):
        """Update the window style.

        Parameters:

            widget (tkinter.Tk):
                The tk object to update.
        """
        widget.configure(background=self.colors.bg)
        # add default initial font for text widget
        widget.option_add('*Text*Font', 'TkDefaultFont')

    def update_toplevel_style(self, widget: tk.Toplevel):
        """Update the toplevel style.

        Parameters:

            widget (tkinter.Toplevel):
                The toplevel object to update.
        """
        widget.configure(background=self.colors.bg)

    def update_canvas_style(self, widget: tk.Canvas):
        """Update the canvas style.

        Parameters:

            widget (tkinter.Canvas):
                The canvas object to update.
        """
        # if self.is_light_theme:
        #     bordercolor = self.colors.border
        # else:
        #     bordercolor = self.colors.selectbg

        widget.configure(
            background=self.colors.bg,
            highlightthickness=0,
            # highlightbackground=bordercolor,
        )

    def update_button_style(self, widget: tk.Button):
        """Update the button style.

        Parameters:

            widget (tkinter.Button):
                The button object to update.
        """
        background = self.colors.primary
        foreground = self.colors.selectfg
        activebackground = Colors.update_hsv(self.colors.primary, vd=-0.1)

        widget.configure(
            background=background,
            foreground=foreground,
            relief=tk.FLAT,
            borderwidth=0,
            activebackground=activebackground,
            highlightbackground=self.colors.selectfg,
        )

    def update_label_style(self, widget: tk.Label):
        """Update the label style.

        Parameters:

            widget (tkinter.Label):
                The label object to update.
        """
        widget.configure(foreground=self.colors.fg, background=self.colors.bg)

    def update_frame_style(self, widget: tk.Frame):
        """Update the frame style.

        Parameters:

            widget (tkinter.Frame):
                The frame object to update.
        """
        widget.configure(background=self.colors.bg)

    def update_checkbutton_style(self, widget: tk.Checkbutton):
        """Update the checkbutton style.

        Parameters:

            widget (tkinter.Checkbutton):
                The checkbutton object to update.
        """
        widget.configure(
            activebackground=self.colors.bg,
            activeforeground=self.colors.primary,
            background=self.colors.bg,
            foreground=self.colors.fg,
            selectcolor=self.colors.bg,
        )

    def update_radiobutton_style(self, widget: tk.Radiobutton):
        """Update the radiobutton style.

        Parameters:

            widget (tkinter.Radiobutton):
                The radiobutton object to update.
        """
        widget.configure(
            activebackground=self.colors.bg,
            activeforeground=self.colors.primary,
            background=self.colors.bg,
            foreground=self.colors.fg,
            selectcolor=self.colors.bg,
        )

    def update_entry_style(self, widget: tk.Entry):
        """Update the entry style.

        Parameters:

            widget (tkinter.Entry):
                The entry object to update.
        """
        if self.is_light_theme:
            bordercolor = self.colors.border
        else:
            bordercolor = self.colors.selectbg

        widget.configure(
            relief=tk.FLAT,
            highlightthickness=1,
            foreground=self.colors.inputfg,
            highlightbackground=bordercolor,
            highlightcolor=self.colors.primary,
            background=self.colors.inputbg,
            insertbackground=self.colors.inputfg,
            insertwidth=1,
        )

    def update_scale_style(self, widget: tk.Scale):
        """Update the scale style.

        Parameters:

            widget (tkinter.scale):
                The scale object to update.
        """
        if self.is_light_theme:
            bordercolor = self.colors.border
        else:
            bordercolor = self.colors.selectbg

        activecolor = Colors.update_hsv(self.colors.primary, vd=-0.2)
        widget.configure(
            background=self.colors.primary,
            showvalue=False,
            sliderrelief=tk.FLAT,
            borderwidth=0,
            activebackground=activecolor,
            highlightthickness=1,
            highlightcolor=bordercolor,
            highlightbackground=bordercolor,
            troughcolor=self.colors.inputbg,
        )

    def update_spinbox_style(self, widget: tk.Spinbox):
        """Update the spinbox style.

        Parameters:

            widget (tkinter.Spinbox):
                THe spinbox object to update.
        """
        if self.is_light_theme:
            bordercolor = self.colors.border
        else:
            bordercolor = self.colors.selectbg

        widget.configure(
            relief=tk.FLAT,
            highlightthickness=1,
            foreground=self.colors.inputfg,
            highlightbackground=bordercolor,
            highlightcolor=self.colors.primary,
            background=self.colors.inputbg,
            buttonbackground=self.colors.inputbg,
            insertbackground=self.colors.inputfg,
            insertwidth=1,
            # these options should work, but do not have any affect
            buttonuprelief=tk.FLAT,
            buttondownrelief=tk.SUNKEN,
        )

    def update_listbox_style(self, widget: tk.Listbox):
        """Update the listbox style.

        Parameters:

            widget (tkinter.Listbox):
                The listbox object to update.
        """
        if self.is_light_theme:
            bordercolor = self.colors.border
        else:
            bordercolor = self.colors.selectbg

        widget.configure(
            foreground=self.colors.inputfg,
            background=self.colors.inputbg,
            selectbackground=self.colors.selectbg,
            selectforeground=self.colors.selectfg,
            highlightcolor=self.colors.primary,
            highlightbackground=bordercolor,
            highlightthickness=1,
            activestyle="none",
            relief=tk.FLAT,
        )

    def update_menubutton_style(self, widget: tk.Menubutton):
        """Update the menubutton style.

        Parameters:

            widget (tkinter.Menubutton):
                The menubutton object to update.
        """
        activebackground = Colors.update_hsv(self.colors.primary, vd=-0.2)
        widget.configure(
            background=self.colors.primary,
            foreground=self.colors.selectfg,
            activebackground=activebackground,
            activeforeground=self.colors.selectfg,
            borderwidth=0,
        )

    def update_menu_style(self, widget: tk.Menu):
        """Update the menu style.

        Parameters:

            widget (tkinter.Menu):
                The menu object to update.
        """
        widget.configure(
            tearoff=False,
            activebackground=self.colors.selectbg,
            activeforeground=self.colors.selectfg,
            foreground=self.colors.fg,
            selectcolor=self.colors.primary,
            background=self.colors.bg,
            relief=tk.FLAT,
            borderwidth=0,
        )

    def update_labelframe_style(self, widget: tk.LabelFrame):
        """Update the labelframe style.

        Parameters:

            widget (tkinter.LabelFrame):
                The labelframe object to update.
        """
        if self.is_light_theme:
            bordercolor = self.colors.border
        else:
            bordercolor = self.colors.selectbg

        widget.configure(
            highlightcolor=bordercolor,
            foreground=self.colors.fg,
            borderwidth=1,
            highlightthickness=0,
            background=self.colors.bg,
        )

    def update_text_style(self, widget: tk.Text):
        """Update the text style.

        Parameters:

            widget (tkinter.Text):
                The text object to update.
        """
        if self.is_light_theme:
            bordercolor = self.colors.border
        else:
            bordercolor = self.colors.selectbg

        focuscolor = widget.cget("highlightbackground")

        if focuscolor in ["SystemButtonFace", bordercolor]:
            focuscolor = bordercolor

        widget.configure(
            background=self.colors.inputbg,
            foreground=self.colors.inputfg,
            highlightcolor=focuscolor,
            highlightbackground=bordercolor,
            insertbackground=self.colors.inputfg,
            selectbackground=self.colors.selectbg,
            selectforeground=self.colors.selectfg,
            insertwidth=1,
            highlightthickness=1,
            relief=tk.FLAT,
            padx=5,
            pady=5,
            # font="TkDefaultFont",
        )

colors property

A reference to the Colors object for the current theme.

is_light_theme property

Returns True if the theme is light, otherwise False.

theme property

A reference to the ThemeDefinition object for the current theme.

update_button_style(widget)

Update the button style.

Parameters:

widget (tkinter.Button):
    The button object to update.
Source code in src/ttkbootstrap/style.py 
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
def update_button_style(self, widget: tk.Button):
    """Update the button style.

    Parameters:

        widget (tkinter.Button):
            The button object to update.
    """
    background = self.colors.primary
    foreground = self.colors.selectfg
    activebackground = Colors.update_hsv(self.colors.primary, vd=-0.1)

    widget.configure(
        background=background,
        foreground=foreground,
        relief=tk.FLAT,
        borderwidth=0,
        activebackground=activebackground,
        highlightbackground=self.colors.selectfg,
    )

update_canvas_style(widget)

Update the canvas style.

Parameters:

widget (tkinter.Canvas):
    The canvas object to update.
Source code in src/ttkbootstrap/style.py 
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
def update_canvas_style(self, widget: tk.Canvas):
    """Update the canvas style.

    Parameters:

        widget (tkinter.Canvas):
            The canvas object to update.
    """
    # if self.is_light_theme:
    #     bordercolor = self.colors.border
    # else:
    #     bordercolor = self.colors.selectbg

    widget.configure(
        background=self.colors.bg,
        highlightthickness=0,
        # highlightbackground=bordercolor,
    )

update_checkbutton_style(widget)

Update the checkbutton style.

Parameters:

widget (tkinter.Checkbutton):
    The checkbutton object to update.
Source code in src/ttkbootstrap/style.py 
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
def update_checkbutton_style(self, widget: tk.Checkbutton):
    """Update the checkbutton style.

    Parameters:

        widget (tkinter.Checkbutton):
            The checkbutton object to update.
    """
    widget.configure(
        activebackground=self.colors.bg,
        activeforeground=self.colors.primary,
        background=self.colors.bg,
        foreground=self.colors.fg,
        selectcolor=self.colors.bg,
    )

update_entry_style(widget)

Update the entry style.

Parameters:

widget (tkinter.Entry):
    The entry object to update.
Source code in src/ttkbootstrap/style.py 
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
def update_entry_style(self, widget: tk.Entry):
    """Update the entry style.

    Parameters:

        widget (tkinter.Entry):
            The entry object to update.
    """
    if self.is_light_theme:
        bordercolor = self.colors.border
    else:
        bordercolor = self.colors.selectbg

    widget.configure(
        relief=tk.FLAT,
        highlightthickness=1,
        foreground=self.colors.inputfg,
        highlightbackground=bordercolor,
        highlightcolor=self.colors.primary,
        background=self.colors.inputbg,
        insertbackground=self.colors.inputfg,
        insertwidth=1,
    )

update_frame_style(widget)

Update the frame style.

Parameters:

widget (tkinter.Frame):
    The frame object to update.
Source code in src/ttkbootstrap/style.py 
1033
1034
1035
1036
1037
1038
1039
1040
1041
def update_frame_style(self, widget: tk.Frame):
    """Update the frame style.

    Parameters:

        widget (tkinter.Frame):
            The frame object to update.
    """
    widget.configure(background=self.colors.bg)

update_label_style(widget)

Update the label style.

Parameters:

widget (tkinter.Label):
    The label object to update.
Source code in src/ttkbootstrap/style.py 
1023
1024
1025
1026
1027
1028
1029
1030
1031
def update_label_style(self, widget: tk.Label):
    """Update the label style.

    Parameters:

        widget (tkinter.Label):
            The label object to update.
    """
    widget.configure(foreground=self.colors.fg, background=self.colors.bg)

update_labelframe_style(widget)

Update the labelframe style.

Parameters:

widget (tkinter.LabelFrame):
    The labelframe object to update.
Source code in src/ttkbootstrap/style.py 
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
def update_labelframe_style(self, widget: tk.LabelFrame):
    """Update the labelframe style.

    Parameters:

        widget (tkinter.LabelFrame):
            The labelframe object to update.
    """
    if self.is_light_theme:
        bordercolor = self.colors.border
    else:
        bordercolor = self.colors.selectbg

    widget.configure(
        highlightcolor=bordercolor,
        foreground=self.colors.fg,
        borderwidth=1,
        highlightthickness=0,
        background=self.colors.bg,
    )

update_listbox_style(widget)

Update the listbox style.

Parameters:

widget (tkinter.Listbox):
    The listbox object to update.
Source code in src/ttkbootstrap/style.py 
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
def update_listbox_style(self, widget: tk.Listbox):
    """Update the listbox style.

    Parameters:

        widget (tkinter.Listbox):
            The listbox object to update.
    """
    if self.is_light_theme:
        bordercolor = self.colors.border
    else:
        bordercolor = self.colors.selectbg

    widget.configure(
        foreground=self.colors.inputfg,
        background=self.colors.inputbg,
        selectbackground=self.colors.selectbg,
        selectforeground=self.colors.selectfg,
        highlightcolor=self.colors.primary,
        highlightbackground=bordercolor,
        highlightthickness=1,
        activestyle="none",
        relief=tk.FLAT,
    )

update_menu_style(widget)

Update the menu style.

Parameters:

widget (tkinter.Menu):
    The menu object to update.
Source code in src/ttkbootstrap/style.py 
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
def update_menu_style(self, widget: tk.Menu):
    """Update the menu style.

    Parameters:

        widget (tkinter.Menu):
            The menu object to update.
    """
    widget.configure(
        tearoff=False,
        activebackground=self.colors.selectbg,
        activeforeground=self.colors.selectfg,
        foreground=self.colors.fg,
        selectcolor=self.colors.primary,
        background=self.colors.bg,
        relief=tk.FLAT,
        borderwidth=0,
    )

update_menubutton_style(widget)

Update the menubutton style.

Parameters:

widget (tkinter.Menubutton):
    The menubutton object to update.
Source code in src/ttkbootstrap/style.py 
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
def update_menubutton_style(self, widget: tk.Menubutton):
    """Update the menubutton style.

    Parameters:

        widget (tkinter.Menubutton):
            The menubutton object to update.
    """
    activebackground = Colors.update_hsv(self.colors.primary, vd=-0.2)
    widget.configure(
        background=self.colors.primary,
        foreground=self.colors.selectfg,
        activebackground=activebackground,
        activeforeground=self.colors.selectfg,
        borderwidth=0,
    )

update_radiobutton_style(widget)

Update the radiobutton style.

Parameters:

widget (tkinter.Radiobutton):
    The radiobutton object to update.
Source code in src/ttkbootstrap/style.py 
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
def update_radiobutton_style(self, widget: tk.Radiobutton):
    """Update the radiobutton style.

    Parameters:

        widget (tkinter.Radiobutton):
            The radiobutton object to update.
    """
    widget.configure(
        activebackground=self.colors.bg,
        activeforeground=self.colors.primary,
        background=self.colors.bg,
        foreground=self.colors.fg,
        selectcolor=self.colors.bg,
    )

update_scale_style(widget)

Update the scale style.

Parameters:

widget (tkinter.scale):
    The scale object to update.
Source code in src/ttkbootstrap/style.py 
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
def update_scale_style(self, widget: tk.Scale):
    """Update the scale style.

    Parameters:

        widget (tkinter.scale):
            The scale object to update.
    """
    if self.is_light_theme:
        bordercolor = self.colors.border
    else:
        bordercolor = self.colors.selectbg

    activecolor = Colors.update_hsv(self.colors.primary, vd=-0.2)
    widget.configure(
        background=self.colors.primary,
        showvalue=False,
        sliderrelief=tk.FLAT,
        borderwidth=0,
        activebackground=activecolor,
        highlightthickness=1,
        highlightcolor=bordercolor,
        highlightbackground=bordercolor,
        troughcolor=self.colors.inputbg,
    )

update_spinbox_style(widget)

Update the spinbox style.

Parameters:

widget (tkinter.Spinbox):
    THe spinbox object to update.
Source code in src/ttkbootstrap/style.py 
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
def update_spinbox_style(self, widget: tk.Spinbox):
    """Update the spinbox style.

    Parameters:

        widget (tkinter.Spinbox):
            THe spinbox object to update.
    """
    if self.is_light_theme:
        bordercolor = self.colors.border
    else:
        bordercolor = self.colors.selectbg

    widget.configure(
        relief=tk.FLAT,
        highlightthickness=1,
        foreground=self.colors.inputfg,
        highlightbackground=bordercolor,
        highlightcolor=self.colors.primary,
        background=self.colors.inputbg,
        buttonbackground=self.colors.inputbg,
        insertbackground=self.colors.inputfg,
        insertwidth=1,
        # these options should work, but do not have any affect
        buttonuprelief=tk.FLAT,
        buttondownrelief=tk.SUNKEN,
    )

update_text_style(widget)

Update the text style.

Parameters:

widget (tkinter.Text):
    The text object to update.
Source code in src/ttkbootstrap/style.py 
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
def update_text_style(self, widget: tk.Text):
    """Update the text style.

    Parameters:

        widget (tkinter.Text):
            The text object to update.
    """
    if self.is_light_theme:
        bordercolor = self.colors.border
    else:
        bordercolor = self.colors.selectbg

    focuscolor = widget.cget("highlightbackground")

    if focuscolor in ["SystemButtonFace", bordercolor]:
        focuscolor = bordercolor

    widget.configure(
        background=self.colors.inputbg,
        foreground=self.colors.inputfg,
        highlightcolor=focuscolor,
        highlightbackground=bordercolor,
        insertbackground=self.colors.inputfg,
        selectbackground=self.colors.selectbg,
        selectforeground=self.colors.selectfg,
        insertwidth=1,
        highlightthickness=1,
        relief=tk.FLAT,
        padx=5,
        pady=5,
        # font="TkDefaultFont",
    )

update_tk_style(widget)

Update the window style.

Parameters:

widget (tkinter.Tk):
    The tk object to update.
Source code in src/ttkbootstrap/style.py 
961
962
963
964
965
966
967
968
969
970
971
def update_tk_style(self, widget: tk.Tk):
    """Update the window style.

    Parameters:

        widget (tkinter.Tk):
            The tk object to update.
    """
    widget.configure(background=self.colors.bg)
    # add default initial font for text widget
    widget.option_add('*Text*Font', 'TkDefaultFont')

update_toplevel_style(widget)

Update the toplevel style.

Parameters:

widget (tkinter.Toplevel):
    The toplevel object to update.
Source code in src/ttkbootstrap/style.py 
973
974
975
976
977
978
979
980
981
def update_toplevel_style(self, widget: tk.Toplevel):
    """Update the toplevel style.

    Parameters:

        widget (tkinter.Toplevel):
            The toplevel object to update.
    """
    widget.configure(background=self.colors.bg)