mirror of
https://github.com/TomSchimansky/CustomTkinter.git
synced 2023-08-10 21:13:13 +03:00
385 lines
18 KiB
Python
385 lines
18 KiB
Python
import tkinter
|
|
from typing import Union, Tuple, 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
|
|
from .utility import pop_from_dict_by_set, check_kwargs_empty
|
|
|
|
|
|
class CTkEntry(CTkBaseClass):
|
|
"""
|
|
Entry with rounded corners, border, textvariable support, focus and placeholder.
|
|
For detailed information check out the documentation.
|
|
"""
|
|
|
|
_minimum_x_padding = 6 # minimum padding between tkinter entry and frame border
|
|
|
|
# attributes that are passed to and managed by the tkinter entry only:
|
|
_valid_tk_entry_attributes = {"exportselection", "insertborderwidth", "insertofftime",
|
|
"insertontime", "insertwidth", "justify", "selectborderwidth",
|
|
"show", "takefocus", "validate", "validatecommand", "xscrollcommand"}
|
|
|
|
def __init__(self,
|
|
master: any,
|
|
width: int = 140,
|
|
height: int = 28,
|
|
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,
|
|
border_color: Optional[Union[str, Tuple[str, str]]] = None,
|
|
text_color: Optional[Union[str, Tuple[str, str]]] = None,
|
|
placeholder_text_color: Optional[Union[str, Tuple[str, str]]] = None,
|
|
|
|
textvariable: Union[tkinter.Variable, None] = None,
|
|
placeholder_text: Union[str, None] = None,
|
|
font: Optional[Union[tuple, CTkFont]] = None,
|
|
state: str = tkinter.NORMAL,
|
|
**kwargs):
|
|
|
|
# transfer basic functionality (bg_color, size, appearance_mode, scaling) to CTkBaseClass
|
|
super().__init__(master=master, bg_color=bg_color, width=width, height=height)
|
|
|
|
# configure grid system (1x1)
|
|
self.grid_rowconfigure(0, weight=1)
|
|
self.grid_columnconfigure(0, weight=1)
|
|
|
|
# color
|
|
self._fg_color = ThemeManager.theme["CTkEntry"]["fg_color"] if fg_color is None else self._check_color_type(fg_color, transparency=True)
|
|
self._text_color = ThemeManager.theme["CTkEntry"]["text_color"] if text_color is None else self._check_color_type(text_color)
|
|
self._placeholder_text_color = ThemeManager.theme["CTkEntry"]["placeholder_text_color"] if placeholder_text_color is None else self._check_color_type(placeholder_text_color)
|
|
self._border_color = ThemeManager.theme["CTkEntry"]["border_color"] if border_color is None else self._check_color_type(border_color)
|
|
|
|
# shape
|
|
self._corner_radius = ThemeManager.theme["CTkEntry"]["corner_radius"] if corner_radius is None else corner_radius
|
|
self._border_width = ThemeManager.theme["CTkEntry"]["border_width"] if border_width is None else border_width
|
|
|
|
# text and state
|
|
self._is_focused: bool = True
|
|
self._placeholder_text = placeholder_text
|
|
self._placeholder_text_active = False
|
|
self._pre_placeholder_arguments = {} # some set arguments of the entry will be changed for placeholder and then set back
|
|
self._textvariable = textvariable
|
|
self._state = state
|
|
self._textvariable_callback_name: str = ""
|
|
|
|
# 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)
|
|
|
|
if not (self._textvariable is None or self._textvariable == ""):
|
|
self._textvariable_callback_name = self._textvariable.trace_add("write", self._textvariable_callback)
|
|
|
|
self._canvas = CTkCanvas(master=self,
|
|
highlightthickness=0,
|
|
width=self._apply_widget_scaling(self._current_width),
|
|
height=self._apply_widget_scaling(self._current_height))
|
|
self._draw_engine = DrawEngine(self._canvas)
|
|
|
|
self._entry = tkinter.Entry(master=self,
|
|
bd=0,
|
|
width=1,
|
|
highlightthickness=0,
|
|
font=self._apply_font_scaling(self._font),
|
|
state=self._state,
|
|
textvariable=self._textvariable,
|
|
**pop_from_dict_by_set(kwargs, self._valid_tk_entry_attributes))
|
|
|
|
check_kwargs_empty(kwargs, raise_error=True)
|
|
|
|
self._create_grid()
|
|
self._activate_placeholder()
|
|
self._create_bindings()
|
|
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 == "<FocusIn>":
|
|
self._entry.bind("<FocusIn>", self._entry_focus_in)
|
|
if sequence is None or sequence == "<FocusOut>":
|
|
self._entry.bind("<FocusOut>", self._entry_focus_out)
|
|
|
|
def _create_grid(self):
|
|
self._canvas.grid(column=0, row=0, sticky="nswe")
|
|
|
|
if self._corner_radius >= self._minimum_x_padding:
|
|
self._entry.grid(column=0, row=0, sticky="nswe",
|
|
padx=min(self._apply_widget_scaling(self._corner_radius), round(self._apply_widget_scaling(self._current_height/2))),
|
|
pady=(self._apply_widget_scaling(self._border_width), self._apply_widget_scaling(self._border_width + 1)))
|
|
else:
|
|
self._entry.grid(column=0, row=0, sticky="nswe",
|
|
padx=self._apply_widget_scaling(self._minimum_x_padding),
|
|
pady=(self._apply_widget_scaling(self._border_width), self._apply_widget_scaling(self._border_width + 1)))
|
|
|
|
def _textvariable_callback(self, var_name, index, mode):
|
|
if self._textvariable.get() == "":
|
|
self._activate_placeholder()
|
|
|
|
def _set_scaling(self, *args, **kwargs):
|
|
super()._set_scaling(*args, **kwargs)
|
|
|
|
self._entry.configure(font=self._apply_font_scaling(self._font))
|
|
self._canvas.configure(width=self._apply_widget_scaling(self._desired_width), height=self._apply_widget_scaling(self._desired_height))
|
|
self._create_grid()
|
|
self._draw(no_color_updates=True)
|
|
|
|
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(no_color_updates=True)
|
|
|
|
def _update_font(self):
|
|
""" pass font to tkinter widgets with applied font scaling and update grid with workaround """
|
|
self._entry.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._canvas.grid_forget()
|
|
self._canvas.grid(column=0, row=0, sticky="nswe")
|
|
|
|
def destroy(self):
|
|
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 = 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),
|
|
self._apply_widget_scaling(self._border_width))
|
|
|
|
if requires_recoloring or no_color_updates is False:
|
|
self._canvas.configure(bg=self._apply_appearance_mode(self._bg_color))
|
|
|
|
if self._apply_appearance_mode(self._fg_color) == "transparent":
|
|
self._canvas.itemconfig("inner_parts",
|
|
fill=self._apply_appearance_mode(self._bg_color),
|
|
outline=self._apply_appearance_mode(self._bg_color))
|
|
self._entry.configure(bg=self._apply_appearance_mode(self._bg_color),
|
|
disabledbackground=self._apply_appearance_mode(self._bg_color),
|
|
readonlybackground=self._apply_appearance_mode(self._bg_color),
|
|
highlightcolor=self._apply_appearance_mode(self._bg_color))
|
|
else:
|
|
self._canvas.itemconfig("inner_parts",
|
|
fill=self._apply_appearance_mode(self._fg_color),
|
|
outline=self._apply_appearance_mode(self._fg_color))
|
|
self._entry.configure(bg=self._apply_appearance_mode(self._fg_color),
|
|
disabledbackground=self._apply_appearance_mode(self._fg_color),
|
|
readonlybackground=self._apply_appearance_mode(self._fg_color),
|
|
highlightcolor=self._apply_appearance_mode(self._fg_color))
|
|
|
|
self._canvas.itemconfig("border_parts",
|
|
fill=self._apply_appearance_mode(self._border_color),
|
|
outline=self._apply_appearance_mode(self._border_color))
|
|
|
|
if self._placeholder_text_active:
|
|
self._entry.config(fg=self._apply_appearance_mode(self._placeholder_text_color),
|
|
disabledforeground=self._apply_appearance_mode(self._placeholder_text_color),
|
|
insertbackground=self._apply_appearance_mode(self._placeholder_text_color))
|
|
else:
|
|
self._entry.config(fg=self._apply_appearance_mode(self._text_color),
|
|
disabledforeground=self._apply_appearance_mode(self._text_color),
|
|
insertbackground=self._apply_appearance_mode(self._text_color))
|
|
|
|
def configure(self, require_redraw=False, **kwargs):
|
|
if "state" in kwargs:
|
|
self._state = kwargs.pop("state")
|
|
self._entry.configure(state=self._state)
|
|
|
|
if "fg_color" in kwargs:
|
|
self._fg_color = self._check_color_type(kwargs.pop("fg_color"))
|
|
require_redraw = True
|
|
|
|
if "text_color" in kwargs:
|
|
self._text_color = self._check_color_type(kwargs.pop("text_color"))
|
|
require_redraw = True
|
|
|
|
if "placeholder_text_color" in kwargs:
|
|
self._placeholder_text_color = self._check_color_type(kwargs.pop("placeholder_text_color"))
|
|
require_redraw = True
|
|
|
|
if "border_color" in kwargs:
|
|
self._border_color = self._check_color_type(kwargs.pop("border_color"))
|
|
require_redraw = True
|
|
|
|
if "border_width" in kwargs:
|
|
self._border_width = kwargs.pop("border_width")
|
|
self._create_grid()
|
|
require_redraw = True
|
|
|
|
if "corner_radius" in kwargs:
|
|
self._corner_radius = kwargs.pop("corner_radius")
|
|
self._create_grid()
|
|
require_redraw = True
|
|
|
|
if "placeholder_text" in kwargs:
|
|
self._placeholder_text = kwargs.pop("placeholder_text")
|
|
if self._placeholder_text_active:
|
|
self._entry.delete(0, tkinter.END)
|
|
self._entry.insert(0, self._placeholder_text)
|
|
else:
|
|
self._activate_placeholder()
|
|
|
|
if "textvariable" in kwargs:
|
|
self._textvariable = kwargs.pop("textvariable")
|
|
self._entry.configure(textvariable=self._textvariable)
|
|
|
|
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 "show" in kwargs:
|
|
if self._placeholder_text_active:
|
|
self._pre_placeholder_arguments["show"] = kwargs.pop("show") # remember show argument for when placeholder gets deactivated
|
|
else:
|
|
self._entry.configure(show=kwargs.pop("show"))
|
|
|
|
self._entry.configure(**pop_from_dict_by_set(kwargs, self._valid_tk_entry_attributes)) # configure Tkinter.Entry
|
|
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 == "border_width":
|
|
return self._border_width
|
|
|
|
elif attribute_name == "fg_color":
|
|
return self._fg_color
|
|
elif attribute_name == "border_color":
|
|
return self._border_color
|
|
elif attribute_name == "text_color":
|
|
return self._text_color
|
|
elif attribute_name == "placeholder_text_color":
|
|
return self._placeholder_text_color
|
|
|
|
elif attribute_name == "textvariable":
|
|
return self._textvariable
|
|
elif attribute_name == "placeholder_text":
|
|
return self._placeholder_text
|
|
elif attribute_name == "font":
|
|
return self._font
|
|
elif attribute_name == "state":
|
|
return self._state
|
|
|
|
elif attribute_name in self._valid_tk_entry_attributes:
|
|
return self._entry.cget(attribute_name) # cget of tkinter.Entry
|
|
else:
|
|
return super().cget(attribute_name) # cget of CTkBaseClass
|
|
|
|
def bind(self, sequence=None, command=None, add=True):
|
|
""" called on the tkinter.Entry """
|
|
if not (add == "+" or add is True):
|
|
raise ValueError("'add' argument can only be '+' or True to preserve internal callbacks")
|
|
self._entry.bind(sequence, command, add=True)
|
|
|
|
def unbind(self, sequence=None, funcid=None):
|
|
""" called on the tkinter.Entry """
|
|
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._entry.unbind(sequence, None) # unbind all callbacks for sequence
|
|
self._create_bindings(sequence=sequence) # restore internal callbacks for sequence
|
|
|
|
def _activate_placeholder(self):
|
|
if self._entry.get() == "" and self._placeholder_text is not None and (self._textvariable is None or self._textvariable == ""):
|
|
self._placeholder_text_active = True
|
|
|
|
self._pre_placeholder_arguments = {"show": self._entry.cget("show")}
|
|
self._entry.config(fg=self._apply_appearance_mode(self._placeholder_text_color),
|
|
disabledforeground=self._apply_appearance_mode(self._placeholder_text_color),
|
|
show="")
|
|
self._entry.delete(0, tkinter.END)
|
|
self._entry.insert(0, self._placeholder_text)
|
|
|
|
def _deactivate_placeholder(self):
|
|
if self._placeholder_text_active and self._entry.cget("state") != "readonly":
|
|
self._placeholder_text_active = False
|
|
|
|
self._entry.config(fg=self._apply_appearance_mode(self._text_color),
|
|
disabledforeground=self._apply_appearance_mode(self._text_color),)
|
|
self._entry.delete(0, tkinter.END)
|
|
for argument, value in self._pre_placeholder_arguments.items():
|
|
self._entry[argument] = value
|
|
|
|
def _entry_focus_out(self, event=None):
|
|
self._activate_placeholder()
|
|
self._is_focused = False
|
|
|
|
def _entry_focus_in(self, event=None):
|
|
self._deactivate_placeholder()
|
|
self._is_focused = True
|
|
|
|
def delete(self, first_index, last_index=None):
|
|
self._entry.delete(first_index, last_index)
|
|
|
|
if not self._is_focused and self._entry.get() == "":
|
|
self._activate_placeholder()
|
|
|
|
def insert(self, index, string):
|
|
self._deactivate_placeholder()
|
|
|
|
return self._entry.insert(index, string)
|
|
|
|
def get(self):
|
|
if self._placeholder_text_active:
|
|
return ""
|
|
else:
|
|
return self._entry.get()
|
|
|
|
def focus(self):
|
|
self._entry.focus()
|
|
|
|
def focus_set(self):
|
|
self._entry.focus_set()
|
|
|
|
def focus_force(self):
|
|
self._entry.focus_force()
|
|
|
|
def index(self, index):
|
|
return self._entry.index(index)
|
|
|
|
def icursor(self, index):
|
|
return self._entry.icursor(index)
|
|
|
|
def select_adjust(self, index):
|
|
return self._entry.select_adjust(index)
|
|
|
|
def select_from(self, index):
|
|
return self._entry.icursor(index)
|
|
|
|
def select_clear(self):
|
|
return self._entry.select_clear()
|
|
|
|
def select_present(self):
|
|
return self._entry.select_present()
|
|
|
|
def select_range(self, start_index, end_index):
|
|
return self._entry.select_range(start_index, end_index)
|
|
|
|
def select_to(self, index):
|
|
return self._entry.select_to(index)
|
|
|
|
def xview(self, index):
|
|
return self._entry.xview(index)
|
|
|
|
def xview_moveto(self, f):
|
|
return self._entry.xview_moveto(f)
|
|
|
|
def xview_scroll(self, number, what):
|
|
return self._entry.xview_scroll(number, what)
|