import tkinter import sys from typing import Union, Tuple, Callable, Optional from .core_rendering import CTkCanvas from .theme import ThemeManager from .core_rendering import DrawEngine from .core_widget_classes import CTkBaseClass from .font import CTkFont class CTkCheckBox(CTkBaseClass): """ Checkbox with rounded corners, border, variable support and hover effect. For detailed information check out the documentation. """ def __init__(self, master: any, width: int = 100, height: int = 24, checkbox_width: int = 24, checkbox_height: int = 24, corner_radius: Optional[int] = None, border_width: Optional[int] = None, bg_color: Union[str, Tuple[str, str]] = "transparent", fg_color: Optional[Union[str, Tuple[str, str]]] = None, hover_color: Optional[Union[str, Tuple[str, str]]] = None, border_color: Optional[Union[str, Tuple[str, str]]] = None, checkmark_color: Optional[Union[str, Tuple[str, str]]] = None, text_color: Optional[Union[str, Tuple[str, str]]] = None, text_color_disabled: Optional[Union[str, Tuple[str, str]]] = None, text: str = "CTkCheckBox", font: Optional[Union[tuple, CTkFont]] = None, textvariable: Union[tkinter.Variable, None] = None, state: str = tkinter.NORMAL, hover: bool = True, command: Union[Callable[[], None], None] = None, onvalue: Union[int, str] = 1, offvalue: Union[int, str] = 0, variable: Union[tkinter.Variable, None] = None, **kwargs): # transfer basic functionality (_bg_color, size, __appearance_mode, scaling) to CTkBaseClass super().__init__(master=master, bg_color=bg_color, width=width, height=height, **kwargs) # dimensions self._checkbox_width = checkbox_width self._checkbox_height = checkbox_height # color self._fg_color = ThemeManager.theme["CTkCheckbox"]["fg_color"] if fg_color is None else self._check_color_type(fg_color) self._hover_color = ThemeManager.theme["CTkCheckbox"]["hover_color"] if hover_color is None else self._check_color_type(hover_color) self._border_color = ThemeManager.theme["CTkCheckbox"]["border_color"] if border_color is None else self._check_color_type(border_color) self._checkmark_color = ThemeManager.theme["CTkCheckbox"]["checkmark_color"] if checkmark_color is None else self._check_color_type(checkmark_color) # shape self._corner_radius = ThemeManager.theme["CTkCheckbox"]["corner_radius"] if corner_radius is None else corner_radius self._border_width = ThemeManager.theme["CTkCheckbox"]["border_width"] if border_width is None else border_width # text self._text = text self._text_label: Union[tkinter.Label, None] = None self._text_color = ThemeManager.theme["CTkCheckbox"]["text_color"] if text_color is None else self._check_color_type(text_color) self._text_color_disabled = ThemeManager.theme["CTkCheckbox"]["text_color_disabled"] if text_color_disabled is None else self._check_color_type(text_color_disabled) # font self._font = CTkFont() if font is None else self._check_font_type(font) if isinstance(self._font, CTkFont): self._font.add_size_configure_callback(self._update_font) # callback and hover functionality self._command = command self._state = state self._hover = hover self._check_state = False self._onvalue = onvalue self._offvalue = offvalue self._variable: tkinter.Variable = variable self._variable_callback_blocked = False self._textvariable: tkinter.Variable = textvariable self._variable_callback_name = None # configure grid system (1x3) self.grid_columnconfigure(0, weight=0) self.grid_columnconfigure(1, weight=0, minsize=self._apply_widget_scaling(6)) self.grid_columnconfigure(2, weight=1) self.grid_rowconfigure(0, weight=1) self._bg_canvas = CTkCanvas(master=self, highlightthickness=0, width=self._apply_widget_scaling(self._desired_width), height=self._apply_widget_scaling(self._desired_height)) self._bg_canvas.grid(row=0, column=0, columnspan=3, sticky="nswe") self._canvas = CTkCanvas(master=self, highlightthickness=0, width=self._apply_widget_scaling(self._checkbox_width), height=self._apply_widget_scaling(self._checkbox_height)) self._canvas.grid(row=0, column=0, sticky="e") self._draw_engine = DrawEngine(self._canvas) self._text_label = tkinter.Label(master=self, bd=0, padx=0, pady=0, text=self._text, justify=tkinter.LEFT, font=self._apply_font_scaling(self._font), textvariable=self._textvariable) self._text_label.grid(row=0, column=2, sticky="w") self._text_label["anchor"] = "w" # register variable callback and set state according to variable if self._variable is not None and self._variable != "": self._variable_callback_name = self._variable.trace_add("write", self._variable_callback) self._check_state = True if self._variable.get() == self._onvalue else False self._create_bindings() self._set_cursor() self._draw() def _create_bindings(self, sequence: Optional[str] = None): """ set necessary bindings for functionality of widget, will overwrite other bindings """ if sequence is None or sequence == "": self._canvas.bind("", self._on_enter) self._text_label.bind("", self._on_enter) if sequence is None or sequence == "": self._canvas.bind("", self._on_leave) self._text_label.bind("", self._on_leave) if sequence is None or sequence == "": self._canvas.bind("", self.toggle) self._text_label.bind("", self.toggle) def _set_scaling(self, *args, **kwargs): super()._set_scaling(*args, **kwargs) self.grid_columnconfigure(1, weight=0, minsize=self._apply_widget_scaling(6)) self._text_label.configure(font=self._apply_font_scaling(self._font)) self._canvas.delete("checkmark") self._bg_canvas.configure(width=self._apply_widget_scaling(self._desired_width), height=self._apply_widget_scaling(self._desired_height)) self._canvas.configure(width=self._apply_widget_scaling(self._checkbox_width), height=self._apply_widget_scaling(self._checkbox_height)) self._draw(no_color_updates=True) def _set_dimensions(self, width: int = None, height: int = None): super()._set_dimensions(width, height) self._bg_canvas.configure(width=self._apply_widget_scaling(self._desired_width), height=self._apply_widget_scaling(self._desired_height)) def _update_font(self): """ pass font to tkinter widgets with applied font scaling and update grid with workaround """ if self._text_label is not None: self._text_label.configure(font=self._apply_font_scaling(self._font)) # Workaround to force grid to be resized when text changes size. # Otherwise grid will lag and only resizes if other mouse action occurs. self._bg_canvas.grid_forget() self._bg_canvas.grid(row=0, column=0, columnspan=3, sticky="nswe") def destroy(self): if self._variable is not None: self._variable.trace_remove("write", self._variable_callback_name) if isinstance(self._font, CTkFont): self._font.remove_size_configure_callback(self._update_font) super().destroy() def _draw(self, no_color_updates=False): super()._draw(no_color_updates) requires_recoloring_1 = self._draw_engine.draw_rounded_rect_with_border(self._apply_widget_scaling(self._checkbox_width), self._apply_widget_scaling(self._checkbox_height), self._apply_widget_scaling(self._corner_radius), self._apply_widget_scaling(self._border_width)) if self._check_state is True: requires_recoloring_2 = self._draw_engine.draw_checkmark(self._apply_widget_scaling(self._checkbox_width), self._apply_widget_scaling(self._checkbox_height), self._apply_widget_scaling(self._checkbox_height * 0.58)) else: requires_recoloring_2 = False self._canvas.delete("checkmark") if no_color_updates is False or requires_recoloring_1 or requires_recoloring_2: self._bg_canvas.configure(bg=self._apply_appearance_mode(self._bg_color)) self._canvas.configure(bg=self._apply_appearance_mode(self._bg_color)) if self._check_state is True: self._canvas.itemconfig("inner_parts", outline=self._apply_appearance_mode(self._fg_color), fill=self._apply_appearance_mode(self._fg_color)) self._canvas.itemconfig("border_parts", outline=self._apply_appearance_mode(self._fg_color), fill=self._apply_appearance_mode(self._fg_color)) if "create_line" in self._canvas.gettags("checkmark"): self._canvas.itemconfig("checkmark", fill=self._apply_appearance_mode(self._checkmark_color)) else: self._canvas.itemconfig("checkmark", fill=self._apply_appearance_mode(self._checkmark_color)) else: self._canvas.itemconfig("inner_parts", outline=self._apply_appearance_mode(self._bg_color), fill=self._apply_appearance_mode(self._bg_color)) self._canvas.itemconfig("border_parts", outline=self._apply_appearance_mode(self._border_color), fill=self._apply_appearance_mode(self._border_color)) if self._state == tkinter.DISABLED: self._text_label.configure(fg=(self._apply_appearance_mode(self._text_color_disabled))) else: self._text_label.configure(fg=self._apply_appearance_mode(self._text_color)) self._text_label.configure(bg=self._apply_appearance_mode(self._bg_color)) def configure(self, require_redraw=False, **kwargs): if "corner_radius" in kwargs: self._corner_radius = kwargs.pop("corner_radius") require_redraw = True if "border_width" in kwargs: self._border_width = kwargs.pop("border_width") require_redraw = True if "checkbox_width" in kwargs: self._checkbox_width = kwargs.pop("checkbox_width") self._canvas.configure(width=self._apply_widget_scaling(self._checkbox_width)) require_redraw = True if "checkbox_height" in kwargs: self._checkbox_height = kwargs.pop("checkbox_height") self._canvas.configure(height=self._apply_widget_scaling(self._checkbox_height)) require_redraw = True if "text" in kwargs: self._text = kwargs.pop("text") self._text_label.configure(text=self._text) if "font" in kwargs: if isinstance(self._font, CTkFont): self._font.remove_size_configure_callback(self._update_font) self._font = self._check_font_type(kwargs.pop("font")) if isinstance(self._font, CTkFont): self._font.add_size_configure_callback(self._update_font) self._update_font() if "state" in kwargs: self._state = kwargs.pop("state") self._set_cursor() require_redraw = True if "fg_color" in kwargs: self._fg_color = self._check_color_type(kwargs.pop("fg_color")) require_redraw = True if "hover_color" in kwargs: self._hover_color = self._check_color_type(kwargs.pop("hover_color")) require_redraw = True if "border_color" in kwargs: self._border_color = self._check_color_type(kwargs.pop("border_color")) require_redraw = True if "checkmark_color" in kwargs: self._checkmark_color = self._check_color_type(kwargs.pop("checkmark_color")) require_redraw = True if "text_color" in kwargs: self._text_color = self._check_color_type(kwargs.pop("text_color")) require_redraw = True if "text_color_disabled" in kwargs: self._text_color_disabled = self._check_color_type(kwargs.pop("text_color_disabled")) require_redraw = True if "hover" in kwargs: self._hover = kwargs.pop("hover") if "command" in kwargs: self._command = kwargs.pop("command") if "textvariable" in kwargs: self._textvariable = kwargs.pop("textvariable") self._text_label.configure(textvariable=self._textvariable) if "variable" in kwargs: if self._variable is not None and self._variable != "": self._variable.trace_remove("write", self._variable_callback_name) # remove old variable callback self._variable = kwargs.pop("variable") if self._variable is not None and self._variable != "": self._variable_callback_name = self._variable.trace_add("write", self._variable_callback) self._check_state = True if self._variable.get() == self._onvalue else False require_redraw = True super().configure(require_redraw=require_redraw, **kwargs) def cget(self, attribute_name: str) -> any: if attribute_name == "corner_radius": return self._corner_radius elif attribute_name == "border_width": return self._border_width elif attribute_name == "checkbox_width": return self._checkbox_width elif attribute_name == "checkbox_height": return self._checkbox_height elif attribute_name == "fg_color": return self._fg_color elif attribute_name == "hover_color": return self._hover_color elif attribute_name == "border_color": return self._border_color elif attribute_name == "checkmark_color": return self._checkmark_color elif attribute_name == "text_color": return self._text_color elif attribute_name == "text_color_disabled": return self._text_color_disabled elif attribute_name == "text": return self._text elif attribute_name == "font": return self._font elif attribute_name == "textvariable": return self._textvariable elif attribute_name == "state": return self._state elif attribute_name == "hover": return self._hover elif attribute_name == "onvalue": return self._onvalue elif attribute_name == "offvalue": return self._offvalue elif attribute_name == "variable": return self._variable else: return super().cget(attribute_name) def _set_cursor(self): if self._cursor_manipulation_enabled: if self._state == tkinter.DISABLED: if sys.platform == "darwin": self._canvas.configure(cursor="arrow") if self._text_label is not None: self._text_label.configure(cursor="arrow") elif sys.platform.startswith("win"): self._canvas.configure(cursor="arrow") if self._text_label is not None: self._text_label.configure(cursor="arrow") elif self._state == tkinter.NORMAL: if sys.platform == "darwin": self._canvas.configure(cursor="pointinghand") if self._text_label is not None: self._text_label.configure(cursor="pointinghand") elif sys.platform.startswith("win"): self._canvas.configure(cursor="hand2") if self._text_label is not None: self._text_label.configure(cursor="hand2") def _on_enter(self, event=0): if self._hover is True and self._state == tkinter.NORMAL: if self._check_state is True: self._canvas.itemconfig("inner_parts", fill=self._apply_appearance_mode(self._hover_color), outline=self._apply_appearance_mode(self._hover_color)) self._canvas.itemconfig("border_parts", fill=self._apply_appearance_mode(self._hover_color), outline=self._apply_appearance_mode(self._hover_color)) else: self._canvas.itemconfig("inner_parts", fill=self._apply_appearance_mode(self._hover_color), outline=self._apply_appearance_mode(self._hover_color)) def _on_leave(self, event=0): if self._check_state is True: self._canvas.itemconfig("inner_parts", fill=self._apply_appearance_mode(self._fg_color), outline=self._apply_appearance_mode(self._fg_color)) self._canvas.itemconfig("border_parts", fill=self._apply_appearance_mode(self._fg_color), outline=self._apply_appearance_mode(self._fg_color)) else: self._canvas.itemconfig("inner_parts", fill=self._apply_appearance_mode(self._bg_color), outline=self._apply_appearance_mode(self._bg_color)) self._canvas.itemconfig("border_parts", fill=self._apply_appearance_mode(self._border_color), outline=self._apply_appearance_mode(self._border_color)) def _variable_callback(self, var_name, index, mode): if not self._variable_callback_blocked: if self._variable.get() == self._onvalue: self.select(from_variable_callback=True) elif self._variable.get() == self._offvalue: self.deselect(from_variable_callback=True) def toggle(self, event=0): if self._state == tkinter.NORMAL: if self._check_state is True: self._check_state = False self._draw() else: self._check_state = True self._draw() if self._variable is not None: self._variable_callback_blocked = True self._variable.set(self._onvalue if self._check_state is True else self._offvalue) self._variable_callback_blocked = False if self._command is not None: self._command() def select(self, from_variable_callback=False): self._check_state = True self._draw() if self._variable is not None and not from_variable_callback: self._variable_callback_blocked = True self._variable.set(self._onvalue) self._variable_callback_blocked = False def deselect(self, from_variable_callback=False): self._check_state = False self._draw() if self._variable is not None and not from_variable_callback: self._variable_callback_blocked = True self._variable.set(self._offvalue) self._variable_callback_blocked = False def get(self) -> Union[int, str]: return self._onvalue if self._check_state is True else self._offvalue def bind(self, sequence: str = None, command: Callable = None, add: Union[str, bool] = True): """ called on the tkinter.Canvas """ if not (add == "+" or add is True): raise ValueError("'add' argument can only be '+' or True to preserve internal callbacks") self._canvas.bind(sequence, command, add=True) self._text_label.bind(sequence, command, add=True) def unbind(self, sequence: str = None, funcid: str = None): """ called on the tkinter.Label and tkinter.Canvas """ if funcid is not None: raise ValueError("'funcid' argument can only be None, because there is a bug in" + " tkinter and its not clear whether the internal callbacks will be unbinded or not") self._canvas.unbind(sequence, None) self._text_label.unbind(sequence, None) self._create_bindings(sequence=sequence) # restore internal callbacks for sequence 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()