maliang.core.virtual¶

源代码：maliang/core/virtual.py

All virtual classes.

The virtual.Widget consists of five parts, which are Shape, Text, Image, Style and Feature. In addition, they can be nested within each other.

Where Feature is the function of widgets, Style control the color of the widget, and each widget can be bound to up to one Feature and one Style, but in terms of appearance, there is no limit to the number of Shape, Text, and Image.

Shape, Text, and Image are all appearance elements that inherit from abstract base class Elements.

🟢Element¶

class public | ABC

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

def __init__(
    self,
    widget: Widget,
    position: tuple[int, int] = (0, 0),
    size: tuple[int, int] | None = None,
    *,
    name: str | None = None,
    gradient_animation: bool | None = None,
    **kwargs,
) -> None: ...

• widget: parent widget
• position: position relative to its widgets
• size: size of element
• name: name of element
• gradient_animation: Wether use animation to change color
• kwargs: extra parameters for CanvasItem

🟡center¶

method public

1
2
3

def center(
    self,
) -> tuple[float, float]: ...

🟡configure¶

method public

1
2
3
4
5
6

def configure(
    self,
    style: dict[str, str],
    *,
    gradient_animation: bool = True,
) -> None: ...

• style: style data
• gradient_animation: whether use gradient animation

🟡coords¶

method public

1
2
3
4
5

def coords(
    self,
    size: tuple[float, float] | None = None,
    position: tuple[float, float] | None = None,
) -> None: ...

• size: new size of the element
• position: new position of the element

🟡destroy¶

method public

1
2
3

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

🟡detect¶

method public

1
2
3
4
5

def detect(
    self,
    x: float,
    y: float,
) -> bool: ...

• x: x-coordinate of the location to be detected
• y: y-coordinate of the location to be detected

🟡display¶

method public

1
2
3

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

🟡forget¶

method public

1
2
3
4
5
6

def forget(
    self,
    value: bool = True,
    *,
    gradient_animation: bool = False,
) -> None: ...

• value: whether to forget
• gradient_animation: whether use gradient animation

🟡move¶

method public

1
2
3
4
5

def move(
    self,
    dx: float,
    dy: float,
) -> None: ...

• dx: x-coordinate offset
• dy: y-coordinate offset

🟡moveto¶

method public

1
2
3
4
5

def moveto(
    self,
    x: float,
    y: float,
) -> None: ...

• x: x-coordinate of the target location
• y: y-coordinate of the target location

🟡region¶

method public

1
2
3

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

🟡update¶

method public

1
2
3
4
5
6

def update(
    self,
    state: str | None = None,
    *,
    gradient_animation: bool = False,
) -> None: ...

• state: the state of the Element
• gradient_animation: whether use gradient animation

🟡zoom¶

method public

1
2
3
4
5
6
7

def zoom(
    self,
    ratios: tuple[float, float],
    *,
    zoom_position: bool = True,
    zoom_size: bool = True,
) -> None: ...

• ratios: ratios of zooming
• zoom_position: whether or not to zoom the location of the element
• zoom_size: whether or not to zoom the size of the element

🟢Feature¶

class public | object

1
2
3
4

def __init__(
    self,
    widget: Widget,
) -> None: ...

• widget: parent widget

🟡_parse_method_name¶

method protected

1
2
3

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

• name: original name

Example:

• "<Ctrl-C>" -> "_ctrl_c"
• "<MouseWheel>" -> "_mouse_wheel"

🟡get_method¶

method public

1
2
3
4

def get_method(
    self,
    name: str,
) -> collections.abc.Callable: ...

• name: name of the method

🟢Image¶

class public | Element

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

def __init__(
    self,
    widget: Widget,
    relative_position: tuple[int, int] = (0, 0),
    size: tuple[int, int] | None = None,
    *,
    image: enhanced.PhotoImage | None = None,
    name: str | None = None,
    gradient_animation: bool = True,
    **kwargs,
) -> None: ...

• widget: parent widget
• relative_position: position relative to its widgets
• size: size of element
• image: image object of the element
• name: name of element
• gradient_animation: Wether use animation to change color
• kwargs: extra parameters for CanvasItem

🟡region¶

method public

1
2
3

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

🟡zoom¶

method public

1
2
3
4
5
6
7

def zoom(
    self,
    ratios: tuple[float, float],
    *,
    zoom_position: bool = True,
    zoom_size: bool = True,
) -> None: ...

• ratios: ratios of zooming
• zoom_position: whether or not to zoom the location of the image
• zoom_size: whether or not to zoom the size of the image

🟢Shape¶

class public | Element

🟡zoom¶

method public

1
2
3
4
5
6
7

def zoom(
    self,
    ratios: tuple[float, float],
    *,
    zoom_position: bool = True,
    zoom_size: bool = True,
) -> None: ...

• ratios: ratios of zooming
• zoom_position: whether or not to zoom the location of the shape
• zoom_size: whether or not to zoom the size of the shape

🟢Style¶

class public | object

1
2
3
4
5
6

def __init__(
    self,
    widget: Widget,
    *,
    auto_update: bool | None = None,
) -> None: ...

• widget: parent widget
• auto_update: whether the theme manager update it automatically

🟡__getitem__¶

method special

1
2
3
4

def __getitem__(
    self,
    key: Element | str | int,
) -> dict[str, dict[str, str]]: ...

🟡_get_key¶

method protected

1
2
3
4

def _get_key(
    self,
    key: Element | str | int,
) -> str: ...

• key: the object related to the key

🟡_set¶

method protected

1
2
3
4
5
6

def _set(
    self,
    theme: typing.Literal['light', 'dark'] | None = None,
    data: tuple[str | types.EllipsisType, ...] | str | None = None,
    **kwargs: tuple[Element | str | int, ...] | Element | str | int,
) -> None: ...

• theme: the theme name, None indicates both
• data: data of color
• kwargs: { arg name: element key or element keys tuple }

🟡_wrap_arg¶

method protected

1
2
3

def _wrap_arg(
    arg: tuple[str | types.EllipsisType | None, ...] | str,
) -> tuple[str | types.EllipsisType | None, ...]: ...

• arg: argument

🟡get¶

method public

1
2
3
4
5

def get(
    self,
    *,
    theme: typing.Literal['light', 'dark'] | None = None,
) -> dict[str, dict[str, dict[str, str]]]: ...

• theme: the theme of the widget, None indicates the current theme

🟡get_disabled_style¶

method public

1
2
3
4
5

def get_disabled_style(
    self,
    *,
    element: Element,
) -> dict[str, str]: ...

• element: element that style to be calculated

🟡init¶

method public

1
2
3
4
5
6

def init(
    self,
    key: Element | str | int,
    *,
    theme: typing.Literal['light', 'dark'] | None = None,
) -> None: ...

• name: the key of the element
• theme: the theme name, None indicates both

🟡reset¶

method public

1
2
3
4
5

def reset(
    self,
    *,
    theme: typing.Literal['light', 'dark'] | None = None,
) -> None: ...

• theme: the theme to be reset, None indicates both

🟡set¶

method public

1
2
3

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

🟢Text¶

class public | Element

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

def __init__(
    self,
    widget: Widget,
    relative_position: tuple[int, int] = (0, 0),
    size: tuple[int, int] | None = None,
    *,
    text: str = '',
    limit: int = -1,
    show: str | None = None,
    placeholder: str = '',
    family: str | None = None,
    fontsize: int | None = None,
    weight: typing.Literal['normal', 'bold'] = 'normal',
    slant: typing.Literal['roman', 'italic'] = 'roman',
    underline: bool = False,
    overstrike: bool = False,
    name: str | None = None,
    gradient_animation: bool = True,
    **kwargs,
) -> None: ...

• widget: parent widget
• relative_position: position relative to its widgets
• size: size of element
• text: text value
• family: font family
• fontsize: font size
• weight: weight of the font
• slant: slant of the font
• underline: wether text is underline
• overstrike: wether text is overstrike
• limit: limit on the number of characters
• show: display a value that obscures the original content
• placeholder: a placeholder for the prompt
• name: name of element
• gradient_animation: Wether use animation to change color
• kwargs: extra parameters for CanvasItem

🟡region¶

method public

1
2
3

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

🟡zoom¶

method public

1
2
3
4
5
6
7

def zoom(
    self,
    ratios: tuple[float, float],
    *,
    zoom_position: bool = True,
    zoom_size: bool = True,
) -> None: ...

• ratios: ratios of zooming
• zoom_position: whether or not to zoom the location of the text
• zoom_size: whether or not to zoom the size of the text

🟢Widget¶

class public | object

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

def __init__(
    self,
    master: containers.Canvas | Widget,
    position: tuple[int, int] = (0, 0),
    size: tuple[int, int] | None = None,
    *,
    anchor: typing.Literal['n', 's', 'w', 'e', 'nw', 'ne', 'sw', 'se', 'center'] = 'nw',
    capture_events: bool | None = None,
    gradient_animation: bool | None = None,
    auto_update: bool | None = None,
    style: type[Style] | None = None,
) -> None: ...

Widget = Element + Style + Feature

• master: parent canvas
• position: position of the widget
• size: size of the widget
• anchor: layout anchor of the widget
• capture_events: wether detect another widget under the widget
• gradient_animation: wether enable animation
• auto_update: whether the theme manager update it automatically
• style: style of the widget

🟡bind¶

method public

1
2
3
4
5
6

def bind(
    self,
    sequence: str,
    command: collections.abc.Callable[[tkinter.Event], typing.Any],
    add: bool | typing.Literal['', '+'] | None = None,
) -> None: ...

• sequence: event name
• command: callback function
• add: if True, original callback function will not be overwritten

🟡bind_on_update¶

method public

1
2
3
4

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

This extra function has two positional arguments, both of which are arguments to the method update. And this extra function will be called when the widget is updated (whether it’s automatically updated or manually updated).

• command: the extra function that is bound

🟡deregister_elements¶

method public

1
2
3
4

def deregister_elements(
    self,
    *elements: Element,
) -> None: ...

• elements: elements to be deregistered

🟡destroy¶

method public

1
2
3

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

🟡detect¶

method public

1
2
3
4
5

def detect(
    self,
    x: float,
    y: float,
) -> bool: ...

• x: x-coordinate of the location to be detected
• y: y-coordinate of the location to be detected

🟡disable¶

method public

1
2
3
4

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

• value: whether to disable

🟡forget¶

method public

1
2
3
4

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

• value: whether to forget the widget

🟡generate_event¶

method public

1
2
3
4
5
6

def generate_event(
    self,
    sequence: str,
    event: tkinter.Event | None = None,
    **kwargs,
) -> None: ...

• sequence: event name
• event: event
• kwargs: attr of event

🟡move¶

method public

1
2
3
4
5

def move(
    self,
    dx: float,
    dy: float,
) -> None: ...

• dx: x-coordinate offset
• dy: y-coordinate offset

🟡moveto¶

method public

1
2
3
4
5

def moveto(
    self,
    x: float,
    y: float,
) -> None: ...

• x: x-coordinate of the target location
• y: y-coordinate of the target location

🟡register_elements¶

method public

1
2
3
4

def register_elements(
    self,
    *elements: Element,
) -> None: ...

• elements: elements to be registered

🟡unbind¶

method public

1
2
3
4
5

def unbind(
    self,
    sequence: str,
    command: collections.abc.Callable[[tkinter.Event], typing.Any],
) -> None: ...

• sequence: event name
• command: callback function

🟡unbind_on_update¶

method public

1
2
3
4

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

• command: the extra function that is bound

🟡update¶

method public

1
2
3
4
5
6
7

def update(
    self,
    state: str | None = None,
    *,
    gradient_animation: bool | None = None,
    nested: bool = True,
) -> None: ...

• state: state of the widget
• gradient_animation: whether use gradient animation
• nested: whether nested

🟡zoom¶

method public

1
2
3
4
5
6
7

def zoom(
    self,
    ratios: tuple[float, float] | None = None,
    *,
    zoom_position: bool = True,
    zoom_size: bool = True,
) -> None: ...

• ratios: ratios of zooming
• zoom_position: whether or not to zoom the location of the widget
• zoom_size: whether or not to zoom the size of the widget