maliang.toolbox.utility¶

源代码：maliang/toolbox/utility.py

Some useful utility classes or utility functions.

🟢Trigger¶

class public | object

1
2
3
4

def __init__(
    self,
    command: collections.abc.Callable[..., typing.Any],
) -> None: ...

It can only be triggered once before the reset, and multiple triggers are invalid. When triggered, the callback function is called.

• command: the function that is called when triggered

🟡get¶

method public

1
2
3

def get(
    self,
) -> bool: ...

🟡lock¶

method public

1
2
3

def lock(
    self,
) -> None: ...

🟡reset¶

method public

1
2
3

def reset(
    self,
) -> None: ...

🟡unlock¶

method public

1
2
3

def unlock(
    self,
) -> None: ...

🟡update¶

method public

1
2
3
4
5
6
7

def update(
    self,
    value: bool = True,
    /,
    *args,
    **kwargs,
) -> None: ...

• value: updated value
• args: args of the command
• kwargs: kwargs of the command

🔵create_smoke¶

function public

1
2
3
4
5

def create_smoke(
    size: tuple[int, int],
    *,
    color: str | tuple[int, int, int, int] = '#00000066',
) -> enhanced.PhotoImage: ...

• size: size of the smoke zone
• color: color of the smoke zone

This function need PIL to run.

About the “smoke”, see: https://fluent2.microsoft.design/material#smoke

🔵embed_window¶

function public

1
2
3
4
5
6

def embed_window(
    window: tkinter.Misc,
    parent: tkinter.Misc | None,
    *,
    focus: bool = False,
) -> None: ...

• window: Widget that will be embedded in
• parent: parent widget, None indicates that the parent widget is the screen
• focus: whether direct input focus to this window

🔵fix_cursor¶

function public

1
2
3

def fix_cursor(
    name: str,
) -> str: ...

• name: name of cursor

🔵get_parent¶

function public

1
2
3

def get_parent(
    widget: tkinter.Misc,
) -> int: ...

• widget: the widget

🔵get_text_size¶

function public

1
2
3
4
5
6
7
8
9

def get_text_size(
    text: str,
    fontsize: int | None = None,
    family: str | None = None,
    *,
    padding: int = 0,
    master: tkinter.Canvas | virtual.Widget | None = None,
    **kwargs,
) -> tuple[int, int]: ...

• text: the text
• fontsize: font size of the text
• family: font family of the text
• padding: extra padding of the size
• master: default canvas or widget provided
• kwargs: kwargs of tkinter.font.Font

This function only works when the fontsize is negative number!

🔵load_font¶

function public

1
2
3
4
5
6

def load_font(
    font_path: str | bytes,
    *,
    private: bool = True,
    enumerable: bool = False,
) -> bool: ...

• font_path: the font file path
• private: if True, other processes cannot see this font(Only Windows OS), and this font will be unloaded when the process dies
• enumerable: if True, this font will appear when enumerating fonts(Only Windows OS)

This function only works on Windows and Linux OS.

This function is referenced from customtkinter.FontManager.load_font, CustomTkinter: TomSchimansky/CustomTkinter.

🔵screen_size¶

function public

1
2

def screen_size(
) -> tuple[int, int]: ...