maliang.core.containers¶

源代码：maliang/core/containers.py

All containers.

There are two containers at the window level: Tk and Toplevel. Tk is generally used for the main window, while Toplevel is a pop-up window.

There is another container at the canvas level: Canvas. Canvas is the main container carrier.

🟢Canvas¶

class public | Canvas Misc

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

def __init__(
    self,
    master: Tk | Toplevel | Canvas | None = None,
    *,
    expand: typing.Literal['', 'x', 'y', 'xy'] = 'xy',
    auto_zoom: bool = False,
    keep_ratio: typing.Literal['min', 'max'] | None = None,
    free_anchor: bool = False,
    auto_update: bool | None = None,
    zoom_all_items: bool = False,
    **kwargs,
) -> None: ...

The parent widget of all virtual widgets is Canvas.

• master: parent widget
• expand: the mode of expand, x is horizontal, and y is vertical
• auto_zoom: whether or not to scale its items automatically
• keep_ratio: the mode of aspect ratio, min follows the minimum value, max follows the maximum value
• free_anchor: whether the anchor point is free-floating
• auto_update: whether the theme manager update it automatically
• zoom_all_items: (Experimental) whether or not to scale its all items
• kwargs: compatible with other parameters of class tkinter.Canvas

🟡_initialization¶

method protected

1
2
3

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

🟡_zoom_self¶

method protected

1
2
3

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

🟡_zoom_tk_widgets¶

method protected

1
2
3
4

def _zoom_tk_widgets(
    self,
    rel_ratio: tuple[float, float],
) -> None: ...

• rel_ratio: the ratio of the current size to the previous size

🟡clear¶

method public

1
2
3

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

🟡create_text¶

method public

1
2
3
4
5
6
7
8

def create_text(
    self,
    x: float,
    y: float,
    /,
    *args,
    **kwargs,
) -> int: ...

🟡destroy¶

method public

1
2
3

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

🟡on_click¶

method public

1
2
3
4
5

def on_click(
    self,
    event: tkinter.Event,
    name: str,
) -> None: ...

🟡on_key_press¶

method public

1
2
3
4

def on_key_press(
    self,
    event: tkinter.Event,
) -> None: ...

🟡on_key_release¶

method public

1
2
3
4

def on_key_release(
    self,
    event: tkinter.Event,
) -> None: ...

🟡on_motion¶

method public

1
2
3
4
5

def on_motion(
    self,
    event: tkinter.Event,
    name: str,
) -> None: ...

🟡on_release¶

method public

1
2
3
4
5

def on_release(
    self,
    event: tkinter.Event,
    name: str,
) -> None: ...

🟡on_wheel¶

method public

1
2
3
4
5

def on_wheel(
    self,
    event: tkinter.Event,
    type_: bool | None,
) -> None: ...

🟡register_event¶

method public

1
2
3
4
5
6

def register_event(
    self,
    name: str,
    *,
    add: bool | typing.Literal['', '+'] | None = None,
) -> str: ...

• name: event name, such as ““
• add: whether it is an attached call

In general, you don’t need to call this method, but when the event to be bound is not in the predefined event, you need to manually call the method once.

🟡theme¶

method public

1
2
3
4

def theme(
    self,
    value: typing.Literal['light', 'dark'],
) -> None: ...

• value: theme name

🟡zoom¶

method public

1
2
3

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

This method only works for Canvas with Place layout.

🟢Misc¶

class public | ABC

🟡__enter__¶

method special

1
2
3

def __enter__(
    self,
) -> typing_extensions.Self: ...

🟡__exit__¶

method special

1
2
3
4
5

def __exit__(
    self,
    *args,
    **kwargs,
) -> None: ...

🟡destroy¶

method public

1
2
3

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

🟢Tk¶

class public | Tk Misc

1
2
3
4
5
6
7
8
9

def __init__(
    self,
    size: tuple[int, int] = (1280, 720),
    position: tuple[int, int] | None = None,
    *,
    title: str | None = None,
    icon: str | enhanced.PhotoImage | None = None,
    **kwargs,
) -> None: ...

In general, there is only one main window. But after destroying it, another one can be created.

• size: size of the window
• position: position of the window, based on the upper left (nw) corner. And negative numbers are based on the bottom right (se) corner.
• title: title of the window, default value is "tk"
• icon: icon of the window, default value is the icon of tk
• **kwargs: compatible with other parameters of class tkinter.Tk

🟡_fixed_theme¶

method protected

1
2
3

def _fixed_theme(
    method,
) -> collections.abc.Callable: ...

• method: the method of being decorated

🟡_wrap_method¶

method protected

1
2
3
4

def _wrap_method(
    self,
    method_name: str,
) -> None: ...

• method_name: the name of the method to be decorated

🟡_zoom¶

method protected

1
2
3

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

🟡alpha¶

method public

1
2
3
4

def alpha(
    self,
    value: float | None = None,
) -> float | None: ...

• value: the transparency of the window, range is 0~1

🟡at_exit¶

method public

1
2
3
4
5
6

def at_exit(
    self,
    command: collections.abc.Callable[[], typing.Any],
    *,
    ensure_destroy: bool = True,
) -> None: ...

• command: the function that was called
• ensure_destroy: whether the window is guaranteed to be closed

🟡center¶

method public

1
2
3
4
5

def center(
    self,
    *,
    refer: tkinter.Misc | None = None,
) -> None: ...

refer: The area of the reference widget, if it is None, means that the reference area is the entire screen.

🟡destroy¶

method public

1
2
3

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

🟡fullscreen¶

method public

1
2
3
4

def fullscreen(
    self,
    value: bool | None = True,
) -> bool | None: ...

• value: indicate whether the window is full-screen

The method should be called at the end of the code, or after some time after the program has started.

🟡geometry¶

method public

1
2
3
4
5
6

def geometry(
    self,
    *,
    size: tuple[int, int] | None = None,
    position: tuple[int, int] | None = None,
) -> tuple[int, int, int, int] | None: ...

• size: the size of the window, if it is None, does not change anything
• position: the position of the window, if it is None, does not change anything

If you want to use tkinter.Tk.geometry, please use tkinter.Tk.wm_geometry instead.

🟡icon¶

method public

1
2
3
4

def icon(
    self,
    value: str | enhanced.PhotoImage,
) -> None: ...

• value: the icon

🟡theme¶

method public

1
2
3
4
5
6
7

def theme(
    self,
    value: typing.Literal['light', 'dark'],
    *,
    include_children: bool = True,
    include_canvases: bool = True,
) -> None: ...

• value: theme name
• include_children: wether include its children, like Toplevel
• include_canvases: wether include its canvases

🟡toolwindow¶

method public

1
2
3
4

def toolwindow(
    self,
    value: bool | None = True,
) -> bool | None: ...

• value: indicate whether the window is tool-window

This method only works on Windows!

🟡topmost¶

method public

1
2
3
4

def topmost(
    self,
    value: bool | None = True,
) -> bool | None: ...

• value: indicate whether the window is topmost

🟡transparentcolor¶

method public

1
2
3
4

def transparentcolor(
    self,
    value: str | None = None,
) -> str | None: ...

• value: the penetration color of the window

This method only works on Windows!

🟢Toplevel¶

class public | Toplevel Tk Misc

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

def __init__(
    self,
    master: Tk | Toplevel | None = None,
    size: tuple[int, int] = (960, 540),
    position: tuple[int, int] | None = None,
    *,
    title: str | None = None,
    icon: str | enhanced.PhotoImage | None = None,
    grab: bool = False,
    focus: bool = True,
    **kwargs,
) -> None: ...

It can be used as a pop-up window, or it can be customized to put anything you want to show.

• master: parent widget
• size: size of the window, default value is 960x540(px)
• position: position of the window, default value indicates random
• title: title of window, default is the same as title of master
• icon: icon of the window, default is the same as title of master
• grab: set grab for this window
• focus: whether direct input focus to this window
• **kwargs: compatible with other parameters of class tkinter.Toplevel

🟡destroy¶

method public

1
2
3

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