CustomTkinter/customtkinter/widgets/widget_base_class.py

244 lines
10 KiB
Python
Raw Normal View History

import tkinter
import tkinter.ttk as ttk
2022-04-21 19:34:58 +03:00
import copy
import re
2022-05-23 08:51:09 +03:00
from typing import Callable, Union
try:
from typing import TypedDict
except ImportError:
from typing_extensions import TypedDict
2022-05-02 00:29:14 +03:00
from ..windows.ctk_tk import CTk
from ..windows.ctk_toplevel import CTkToplevel
from ..appearance_mode_tracker import AppearanceModeTracker
2022-04-21 19:34:58 +03:00
from ..scaling_tracker import ScalingTracker
from ..theme_manager import ThemeManager
class CTkBaseClass(tkinter.Frame):
2022-05-31 23:32:21 +03:00
""" Base class of every Ctk widget, handles the dimensions, bg_color,
appearance_mode changes, scaling, bg changes of master if master is not a CTk widget """
def __init__(self,
*args,
bg_color: Union[str, tuple] = None,
width: int,
height: int,
**kwargs):
super().__init__(*args, width=width, height=height, **kwargs) # set desired size of underlying tkinter.Frame
2022-05-31 23:32:21 +03:00
# dimensions
self._current_width = width # _current_width and _current_height in pixel, represent current size of the widget
self._current_height = height # _current_width and _current_height are independent of the scale
self._desired_width = width # _desired_width and _desired_height, represent desired size set by width and height
self._desired_height = height
2022-04-21 19:34:58 +03:00
2022-05-31 23:32:21 +03:00
# scaling
ScalingTracker.add_widget(self.set_scaling, self) # add callback for automatic scaling changes
self._widget_scaling = ScalingTracker.get_widget_scaling(self)
self._spacing_scaling = ScalingTracker.get_spacing_scaling(self)
2022-05-02 00:29:14 +03:00
2022-05-31 23:32:21 +03:00
super().configure(width=self.apply_widget_scaling(self._desired_width),
height=self.apply_widget_scaling(self._desired_height))
2022-05-02 00:38:02 +03:00
2022-05-02 00:29:14 +03:00
# save latest geometry function and kwargs
class GeometryCallDict(TypedDict):
function: Callable
kwargs: dict
2022-05-31 23:32:21 +03:00
self._last_geometry_manager_call: Union[GeometryCallDict, None] = None
# add set_appearance_mode method to callback list of AppearanceModeTracker for appearance mode changes
AppearanceModeTracker.add(self.set_appearance_mode, self)
2022-05-31 23:32:21 +03:00
self._appearance_mode = AppearanceModeTracker.get_mode() # 0: "Light" 1: "Dark"
# background color
self.bg_color = self.detect_color_of_master() if bg_color is None else bg_color
2022-05-31 23:32:21 +03:00
super().configure(bg=ThemeManager.single_color(self.bg_color, self._appearance_mode))
2022-04-21 19:34:58 +03:00
2022-05-31 23:32:21 +03:00
# overwrite configure methods of master when master is tkinter widget, so that bg changes get applied on child CTk widget as well
if isinstance(self.master, (tkinter.Tk, tkinter.Toplevel, tkinter.Frame)) and not isinstance(self.master, (CTkBaseClass, CTk, CTkToplevel)):
master_old_configure = self.master.config
def new_configure(*args, **kwargs):
if "bg" in kwargs:
self.configure(bg_color=kwargs["bg"])
elif "background" in kwargs:
self.configure(bg_color=kwargs["background"])
# args[0] is dict when attribute gets changed by widget[<attribute>] syntax
elif len(args) > 0 and type(args[0]) == dict:
if "bg" in args[0]:
self.configure(bg_color=args[0]["bg"])
elif "background" in args[0]:
self.configure(bg_color=args[0]["background"])
master_old_configure(*args, **kwargs)
self.master.config = new_configure
self.master.configure = new_configure
def destroy(self):
AppearanceModeTracker.remove(self.set_appearance_mode)
super().destroy()
2022-05-02 00:29:14 +03:00
def place(self, **kwargs):
2022-05-31 23:32:21 +03:00
self._last_geometry_manager_call = {"function": super().place, "kwargs": kwargs}
2022-05-02 00:29:14 +03:00
super().place(**self.apply_argument_scaling(kwargs))
def pack(self, **kwargs):
2022-05-31 23:32:21 +03:00
self._last_geometry_manager_call = {"function": super().pack, "kwargs": kwargs}
2022-05-02 00:29:14 +03:00
super().pack(**self.apply_argument_scaling(kwargs))
def grid(self, **kwargs):
2022-05-31 23:32:21 +03:00
self._last_geometry_manager_call = {"function": super().grid, "kwargs": kwargs}
2022-05-02 00:29:14 +03:00
super().grid(**self.apply_argument_scaling(kwargs))
def apply_argument_scaling(self, kwargs: dict) -> dict:
scaled_kwargs = copy.copy(kwargs)
if "pady" in scaled_kwargs:
if isinstance(scaled_kwargs["pady"], (int, float, str)):
scaled_kwargs["pady"] = self.apply_spacing_scaling(scaled_kwargs["pady"])
elif isinstance(scaled_kwargs["pady"], tuple):
scaled_kwargs["pady"] = tuple([self.apply_spacing_scaling(v) for v in scaled_kwargs["pady"]])
if "padx" in kwargs:
if isinstance(scaled_kwargs["padx"], (int, float, str)):
scaled_kwargs["padx"] = self.apply_spacing_scaling(scaled_kwargs["padx"])
elif isinstance(scaled_kwargs["padx"], tuple):
scaled_kwargs["padx"] = tuple([self.apply_spacing_scaling(v) for v in scaled_kwargs["padx"]])
if "x" in scaled_kwargs:
scaled_kwargs["x"] = self.apply_spacing_scaling(scaled_kwargs["x"])
if "y" in scaled_kwargs:
scaled_kwargs["y"] = self.apply_spacing_scaling(scaled_kwargs["y"])
return scaled_kwargs
def config(self, *args, **kwargs):
self.configure(*args, **kwargs)
def configure(self, *args, **kwargs):
""" basic configure with bg_color support, to be overridden """
require_redraw = False
if "bg_color" in kwargs:
if kwargs["bg_color"] is None:
self.bg_color = self.detect_color_of_master()
else:
self.bg_color = kwargs["bg_color"]
require_redraw = True
del kwargs["bg_color"]
super().configure(*args, **kwargs)
if require_redraw:
self.draw()
2022-04-21 19:34:58 +03:00
def update_dimensions_event(self, event):
# only redraw if dimensions changed (for performance)
2022-05-31 23:32:21 +03:00
if round(self._current_width) != round(event.width / self._widget_scaling) or round(self._current_height) != round(event.height / self._widget_scaling):
self._current_width = (event.width / self._widget_scaling) # adjust current size according to new size given by event
self._current_height = (event.height / self._widget_scaling) # _current_width and _current_height are independent of the scale
self.draw(no_color_updates=True) # faster drawing without color changes
def detect_color_of_master(self, master_widget=None):
""" detect color of self.master widget to set correct bg_color """
if master_widget is None:
master_widget = self.master
if isinstance(master_widget, CTkBaseClass) and hasattr(master_widget, "fg_color"): # master is CTkFrame
if master_widget.fg_color is not None:
return master_widget.fg_color
# if fg_color of master is None, try to retrieve fg_color from master of master
elif hasattr(master_widget.master, "master"):
return self.detect_color_of_master(self.master.master)
elif isinstance(master_widget, (ttk.Frame, ttk.LabelFrame, ttk.Notebook)): # master is ttk widget
try:
ttk_style = ttk.Style()
return ttk_style.lookup(master_widget.winfo_class(), 'background')
except Exception:
return "#FFFFFF", "#000000"
else: # master is normal tkinter widget
try:
return master_widget.cget("bg") # try to get bg color by .cget() method
except Exception:
return "#FFFFFF", "#000000"
def set_appearance_mode(self, mode_string):
if mode_string.lower() == "dark":
2022-05-31 23:32:21 +03:00
self._appearance_mode = 1
elif mode_string.lower() == "light":
2022-05-31 23:32:21 +03:00
self._appearance_mode = 0
if isinstance(self.master, (CTkBaseClass, CTk)) and hasattr(self.master, "fg_color"):
self.bg_color = self.master.fg_color
else:
self.bg_color = self.master.cget("bg")
self.draw()
2022-05-02 00:29:14 +03:00
def set_scaling(self, new_widget_scaling, new_spacing_scaling, new_window_scaling):
2022-05-31 23:32:21 +03:00
self._widget_scaling = new_widget_scaling
self._spacing_scaling = new_spacing_scaling
2022-05-02 00:29:14 +03:00
2022-05-31 23:32:21 +03:00
super().configure(width=self.apply_widget_scaling(self._desired_width),
height=self.apply_widget_scaling(self._desired_height))
2022-05-02 00:29:14 +03:00
2022-05-31 23:32:21 +03:00
if self._last_geometry_manager_call is not None:
self._last_geometry_manager_call["function"](**self.apply_argument_scaling(self._last_geometry_manager_call["kwargs"]))
2022-04-21 19:34:58 +03:00
def set_dimensions(self, width=None, height=None):
if width is not None:
2022-05-31 23:32:21 +03:00
self._desired_width = width
if height is not None:
2022-05-31 23:32:21 +03:00
self._desired_height = height
2022-05-31 23:32:21 +03:00
super().configure(width=self.apply_widget_scaling(self._desired_width),
height=self.apply_widget_scaling(self._desired_height))
2022-05-31 23:32:21 +03:00
def apply_widget_scaling(self, value: Union[int, float, str]) -> Union[float, str]:
2022-05-02 00:29:14 +03:00
if isinstance(value, (int, float)):
2022-05-31 23:32:21 +03:00
return value * self._widget_scaling
2022-05-02 00:29:14 +03:00
else:
return value
2022-05-31 23:32:21 +03:00
def apply_spacing_scaling(self, value: Union[int, float, str]) -> Union[float, str]:
2022-05-02 00:29:14 +03:00
if isinstance(value, (int, float)):
2022-05-31 23:32:21 +03:00
return value * self._spacing_scaling
2022-05-02 00:29:14 +03:00
else:
return value
2022-04-21 19:34:58 +03:00
def apply_font_scaling(self, font):
if type(font) == tuple or type(font) == list:
font_list = list(font)
for i in range(len(font_list)):
if (type(font_list[i]) == int or type(font_list[i]) == float) and font_list[i] < 0:
2022-05-31 23:32:21 +03:00
font_list[i] = int(font_list[i] * self._widget_scaling)
2022-04-21 19:34:58 +03:00
return tuple(font_list)
elif type(font) == str:
for negative_number in re.findall(r" -\d* ", font):
2022-05-31 23:32:21 +03:00
font = font.replace(negative_number, f" {int(int(negative_number) * self._widget_scaling)} ")
2022-04-21 19:34:58 +03:00
return font
elif isinstance(font, tkinter.font.Font):
new_font_object = copy.copy(font)
if font.cget("size") < 0:
2022-05-31 23:32:21 +03:00
new_font_object.config(size=int(font.cget("size") * self._widget_scaling))
2022-04-21 19:34:58 +03:00
return new_font_object
else:
return font
2022-05-31 23:32:21 +03:00
def draw(self, no_color_updates: bool = False):
""" abstract of draw method to be overridden """
pass