117 lines
5.1 KiB
Python
117 lines
5.1 KiB
Python
from typing import Tuple, Dict, Callable, List
|
|
try:
|
|
from PIL import Image, ImageTk
|
|
except ImportError:
|
|
pass
|
|
|
|
|
|
class CTkImage:
|
|
"""
|
|
Class to store one or two PIl.Image.Image objects and display size independent of scaling:
|
|
|
|
light_image: PIL.Image.Image for light mode
|
|
dark_image: PIL.Image.Image for dark mode
|
|
size: tuple (<width>, <height>) with display size for both images
|
|
|
|
One of the two images can be None and will be replaced by the other image.
|
|
"""
|
|
|
|
_checked_PIL_import = False
|
|
|
|
def __init__(self, light_image: Image.Image = None, dark_image: Image.Image = None, size: Tuple[int, int] = None):
|
|
if not self._checked_PIL_import:
|
|
self._check_pil_import()
|
|
|
|
self._light_image = light_image
|
|
self._dark_image = dark_image
|
|
self._check_images()
|
|
self._size = size
|
|
|
|
self._configure_callback_list: List[Callable] = []
|
|
self._scaled_light_photo_images: Dict[Tuple[int, int], ImageTk.PhotoImage] = {}
|
|
self._scaled_dark_photo_images: Dict[Tuple[int, int], ImageTk.PhotoImage] = {}
|
|
|
|
@classmethod
|
|
def _check_pil_import(cls):
|
|
if "Image" not in dir() or "ImageTk" not in dir():
|
|
raise ImportError("CTkImage: Couldn't import PIL.Image or PIL.ImageTk. PIL must be installed.")
|
|
|
|
def add_configure_callback(self, callback: Callable):
|
|
""" add function, that gets called when image got configured """
|
|
self._configure_callback_list.append(callback)
|
|
|
|
def remove_configure_callback(self, callback: Callable):
|
|
""" remove function, that gets called when image got configured """
|
|
self._configure_callback_list.remove(callback)
|
|
|
|
def configure(self, **kwargs):
|
|
if "light_image" in kwargs:
|
|
self._light_image = kwargs.pop("light_image")
|
|
self._scaled_light_photo_images = {}
|
|
self._check_images()
|
|
if "dark_image" in kwargs:
|
|
self._dark_image = kwargs.pop("dark_image")
|
|
self._scaled_dark_photo_images = {}
|
|
self._check_images()
|
|
if "size" in kwargs:
|
|
self._size = kwargs.pop("size")
|
|
|
|
# call all functions registered with add_configure_callback()
|
|
for callback in self._configure_callback_list:
|
|
callback()
|
|
|
|
def cget(self, attribute_name: str) -> any:
|
|
if attribute_name == "light_image":
|
|
return self._light_image
|
|
if attribute_name == "dark_image":
|
|
return self._dark_image
|
|
if attribute_name == "size":
|
|
return self._size
|
|
|
|
def _check_images(self):
|
|
# check types
|
|
if self._light_image is not None and not isinstance(self._light_image, Image.Image):
|
|
raise ValueError(f"CTkImage: light_image must be instance if PIL.Image.Image, not {type(self._light_image)}")
|
|
if self._dark_image is not None and not isinstance(self._dark_image, Image.Image):
|
|
raise ValueError(f"CTkImage: dark_image must be instance if PIL.Image.Image, not {type(self._dark_image)}")
|
|
|
|
# check values
|
|
if self._light_image is None and self._dark_image is None:
|
|
raise ValueError("CTkImage: No image given, light_image is None and dark_image is None.")
|
|
|
|
# check sizes
|
|
if self._light_image is not None and self._dark_image is not None and self._light_image.size != self._dark_image.size:
|
|
raise ValueError(f"CTkImage: light_image size {self._light_image.size} must be the same as dark_image size {self._dark_image.size}.")
|
|
|
|
def _get_scaled_size(self, widget_scaling: float) -> Tuple[int, int]:
|
|
return round(self._size[0] * widget_scaling), round(self._size[0] * widget_scaling)
|
|
|
|
def _get_scaled_light_photo_image(self, scaled_size: Tuple[int, int]) -> ImageTk.PhotoImage:
|
|
if scaled_size in self._scaled_light_photo_images:
|
|
return self._scaled_light_photo_images[scaled_size]
|
|
else:
|
|
self._scaled_light_photo_images[scaled_size] = ImageTk.PhotoImage(self._light_image.resize(scaled_size))
|
|
return self._scaled_light_photo_images[scaled_size]
|
|
|
|
def _get_scaled_dark_photo_image(self, scaled_size: Tuple[int, int]) -> ImageTk.PhotoImage:
|
|
if scaled_size in self._scaled_dark_photo_images:
|
|
return self._scaled_dark_photo_images[scaled_size]
|
|
else:
|
|
self._scaled_dark_photo_images[scaled_size] = ImageTk.PhotoImage(self._dark_image.resize(scaled_size))
|
|
return self._scaled_dark_photo_images[scaled_size]
|
|
|
|
def create_scaled_photo_image(self, widget_scaling: float, appearance_mode: int) -> ImageTk.PhotoImage:
|
|
scaled_size = self._get_scaled_size(widget_scaling)
|
|
|
|
if appearance_mode == 0 and self._light_image is not None:
|
|
return self._get_scaled_light_photo_image(scaled_size)
|
|
elif appearance_mode == 0 and self._light_image is None:
|
|
return self._get_scaled_dark_photo_image(scaled_size)
|
|
|
|
elif appearance_mode == 1 and self._dark_image is not None:
|
|
return self._get_scaled_dark_photo_image(scaled_size)
|
|
elif appearance_mode == 1 and self._dark_image is None:
|
|
return self._get_scaled_light_photo_image(scaled_size)
|
|
|
|
|