CustomTkinter/customtkinter/widgets/ctk_label.py

import tkinter
from typing import Union, Tuple, Callable

from .ctk_canvas import CTkCanvas
from ..theme_manager import ThemeManager
from ..draw_engine import DrawEngine
from .widget_base_class import CTkBaseClass

from .widget_helper_functions import pop_from_dict_by_set


class CTkLabel(CTkBaseClass):
    """
    Label with rounded corners. Default is fg_color=None (transparent fg_color).
    For detailed information check out the documentation.
    """

    # attributes that are passed to and managed by the tkinter entry only:
    _valid_tk_label_attributes = {"compound", "cursor", "image", "justify", "padx", "pady",
                                  "textvariable", "state", "takefocus", "underline", "wraplength"}

    def __init__(self,
                 master: any = None,
                 width: int = 140,
                 height: int = 28,
                 corner_radius: Union[int, str] = "default_theme",

                 bg_color: Union[str, Tuple[str, str], None] = None,
                 fg_color: Union[str, Tuple[str, str], None] = "default_theme",
                 text_color: Union[str, Tuple[str, str]] = "default_theme",

                 text: str = "CTkLabel",
                 font: any = "default_theme",
                 anchor: str = "center",  # label anchor: center, n, e, s, w
                 **kwargs):

        # transfer basic functionality (_bg_color, size, _appearance_mode, scaling) to CTkBaseClass
        super().__init__(master=master, bg_color=bg_color, width=width, height=height)

        # color
        self._fg_color = ThemeManager.theme["color"]["label"] if fg_color == "default_theme" else fg_color
        self._text_color = ThemeManager.theme["color"]["text"] if text_color == "default_theme" else text_color

        # shape
        self._corner_radius = ThemeManager.theme["shape"]["label_corner_radius"] if corner_radius == "default_theme" else corner_radius

        # text
        self._anchor = anchor
        self._text = text
        self._font = (ThemeManager.theme["text"]["font"], ThemeManager.theme["text"]["size"]) if font == "default_theme" else font

        # configure grid system (1x1)
        self.grid_rowconfigure(0, weight=1)
        self.grid_columnconfigure(0, weight=1)

        self._canvas = CTkCanvas(master=self,
                                 highlightthickness=0,
                                 width=self._apply_widget_scaling(self._desired_width),
                                 height=self._apply_widget_scaling(self._desired_height))
        self._canvas.grid(row=0, column=0, sticky="nswe")
        self._draw_engine = DrawEngine(self._canvas)

        self._text_label = tkinter.Label(master=self,
                                         highlightthickness=0,
                                         bd=0,
                                         anchor=self._anchor,
                                         text=self._text,
                                         font=self._apply_font_scaling(self._font),
                                         **pop_from_dict_by_set(kwargs, self._valid_tk_label_attributes))

        text_label_grid_sticky = self._anchor if self._anchor != "center" else ""
        self._text_label.grid(row=0, column=0, sticky=text_label_grid_sticky,
                              padx=self._apply_widget_scaling(min(self._corner_radius, round(self._current_height/2))))

        self._check_kwargs_empty(kwargs, raise_error=True)

        super().bind('<Configure>', self._update_dimensions_event)
        self._draw()

    def _set_scaling(self, *args, **kwargs):
        super()._set_scaling(*args, **kwargs)

        self._canvas.configure(width=self._apply_widget_scaling(self._desired_width), height=self._apply_widget_scaling(self._desired_height))
        self._text_label.configure(font=self._apply_font_scaling(self._font))

        text_label_grid_sticky = self._anchor if self._anchor != "center" else ""
        self._text_label.grid(row=0, column=0, sticky=text_label_grid_sticky,
                              padx=self._apply_widget_scaling(min(self._corner_radius, round(self._current_height/2))))

        self._draw()

    def _set_dimensions(self, width=None, height=None):
        super()._set_dimensions(width, height)

        self._canvas.configure(width=self._apply_widget_scaling(self._desired_width),
                               height=self._apply_widget_scaling(self._desired_height))
        self._draw()

    def _draw(self, no_color_updates=False):
        requires_recoloring = self._draw_engine.draw_rounded_rect_with_border(self._apply_widget_scaling(self._current_width),
                                                                              self._apply_widget_scaling(self._current_height),
                                                                              self._apply_widget_scaling(self._corner_radius),
                                                                              0)

        if no_color_updates is False or requires_recoloring:
            if ThemeManager.single_color(self._fg_color, self._appearance_mode) is not None:
                self._canvas.itemconfig("inner_parts",
                                        fill=ThemeManager.single_color(self._fg_color, self._appearance_mode),
                                        outline=ThemeManager.single_color(self._fg_color, self._appearance_mode))

                self._text_label.configure(fg=ThemeManager.single_color(self._text_color, self._appearance_mode),
                                           bg=ThemeManager.single_color(self._fg_color, self._appearance_mode))
            else:
                self._canvas.itemconfig("inner_parts",
                                        fill=ThemeManager.single_color(self._bg_color, self._appearance_mode),
                                        outline=ThemeManager.single_color(self._bg_color, self._appearance_mode))

                self._text_label.configure(fg=ThemeManager.single_color(self._text_color, self._appearance_mode),
                                           bg=ThemeManager.single_color(self._bg_color, self._appearance_mode))

            self._canvas.configure(bg=ThemeManager.single_color(self._bg_color, self._appearance_mode))

    def configure(self, require_redraw=False, **kwargs):
        if "anchor" in kwargs:
            self._anchor = kwargs.pop("anchor")
            text_label_grid_sticky = self._anchor if self._anchor != "center" else ""
            self._text_label.grid(row=0, column=0, sticky=text_label_grid_sticky,
                                  padx=self._apply_widget_scaling(min(self._corner_radius, round(self._current_height/2))))

        if "text" in kwargs:
            self._text = kwargs.pop("text")
            self._text_label.configure(text=self._text)

        if "font" in kwargs:
            self._font = kwargs.pop("font")
            self._text_label.configure(font=self._apply_font_scaling(self._font))

        if "fg_color" in kwargs:
            self._fg_color = kwargs.pop("fg_color")
            require_redraw = True

        if "text_color" in kwargs:
            self._text_color = kwargs.pop("text_color")
            require_redraw = True

        if "width" in kwargs:
            self._set_dimensions(width=kwargs.pop("width"))

        if "height" in kwargs:
            self._set_dimensions(height=kwargs.pop("height"))

        if "corner_radius" in kwargs:
            self._corner_radius = kwargs.pop("corner_radius")
            text_label_grid_sticky = self._anchor if self._anchor != "center" else ""
            self._text_label.grid(row=0, column=0, sticky=text_label_grid_sticky,
                                  padx=self._apply_widget_scaling(min(self._corner_radius, round(self._current_height/2))))
            require_redraw = True

        self._text_label.configure(**pop_from_dict_by_set(kwargs, self._valid_tk_label_attributes))  # configure tkinter.Label
        super().configure(require_redraw=require_redraw, **kwargs)  # configure CTkBaseClass

    def cget(self, attribute_name: str) -> any:
        if attribute_name == "corner_radius":
            return self._corner_radius

        elif attribute_name == "fg_color":
            return self._fg_color
        elif attribute_name == "text_color":
            return self._text_color

        elif attribute_name == "text":
            return self._text
        elif attribute_name == "font":
            return self._font
        elif attribute_name == "anchor":
            return self._anchor

        elif attribute_name in self._valid_tk_label_attributes:
            return self._text_label.cget(attribute_name)  # cget of tkinter.Label
        else:
            return super().cget(attribute_name)  # cget of CTkBaseClass

    def bind(self, sequence: str = None, command: Callable = None, add: str = None) -> str:
        """ called on the tkinter.Label and tkinter.Canvas """
        canvas_bind_return = self._canvas.bind(sequence, command, add)
        label_bind_return = self._text_label.bind(sequence, command, add)
        return canvas_bind_return + " + " + label_bind_return

    def unbind(self, sequence: str, funcid: str = None):
        """ called on the tkinter.Label and tkinter.Canvas """
        canvas_bind_return, label_bind_return = funcid.split(" + ")
        self._canvas.unbind(sequence, canvas_bind_return)
        self._text_label.unbind(sequence, label_bind_return)

    def focus(self):
        return self._text_label.focus()

    def focus_set(self):
        return self._text_label.focus_set()

    def focus_force(self):
        return self._text_label.focus_force()