CustomTkinter/customtkinter/widgets/ctk_button.py

373 lines
19 KiB
Python
Raw Normal View History

2021-03-04 20:27:46 +03:00
import tkinter
import sys
2022-07-12 22:52:52 +03:00
from typing import Union, Tuple, Callable
2021-03-04 20:27:46 +03:00
from .ctk_canvas import CTkCanvas
from ..theme_manager import ThemeManager
from ..settings import Settings
from ..draw_engine import DrawEngine
from .widget_base_class import CTkBaseClass
2021-03-04 20:27:46 +03:00
class CTkButton(CTkBaseClass):
2022-07-07 17:21:30 +03:00
""" button with border, rounded corners, hover effect, image support """
2021-03-04 20:27:46 +03:00
def __init__(self, *args,
2022-07-07 19:23:50 +03:00
bg_color: Union[str, Tuple[str, str], None] = None,
fg_color: Union[str, Tuple[str, str], None] = "default_theme",
2022-07-07 17:21:30 +03:00
hover_color: Union[str, Tuple[str, str]] = "default_theme",
border_color: Union[str, Tuple[str, str]] = "default_theme",
text_color: Union[str, Tuple[str, str]] = "default_theme",
text_color_disabled: Union[str, Tuple[str, str]] = "default_theme",
width: int = 140,
height: int = 28,
corner_radius: Union[int, str] = "default_theme",
border_width: Union[int, str] = "default_theme",
text: str = "CTkButton",
textvariable: tkinter.Variable = None,
text_font: any = "default_theme",
image: tkinter.PhotoImage = None,
hover: bool = True,
compound: str = "left",
state: str = "normal",
command: Callable = None,
**kwargs):
2021-03-04 20:27:46 +03:00
2022-05-31 23:32:21 +03:00
# transfer basic functionality (bg_color, size, _appearance_mode, scaling) to CTkBaseClass
super().__init__(*args, bg_color=bg_color, width=width, height=height, **kwargs)
2021-09-13 15:27:29 +03:00
2022-07-07 17:21:30 +03:00
# 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.border_color = ThemeManager.theme["color"]["button_border"] if border_color == "default_theme" else border_color
self.text_color = ThemeManager.theme["color"]["text"] if text_color == "default_theme" else text_color
self.text_color_disabled = ThemeManager.theme["color"]["text_button_disabled"] if text_color_disabled == "default_theme" else text_color_disabled
2021-03-04 20:27:46 +03:00
# shape
self.corner_radius = ThemeManager.theme["shape"]["button_corner_radius"] if corner_radius == "default_theme" else corner_radius
self.border_width = ThemeManager.theme["shape"]["button_border_width"] if border_width == "default_theme" else border_width
# text, font, image
self.image = image
self.image_label = None
2021-03-04 20:27:46 +03:00
self.text = text
self.text_label = None
self.text_font = (ThemeManager.theme["text"]["font"], ThemeManager.theme["text"]["size"]) if text_font == "default_theme" else text_font
2021-03-04 20:27:46 +03:00
# callback and hover functionality
self.command = command
self.textvariable = textvariable
2021-07-23 01:44:13 +03:00
self.state = state
2021-03-04 20:27:46 +03:00
self.hover = hover
self.compound = compound
self.click_animation_running = False
2021-03-04 20:27:46 +03:00
2022-07-07 17:21:30 +03:00
# 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,
2022-02-23 01:50:03 +03:00
highlightthickness=0,
2022-05-31 23:32:21 +03:00
width=self.apply_widget_scaling(self._desired_width),
height=self.apply_widget_scaling(self._desired_height))
self.canvas.grid(row=0, column=0, rowspan=2, columnspan=2, sticky="nsew")
self.draw_engine = DrawEngine(self.canvas)
2022-07-07 17:21:30 +03:00
# canvas event bindings
2022-03-10 04:12:30 +03:00
self.canvas.bind("<Enter>", self.on_enter)
self.canvas.bind("<Leave>", self.on_leave)
2021-03-04 20:27:46 +03:00
self.canvas.bind("<Button-1>", self.clicked)
self.canvas.bind("<Button-1>", self.clicked)
2022-04-21 19:34:58 +03:00
self.bind('<Configure>', self.update_dimensions_event)
2022-07-07 17:21:30 +03:00
# configure cursor and initial draw
2022-03-10 04:12:30 +03:00
self.set_cursor()
2022-07-07 17:21:30 +03:00
self.draw()
2022-05-02 00:29:14 +03:00
def set_scaling(self, *args, **kwargs):
2022-05-05 21:25:37 +03:00
super().set_scaling(*args, **kwargs)
2022-05-02 00:29:14 +03:00
if self.text_label is not None:
self.text_label.destroy()
self.text_label = None
if self.image_label is not None:
self.image_label.destroy()
self.image_label = None
2022-05-31 23:32:21 +03:00
self.canvas.configure(width=self.apply_widget_scaling(self._desired_width),
height=self.apply_widget_scaling(self._desired_height))
self.draw()
2022-07-07 17:21:30 +03:00
def set_dimensions(self, width: int = None, height: int = None):
super().set_dimensions(width, height)
2022-05-31 23:32:21 +03:00
self.canvas.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
self.draw()
2021-11-07 17:12:09 +03:00
def draw(self, no_color_updates=False):
2022-05-31 23:32:21 +03:00
requires_recoloring = self.draw_engine.draw_rounded_rect_with_border(self.apply_widget_scaling(self._current_width),
self.apply_widget_scaling(self._current_height),
2022-05-02 00:29:14 +03:00
self.apply_widget_scaling(self.corner_radius),
self.apply_widget_scaling(self.border_width))
if no_color_updates is False or requires_recoloring:
2022-05-31 23:32:21 +03:00
self.canvas.configure(bg=ThemeManager.single_color(self.bg_color, self._appearance_mode))
2021-11-07 17:12:09 +03:00
# set color for the button border parts (outline)
self.canvas.itemconfig("border_parts",
2022-05-31 23:32:21 +03:00
outline=ThemeManager.single_color(self.border_color, self._appearance_mode),
fill=ThemeManager.single_color(self.border_color, self._appearance_mode))
2022-03-10 04:12:30 +03:00
# set color for inner button parts
if self.fg_color is None:
self.canvas.itemconfig("inner_parts",
2022-05-31 23:32:21 +03:00
outline=ThemeManager.single_color(self.bg_color, self._appearance_mode),
fill=ThemeManager.single_color(self.bg_color, self._appearance_mode))
else:
2022-03-10 04:12:30 +03:00
self.canvas.itemconfig("inner_parts",
2022-05-31 23:32:21 +03:00
outline=ThemeManager.single_color(self.fg_color, self._appearance_mode),
fill=ThemeManager.single_color(self.fg_color, self._appearance_mode))
2021-11-07 17:12:09 +03:00
# create text label if text given
if self.text is not None and self.text != "":
if self.text_label is None:
2022-04-21 19:34:58 +03:00
self.text_label = tkinter.Label(master=self,
font=self.apply_font_scaling(self.text_font),
2022-07-07 17:21:30 +03:00
text=self.text,
2022-04-21 19:34:58 +03:00
textvariable=self.textvariable)
self.text_label.bind("<Enter>", self.on_enter)
self.text_label.bind("<Leave>", self.on_leave)
self.text_label.bind("<Button-1>", self.clicked)
self.text_label.bind("<Button-1>", self.clicked)
2021-11-07 17:12:09 +03:00
if no_color_updates is False:
# set text_label fg color (text color)
2022-05-31 23:32:21 +03:00
self.text_label.configure(fg=ThemeManager.single_color(self.text_color, self._appearance_mode))
if self.state == tkinter.DISABLED:
2022-05-31 23:32:21 +03:00
self.text_label.configure(fg=(ThemeManager.single_color(self.text_color_disabled, self._appearance_mode)))
else:
2022-05-31 23:32:21 +03:00
self.text_label.configure(fg=ThemeManager.single_color(self.text_color, self._appearance_mode))
2022-03-10 04:12:30 +03:00
if self.fg_color is None:
2022-05-31 23:32:21 +03:00
self.text_label.configure(bg=ThemeManager.single_color(self.bg_color, self._appearance_mode))
2022-03-10 04:12:30 +03:00
else:
2022-05-31 23:32:21 +03:00
self.text_label.configure(bg=ThemeManager.single_color(self.fg_color, self._appearance_mode))
2021-11-07 17:12:09 +03:00
else:
# delete text_label if no text given
if self.text_label is not None:
self.text_label.destroy()
self.text_label = None
2021-11-07 17:12:09 +03:00
# create image label if image given
if self.image is not None:
if self.image_label is None:
self.image_label = tkinter.Label(master=self)
self.image_label.bind("<Enter>", self.on_enter)
self.image_label.bind("<Leave>", self.on_leave)
self.image_label.bind("<Button-1>", self.clicked)
self.image_label.bind("<Button-1>", self.clicked)
2021-11-07 17:12:09 +03:00
if no_color_updates is False:
# set image_label bg color (background color of label)
2022-04-10 20:56:42 +03:00
if self.fg_color is None:
2022-05-31 23:32:21 +03:00
self.image_label.configure(bg=ThemeManager.single_color(self.bg_color, self._appearance_mode))
else:
2022-05-31 23:32:21 +03:00
self.image_label.configure(bg=ThemeManager.single_color(self.fg_color, self._appearance_mode))
2021-11-07 17:12:09 +03:00
self.image_label.configure(image=self.image) # set image
else:
# delete text_label if no text given
if self.image_label is not None:
self.image_label.destroy()
self.image_label = None
# create grid layout with just an image given
if self.image_label is not None and self.text_label is None:
2022-05-12 23:55:28 +03:00
self.image_label.grid(row=0, column=0, rowspan=2, columnspan=2, sticky="",
pady=(self.apply_widget_scaling(self.border_width), self.apply_widget_scaling(self.border_width) + 1)) # bottom pady with +1 for rounding to even
2021-11-07 17:12:09 +03:00
# create grid layout with just text given
if self.image_label is None and self.text_label is not None:
2022-04-21 19:34:58 +03:00
self.text_label.grid(row=0, column=0, rowspan=2, columnspan=2, sticky="",
2022-05-12 23:55:28 +03:00
padx=self.apply_widget_scaling(self.corner_radius),
pady=(self.apply_widget_scaling(self.border_width), self.apply_widget_scaling(self.border_width) + 1)) # bottom pady with +1 for rounding to even
2021-11-07 17:12:09 +03:00
# create grid layout of image and text label in 2x2 grid system with given compound
if self.image_label is not None and self.text_label is not None:
if self.compound == tkinter.LEFT or self.compound == "left":
2022-04-21 19:34:58 +03:00
self.image_label.grid(row=0, column=0, sticky="e", rowspan=2, columnspan=1,
2022-05-12 23:55:28 +03:00
padx=(max(self.apply_widget_scaling(self.corner_radius), self.apply_widget_scaling(self.border_width)), 2),
pady=(self.apply_widget_scaling(self.border_width), self.apply_widget_scaling(self.border_width) + 1))
2022-04-21 19:34:58 +03:00
self.text_label.grid(row=0, column=1, sticky="w", rowspan=2, columnspan=1,
2022-05-12 23:55:28 +03:00
padx=(2, max(self.apply_widget_scaling(self.corner_radius), self.apply_widget_scaling(self.border_width))),
pady=(self.apply_widget_scaling(self.border_width), self.apply_widget_scaling(self.border_width) + 1))
2021-11-07 17:12:09 +03:00
elif self.compound == tkinter.TOP or self.compound == "top":
2022-04-21 19:34:58 +03:00
self.image_label.grid(row=0, column=0, sticky="s", columnspan=2, rowspan=1,
2022-05-12 23:55:28 +03:00
padx=max(self.apply_widget_scaling(self.corner_radius), self.apply_widget_scaling(self.border_width)),
pady=(self.apply_widget_scaling(self.border_width), 2))
2022-04-21 19:34:58 +03:00
self.text_label.grid(row=1, column=0, sticky="n", columnspan=2, rowspan=1,
2022-05-12 23:55:28 +03:00
padx=max(self.apply_widget_scaling(self.corner_radius), self.apply_widget_scaling(self.border_width)),
pady=(2, self.apply_widget_scaling(self.border_width)))
2021-11-07 17:12:09 +03:00
elif self.compound == tkinter.RIGHT or self.compound == "right":
2022-04-21 19:34:58 +03:00
self.image_label.grid(row=0, column=1, sticky="w", rowspan=2, columnspan=1,
2022-05-12 23:55:28 +03:00
padx=(2, max(self.apply_widget_scaling(self.corner_radius), self.apply_widget_scaling(self.border_width))),
pady=(self.apply_widget_scaling(self.border_width), self.apply_widget_scaling(self.border_width) + 1))
2022-04-21 19:34:58 +03:00
self.text_label.grid(row=0, column=0, sticky="e", rowspan=2, columnspan=1,
2022-05-12 23:55:28 +03:00
padx=(max(self.apply_widget_scaling(self.corner_radius), self.apply_widget_scaling(self.border_width)), 2),
pady=(self.apply_widget_scaling(self.border_width), self.apply_widget_scaling(self.border_width) + 1))
2021-11-07 17:12:09 +03:00
elif self.compound == tkinter.BOTTOM or self.compound == "bottom":
2022-04-21 19:34:58 +03:00
self.image_label.grid(row=1, column=0, sticky="n", columnspan=2, rowspan=1,
2022-05-12 23:55:28 +03:00
padx=max(self.apply_widget_scaling(self.corner_radius), self.apply_widget_scaling(self.border_width)),
pady=(2, self.apply_widget_scaling(self.border_width)))
2022-04-21 19:34:58 +03:00
self.text_label.grid(row=0, column=0, sticky="s", columnspan=2, rowspan=1,
2022-05-12 23:55:28 +03:00
padx=max(self.apply_widget_scaling(self.corner_radius), self.apply_widget_scaling(self.border_width)),
pady=(self.apply_widget_scaling(self.border_width), 2))
2022-05-04 16:38:13 +03:00
def configure(self, require_redraw=False, **kwargs):
2021-07-23 01:44:13 +03:00
if "text" in kwargs:
self.text = kwargs.pop("text")
2022-07-07 17:21:30 +03:00
if self.text_label is None:
require_redraw = True # text_label will be created in .draw()
else:
self.text_label.configure(text=self.text)
2021-07-23 01:44:13 +03:00
if "state" in kwargs:
self.state = kwargs.pop("state")
2022-03-10 04:12:30 +03:00
self.set_cursor()
require_redraw = True
2021-07-23 01:44:13 +03:00
if "image" in kwargs:
self.image = kwargs.pop("image")
2022-07-12 22:52:52 +03:00
require_redraw = True
if "corner_radius" in kwargs:
self.corner_radius = kwargs.pop("corner_radius")
require_redraw = True
2021-11-07 17:12:09 +03:00
if "compound" in kwargs:
self.compound = kwargs.pop("compound")
2021-11-07 17:12:09 +03:00
require_redraw = True
if "fg_color" in kwargs:
self.fg_color = kwargs.pop("fg_color")
require_redraw = True
if "border_color" in kwargs:
self.border_color = kwargs.pop("border_color")
require_redraw = True
if "hover_color" in kwargs:
self.hover_color = kwargs.pop("hover_color")
require_redraw = True
if "text_color" in kwargs:
self.text_color = kwargs.pop("text_color")
require_redraw = True
if "command" in kwargs:
self.command = kwargs.pop("command")
if "textvariable" in kwargs:
self.textvariable = kwargs.pop("textvariable")
if self.text_label is not None:
self.text_label.configure(textvariable=self.textvariable)
if "width" in kwargs:
self.set_dimensions(width=kwargs.pop("width"))
if "height" in kwargs:
self.set_dimensions(height=kwargs.pop("height"))
super().configure(require_redraw=require_redraw, **kwargs)
2022-03-10 04:12:30 +03:00
def set_cursor(self):
if Settings.cursor_manipulation_enabled:
2022-05-02 00:29:14 +03:00
if self.state == tkinter.DISABLED:
if sys.platform == "darwin" and self.command is not None and Settings.cursor_manipulation_enabled:
2022-05-02 00:29:14 +03:00
self.configure(cursor="arrow")
elif sys.platform.startswith("win") and self.command is not None and Settings.cursor_manipulation_enabled:
2022-05-02 00:29:14 +03:00
self.configure(cursor="arrow")
elif self.state == tkinter.NORMAL:
if sys.platform == "darwin" and self.command is not None and Settings.cursor_manipulation_enabled:
2022-05-02 00:29:14 +03:00
self.configure(cursor="pointinghand")
elif sys.platform.startswith("win") and self.command is not None and Settings.cursor_manipulation_enabled:
2022-05-02 00:29:14 +03:00
self.configure(cursor="hand2")
2021-07-23 01:44:13 +03:00
def set_image(self, image):
""" will be removed in next major """
self.configure(image=image)
def set_text(self, text):
""" will be removed in next major """
self.configure(text=text)
2021-03-08 20:28:40 +03:00
2022-07-07 17:21:30 +03:00
def on_enter(self, event=None):
2022-03-10 04:12:30 +03:00
if self.hover is True and self.state == tkinter.NORMAL:
2022-01-08 02:29:53 +03:00
if self.hover_color is None:
inner_parts_color = self.fg_color
else:
inner_parts_color = self.hover_color
# set color of inner button parts to hover color
self.canvas.itemconfig("inner_parts",
2022-05-31 23:32:21 +03:00
outline=ThemeManager.single_color(inner_parts_color, self._appearance_mode),
fill=ThemeManager.single_color(inner_parts_color, self._appearance_mode))
2021-07-23 01:44:13 +03:00
# set text_label bg color to button hover color
2021-07-23 01:44:13 +03:00
if self.text_label is not None:
2022-05-31 23:32:21 +03:00
self.text_label.configure(bg=ThemeManager.single_color(inner_parts_color, self._appearance_mode))
2021-07-23 01:44:13 +03:00
# set image_label bg color to button hover color
2021-07-23 01:44:13 +03:00
if self.image_label is not None:
2022-05-31 23:32:21 +03:00
self.image_label.configure(bg=ThemeManager.single_color(inner_parts_color, self._appearance_mode))
2021-03-08 20:17:36 +03:00
2022-07-07 17:21:30 +03:00
def on_leave(self, event=None):
self.click_animation_running = False
2021-07-23 01:44:13 +03:00
if self.hover is True:
if self.fg_color is None:
inner_parts_color = self.bg_color
else:
inner_parts_color = self.fg_color
# set color of inner button parts
self.canvas.itemconfig("inner_parts",
2022-05-31 23:32:21 +03:00
outline=ThemeManager.single_color(inner_parts_color, self._appearance_mode),
fill=ThemeManager.single_color(inner_parts_color, self._appearance_mode))
2021-07-23 01:44:13 +03:00
# set text_label bg color (label color)
2021-07-23 01:44:13 +03:00
if self.text_label is not None:
2022-05-31 23:32:21 +03:00
self.text_label.configure(bg=ThemeManager.single_color(inner_parts_color, self._appearance_mode))
2021-07-23 01:44:13 +03:00
# set image_label bg color (image bg color)
2021-07-23 01:44:13 +03:00
if self.image_label is not None:
2022-05-31 23:32:21 +03:00
self.image_label.configure(bg=ThemeManager.single_color(inner_parts_color, self._appearance_mode))
2021-03-08 20:17:36 +03:00
def click_animation(self):
if self.click_animation_running:
self.on_enter()
2022-07-07 17:21:30 +03:00
def clicked(self, event=None):
if self.command is not None:
2021-07-23 01:44:13 +03:00
if self.state is not tkinter.DISABLED:
# click animation: change color with .on_leave() and back to normal after 100ms with click_animation()
2021-07-23 01:44:13 +03:00
self.on_leave()
self.click_animation_running = True
self.after(100, self.click_animation)
self.command()