utils-py.md

Module TkEasyGUI.utils

TkEasyGUI utilities functions.

---

• Classes
• Functions

Classes of TkEasyGUI.utils

ImageResizeType

Image resize type.

class ImageResizeType(self, *args, **kwds):

• source

TkEasyError

TkEasyError Exception class.

class TkEasyError(self, message="TkEasyError"):

• source

Methods of TkEasyError

TkEasyError.add_note

Exception.add_note(note) -- add a note to the exception

TkEasyError.args

TkEasyError.with_traceback

Exception.with_traceback(tb) -- set self.traceback to tb and return self.

Functions of TkEasyGUI.utils

• append_text_file
• convert_color_html
• convert_color_rgb16
• copy_to_clipboard
• get_clipboard
• get_current_theme
• get_font_list
• get_platform
• get_root_window
• get_scaling
• get_screen_dpi
• get_screen_size
• get_system_info
• get_tcl_version
• get_tk_version
• get_tnemes
• is_mac
• is_win
• load_json_file
• load_text_file
• paste_from_clipboard
• save_json_file
• save_text_file
• screenshot
• set_clipboard
• set_default_theme
• set_theme
• str_to_float
• theme

append_text_file

Append text file.

def append_text_file(filename: str, text: str, encoding: str = "utf-8") -> None:

• source

convert_color_html

Convert RGB color(16bit tuple) to HTML color name.

def convert_color_html(color_name: str) -> str:

• source

convert_color_rgb16

Convert color to RGB, return (r, g, b) tuple. range=0-65535

def convert_color_rgb16(color_name: str) -> tuple[int, int, int]:

• source

copy_to_clipboard

Copy text to clipboard

def copy_to_clipboard(text):

• source

get_clipboard

Get text from clipboard

def get_clipboard():

• source

get_current_theme

Get current theme

def get_current_theme() -> str:

• source

get_font_list

Get font list

def get_font_list() -> list[str]:

• source

get_platform

Get platform

def get_platform() -> str:

• source

get_root_window

Get root window.

def get_root_window() -> tk.Tk:

• source

get_scaling

Get scaling factor.

def get_scaling() -> float:

• source

get_screen_dpi

Get screen DPI.

def get_screen_dpi() -> int:

• source

get_screen_size

Get screen size.

def get_screen_size() -> tuple[int, int]:

• source

get_system_info

Get system info

def get_system_info():

• source

get_tcl_version

Get tcl version

def get_tcl_version() -> str:

• source

get_tk_version

Get tk version

def get_tk_version() -> str:

• source

get_tnemes

Get theme list

print(get_themes())

def get_tnemes() -> tuple[str, ...]:

• source

is_mac

Platform : is mac?

def is_mac() -> bool:

• source

is_win

Platform : is Windows?

def is_win() -> bool:

• source

load_json_file

Load JSON file.

def load_json_file(filename: str, default_value: Any = None) -> Any:

• source

load_text_file

Load text file.

def load_text_file(
    filename: str, encoding: str = "utf-8", default_value: str = ""
) -> str:

• source

paste_from_clipboard

Get text from clipboard

def paste_from_clipboard():

• source

save_json_file

Save JSON file.

def save_json_file(filename: str, data: Any) -> None:

• source

save_text_file

Save text file.

def save_text_file(filename: str, text: str, encoding: str = "utf-8") -> None:

• source

screenshot

Take a screenshot.

def screenshot() -> PILImage.Image:

• source

set_clipboard

Copy text to clipboard

def set_clipboard(text):

• source

set_default_theme

Set default theme

print(get_themes())

def set_default_theme() -> None:

• source

set_theme

Change look and feel

• macOS --- ('aqua', 'clam', 'alt', 'default', 'classic')
• Windows --- ('winnative', 'clam', 'alt', 'default', 'classic', 'vista', 'xpnative')
• Linux --- ('clam', 'alt', 'default', 'classic')

def set_theme(name: str) -> None:

• source

str_to_float

Convert string to float.

def str_to_float(value: str, default_value: float = 0) -> float:

• source

theme

Set theme (alias of set_theme)

def theme(name: str) -> None:

• source