tkintertools.core.containers¶

All container widgets

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

There are two container widgets at the canvas level: Canvas and Frame. Canvas is the main widget carrier in tkintertools, and Frame is similar to Canvas, but with a different default color. Frame is generally used for layout.

🟢Canvas¶

class public | Canvas

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

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

Scalable Canvas

The parent widget of all virtual widgets of tkintertools is Canvas

• master: parent widget
• expand: the mode of expand, x is horizontal, and y is vertical
• zoom_item: whether or not to scale its items
• 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
• kwargs: compatible with other parameters of class tkinter.Canvas

🟡_click¶

method protected

1
2
3
4
5

def _click(
    self,
    event: Event,
    type_: typing.Literal['left', 'center', 'right'],
) -> None: ...

🟡_copy¶

method protected

1
2
3
4

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

🟡_cut¶

method protected

1
2
3
4

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

🟡_initialization¶

method protected

1
2
3

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

🟡_input¶

method protected

1
2
3
4

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

🟡_move¶

method protected

1
2
3
4
5

def _move(
    self,
    event: Event,
    type_: typing.Literal['left', 'center', 'right', 'none'],
) -> None: ...

🟡_paste¶

method protected

1
2
3
4

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

🟡_re_place¶

method protected

1
2
3

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

Resize and position the Canvas based on the relevant parameters

WARNING:

This method only works for Canvas with Place layout

🟡_release¶

method protected

1
2
3
4
5

def _release(
    self,
    event: Event,
    type_: typing.Literal['left', 'center', 'right'],
) -> None: ...

🟡_select_all¶

method protected

1
2
3
4

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

🟡_theme¶

method protected

1
2
3
4

def _theme(
    self,
    dark: bool,
) -> None: ...

Change the color theme of the Canvas and its items

• dark: whether it is in dark mode

🟡_wheel¶

method protected

1
2
3
4
5

def _wheel(
    self,
    event: Event,
    type_: typing.Optional[typing.Literal['up', 'down']] = None,
) -> None: ...

🟡_zoom_children¶

method protected

1
2
3
4

def _zoom_children(
    self,
    relative_ratio: tuple[float, float],
) -> None: ...

🟡_zoom_self¶

method protected

1
2
3

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

🟡clear¶

method public

1
2
3

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

🟡create_text¶

method public

1
2
3
4
5
6
7

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

🟡destroy¶

method public

1
2
3

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

🟢Frame¶

class public | Canvas

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

def __init__(
    self,
    master: Tk | Canvas | Frame,
    *,
    expand: typing.Literal['', 'x', 'y', 'xy'] = 'xy',
    zoom_item: bool = False,
    keep_ratio: typing.Optional[typing.Literal['min', 'max']] = None,
    free_anchor: bool = False,
    name: str | None = None,
    **kwargs,
) -> None: ...

• master: parent widget
• expand: the mode of expand, x is horizontal, and y is vertical
• zoom_item: whether or not to scale its items
• 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
• kwargs: compatible with other parameters of class tkinter.Canvas

🟢Tk¶

class public | Tk

1
2
3
4
5
6
7
8

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

Main window

In general, there is only one main window

• size: the size of the window, default value is 1280x720(px)
• position: the position of the window, default value indicates that the location is random
• title: the title of the window, default value is an empty string
• **kwargs: compatible with other parameters of class tkinter.Tk

🟡_fixed_theme¶

method protected

1
2
3

def _fixed_theme(
    method,
) -> _empty: ...

This is a decorator that to fix a problem that some methods cause the window to lose its theme

• method: the method of being decorated

🟡_theme¶

method protected

1
2
3
4
5
6
7

def _theme(
    self,
    dark: bool,
    *,
    include_children: bool = True,
    include_canvases: bool = True,
) -> None: ...

Change the color theme of the window

• dark: whether it is in dark mode
• include_children: wether include its children, like Toplevel
• include_canvases: wether include its canvases

🟡_wrap_method¶

method protected

1
2
3
4

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

🟡_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: ...

Set or get the transparency of the window

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

🟡center¶

method public

1
2
3
4

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

Center the widget

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

🟡fullscreen¶

method public

1
2
3
4

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

Set or get whether the window is full-screen

• value: indicate whether the window is full-screen

TIPS:

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: ...

Change the size and position of the window and return the current size and position of the window

• 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

TIPS:

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

CAUTION:

This method causes the event <configure> to be triggered

🟡shutdown¶

method public

1
2
3
4
5
6
7

def shutdown(
    self,
    command: typing.Optional[typing.Callable],
    ensure_destroy: bool = False,
    *args,
    **kwargs,
) -> None: ...

Set a function that will be called when the window is closed

• command: the function that was called
• ensure_destroy: whether the window is guaranteed to be closed
• args: the variable-length argument of the called function
• kwargs: the keyword argument of the function being called

TIPS:

Regardless of whether the function is successfully called or not, the window will still close gracefully

🟡toolwindow¶

method public

1
2
3
4

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

Set or get whether the window is tool-window

• value: indicate whether the window is tool-window

🟡topmost¶

method public

1
2
3
4

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

Set or get whether the window is pinned or not

• value: indicate whether the window is topmost

🟡transparentcolor¶

method public

1
2
3
4

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

Set or get the penetration color of the window

• value: the penetration color of the window

🟢Toplevel¶

class public | Toplevel Tk

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

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

Toplevel window

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

• master: parent widget
• size: the size of the window, default value is 960x540(px)
• position: the position of the window, default value indicates that the location is random
• title: title of 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: ...