mirror/CustomTkinter
1
0
Fork 0
mirror of https://github.com/TomSchimansky/CustomTkinter.git synced 2023-08-10 21:13:13 +03:00
Code Issues Projects Releases Wiki Activity

added type hints to CTkButton

Browse Source
This commit is contained in:
Tom Schimansky 2022-07-07 16:21:30 +02:00
parent 767379462e
commit 162997c7da
3 changed files with 41 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
customtkinter/widgets/ctk_button.py
View File

@ -1,6 +1,6 @@
import tkinter import tkinter
import sys import sys
from typing import Union from typing import Union, Tuple, Callable
from .ctk_canvas import CTkCanvas from .ctk_canvas import CTkCanvas
from ..theme_manager import ThemeManager from ..theme_manager import ThemeManager
@ -10,35 +10,33 @@ from .widget_base_class import CTkBaseClass
class CTkButton(CTkBaseClass): class CTkButton(CTkBaseClass):
""" tkinter custom button with border, rounded corners and hover effect """ """ button with border, rounded corners, hover effect, image support """
def __init__(self, *args, def __init__(self, *args,
bg_color=None, bg_color: Union[str, Tuple[str, str]] = None,
fg_color="default_theme", fg_color: Union[str, Tuple[str, str]] = "default_theme",
hover_color="default_theme", hover_color: Union[str, Tuple[str, str]] = "default_theme",
border_color="default_theme", border_color: Union[str, Tuple[str, str]] = "default_theme",
border_width="default_theme", text_color: Union[str, Tuple[str, str]] = "default_theme",
command=None, text_color_disabled: Union[str, Tuple[str, str]] = "default_theme",
textvariable=None, width: int = 140,
width=140, height: int = 28,
height=28, corner_radius: Union[int, str] = "default_theme",
corner_radius="default_theme", border_width: Union[int, str] = "default_theme",
text_font="default_theme", text: str = "CTkButton",
text_color="default_theme", textvariable: tkinter.Variable = None,
text_color_disabled="default_theme", text_font: any = "default_theme",
text="CTkButton", image: tkinter.PhotoImage = None,
hover=True, hover: bool = True,
image=None, compound: str = "left",
compound="left", state: str = "normal",
state="normal", command: Callable = None,
**kwargs): **kwargs):
# transfer basic functionality (bg_color, size, _appearance_mode, scaling) to CTkBaseClass # transfer basic functionality (bg_color, size, _appearance_mode, scaling) to CTkBaseClass
super().__init__(*args, bg_color=bg_color, width=width, height=height, **kwargs) super().__init__(*args, bg_color=bg_color, width=width, height=height, **kwargs)
self.configure_basic_grid() # color
# color variables
self.fg_color = ThemeManager.theme["color"]["button"] if fg_color == "default_theme" else fg_color self.fg_color = ThemeManager.theme["color"]["button"] if fg_color == "default_theme" else fg_color
self.hover_color = ThemeManager.theme["color"]["button_hover"] if hover_color == "default_theme" else hover_color self.hover_color = ThemeManager.theme["color"]["button_hover"] if hover_color == "default_theme" else hover_color
self.border_color = ThemeManager.theme["color"]["button_border"] if border_color == "default_theme" else border_color self.border_color = ThemeManager.theme["color"]["button_border"] if border_color == "default_theme" else border_color
@ -64,6 +62,13 @@ class CTkButton(CTkBaseClass):
self.compound = compound self.compound = compound
self.click_animation_running = False self.click_animation_running = False
# configure grid system (2x2)
self.grid_rowconfigure(0, weight=1)
self.grid_columnconfigure(0, weight=1)
self.grid_rowconfigure(1, weight=1)
self.grid_columnconfigure(1, weight=1)
# canvas
self.canvas = CTkCanvas(master=self, self.canvas = CTkCanvas(master=self,
highlightthickness=0, highlightthickness=0,
width=self.apply_widget_scaling(self._desired_width), width=self.apply_widget_scaling(self._desired_width),
@ -71,22 +76,16 @@ class CTkButton(CTkBaseClass):
self.canvas.grid(row=0, column=0, rowspan=2, columnspan=2, sticky="nsew") self.canvas.grid(row=0, column=0, rowspan=2, columnspan=2, sticky="nsew")
self.draw_engine = DrawEngine(self.canvas) self.draw_engine = DrawEngine(self.canvas)
# event bindings # canvas event bindings
self.canvas.bind("<Enter>", self.on_enter) self.canvas.bind("<Enter>", self.on_enter)
self.canvas.bind("<Leave>", self.on_leave) self.canvas.bind("<Leave>", self.on_leave)
self.canvas.bind("<Button-1>", self.clicked) self.canvas.bind("<Button-1>", self.clicked)
self.canvas.bind("<Button-1>", self.clicked) self.canvas.bind("<Button-1>", self.clicked)
self.bind('<Configure>', self.update_dimensions_event) self.bind('<Configure>', self.update_dimensions_event)
# configure cursor and initial draw
self.set_cursor() self.set_cursor()
self.draw() # initial draw self.draw()
def configure_basic_grid(self):
# Configuration of a grid system (2x2) in which all parts of CTkButton are centered
self.grid_rowconfigure(0, weight=1)
self.grid_columnconfigure(0, weight=1)
self.grid_rowconfigure(1, weight=1)
self.grid_columnconfigure(1, weight=1)
def set_scaling(self, *args, **kwargs): def set_scaling(self, *args, **kwargs):
super().set_scaling(*args, **kwargs) super().set_scaling(*args, **kwargs)
@ -102,7 +101,7 @@ class CTkButton(CTkBaseClass):
height=self.apply_widget_scaling(self._desired_height)) height=self.apply_widget_scaling(self._desired_height))
self.draw() self.draw()
def set_dimensions(self, width=None, height=None): def set_dimensions(self, width: int = None, height: int = None):
super().set_dimensions(width, height) super().set_dimensions(width, height)
self.canvas.configure(width=self.apply_widget_scaling(self._desired_width), self.canvas.configure(width=self.apply_widget_scaling(self._desired_width),
@ -140,6 +139,7 @@ class CTkButton(CTkBaseClass):
if self.text_label is None: if self.text_label is None:
self.text_label = tkinter.Label(master=self, self.text_label = tkinter.Label(master=self,
font=self.apply_font_scaling(self.text_font), font=self.apply_font_scaling(self.text_font),
text=self.text,
textvariable=self.textvariable) textvariable=self.textvariable)
self.text_label.bind("<Enter>", self.on_enter) self.text_label.bind("<Enter>", self.on_enter)
@ -161,8 +161,6 @@ class CTkButton(CTkBaseClass):
else: else:
self.text_label.configure(bg=ThemeManager.single_color(self.fg_color, self._appearance_mode)) self.text_label.configure(bg=ThemeManager.single_color(self.fg_color, self._appearance_mode))
self.text_label.configure(text=self.text) # set text
else: else:
# delete text_label if no text given # delete text_label if no text given
if self.text_label is not None: if self.text_label is not None:
@ -240,7 +238,10 @@ class CTkButton(CTkBaseClass):
def configure(self, require_redraw=False, **kwargs): def configure(self, require_redraw=False, **kwargs):
if "text" in kwargs: if "text" in kwargs:
self.text = kwargs.pop("text") self.text = kwargs.pop("text")
require_redraw = True # new text will be set to label in .draw() if self.text_label is None:
require_redraw = True # text_label will be created in .draw()
else:
self.text_label.configure(text=self.text)
if "state" in kwargs: if "state" in kwargs:
self.state = kwargs.pop("state") self.state = kwargs.pop("state")
@ -309,7 +310,7 @@ class CTkButton(CTkBaseClass):
""" will be removed in next major """ """ will be removed in next major """
self.configure(text=text) self.configure(text=text)
def on_enter(self, event=0): def on_enter(self, event=None):
if self.hover is True and self.state == tkinter.NORMAL: if self.hover is True and self.state == tkinter.NORMAL:
if self.hover_color is None: if self.hover_color is None:
inner_parts_color = self.fg_color inner_parts_color = self.fg_color
@ -329,7 +330,7 @@ class CTkButton(CTkBaseClass):
if self.image_label is not None: if self.image_label is not None:
self.image_label.configure(bg=ThemeManager.single_color(inner_parts_color, self._appearance_mode)) self.image_label.configure(bg=ThemeManager.single_color(inner_parts_color, self._appearance_mode))
def on_leave(self, event=0): def on_leave(self, event=None):
self.click_animation_running = False self.click_animation_running = False
if self.hover is True: if self.hover is True:
@ -355,7 +356,7 @@ class CTkButton(CTkBaseClass):
if self.click_animation_running: if self.click_animation_running:
self.on_enter() self.on_enter()
def clicked(self, event=0): def clicked(self, event=None):
if self.command is not None: if self.command is not None:
if self.state is not tkinter.DISABLED: if self.state is not tkinter.DISABLED:

1
customtkinter/widgets/ctk_canvas.py
View File

@ -8,7 +8,6 @@ class CTkCanvas(tkinter.Canvas):
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs) super().__init__(*args, **kwargs)
self.aa_circle_canvas_ids = set() self.aa_circle_canvas_ids = set()
@classmethod @classmethod

1
customtkinter/widgets/widget_base_class.py
View File

@ -26,6 +26,7 @@ class CTkBaseClass(tkinter.Frame):
width: int, width: int,
height: int, height: int,
**kwargs): **kwargs):
super().__init__(*args, width=width, height=height, **kwargs) # set desired size of underlying tkinter.Frame super().__init__(*args, width=width, height=height, **kwargs) # set desired size of underlying tkinter.Frame
# dimensions # dimensions