kvex.widgets.screen

 1"""Home of `ScreenManager` and `XScreen`."""
 2
 3from typing import Literal
 4from .. import kivy as kv
 5from .widget import XWidget
 6
 7
 8class XScreen(XWidget, kv.Screen):
 9    """Screen."""
10
11
12class XScreenManager(XWidget, kv.ScreenManager):
13    """ScreenManager with custom transition behavior."""
14
15    def add_screen(self, name: str, widget: kv.Widget) -> XScreen:
16        """Create and add a screen from a widget."""
17        screen = XScreen(name=name)
18        screen.add_widget(widget)
19        self.add_widget(screen)
20        return screen
21
22    def screen_direction(self, name: str, /) -> Literal["left", "right"]:
23        """Compare index of a screen by name to the current screen.
24
25        Useful for setting transition direction:
26        ```python3
27        sm = XScreenManager()
28        sm.transition.direction = sm.screen_direction("screen_name")
29        sm.current = "screen_name"
30        ```
31        """
32        old_index = self.screen_names.index(self.current)
33        new_index = self.screen_names.index(name)
34        return "left" if old_index < new_index else "right"
35
36    @property
37    def mid_transition(self) -> bool:
38        """If there is a transition in progress."""
39        return 0 < self.current_screen.transition_progress < 1
40
41    @classmethod
42    def from_widgets(cls, widgets: dict[str, XWidget], **kwargs) -> "XScreenManager":
43        """Create an XScreenManager from a dictionary of screen names and widgets."""
44        sm = cls(**kwargs)
45        for n, w in widgets.items():
46            screen = XScreen(name=n)
47            screen.add_widget(w)
48            sm.add_widget(screen)
49        return sm
50
51
52__all__ = (
53    "XScreenManager",
54    "XScreen",
55)