mirror of
https://github.com/markqvist/Sideband.git
synced 2024-12-30 09:56:11 -05:00
83 lines
2.2 KiB
Python
83 lines
2.2 KiB
Python
"""
|
|
Components/Screen
|
|
=================
|
|
|
|
:class:`~kivy.uix.screenmanager.Screen` class equivalent. Simplifies working
|
|
with some widget properties. For example:
|
|
|
|
Screen
|
|
------
|
|
|
|
.. code-block:: kv
|
|
|
|
Screen:
|
|
canvas:
|
|
Color:
|
|
rgba: app.theme_cls.primary_color
|
|
RoundedRectangle:
|
|
pos: self.pos
|
|
size: self.size
|
|
radius: [25, 0, 0, 0]
|
|
|
|
MDScreen
|
|
--------
|
|
|
|
.. code-block:: kv
|
|
|
|
MDScreen:
|
|
radius: [25, 0, 0, 0]
|
|
md_bg_color: app.theme_cls.primary_color
|
|
"""
|
|
|
|
from kivy.properties import ListProperty, ObjectProperty
|
|
from kivy.uix.screenmanager import Screen
|
|
|
|
from kivymd.uix import MDAdaptiveWidget
|
|
from kivymd.uix.behaviors import DeclarativeBehavior
|
|
from kivymd.uix.hero import MDHeroTo
|
|
|
|
|
|
class MDScreen(DeclarativeBehavior, Screen, MDAdaptiveWidget):
|
|
"""
|
|
Screen is an element intended to be used with a
|
|
:class:`~kivymd.uix.screenmanager.MDScreenManager`. For more information,
|
|
see in the :class:`~kivy.uix.screenmanager.Screen` class documentation.
|
|
"""
|
|
|
|
hero_to = ObjectProperty(deprecated=True)
|
|
"""
|
|
Must be a :class:`~kivymd.uix.hero.MDHeroTo` class.
|
|
|
|
See the documentation of the
|
|
`MDHeroTo <https://kivymd.readthedocs.io/en/latest/components/hero/>`_
|
|
widget for more detailed information.
|
|
|
|
.. deprecated:: 1.0.0
|
|
Use attr:`heroes_to` attribute instead.
|
|
|
|
:attr:`hero_to` is an :class:`~kivy.properties.ObjectProperty`
|
|
and defaults to `None`.
|
|
"""
|
|
|
|
heroes_to = ListProperty()
|
|
"""
|
|
Must be a list of :class:`~kivymd.uix.hero.MDHeroTo` class.
|
|
|
|
.. versionadded:: 1.0.0
|
|
|
|
:attr:`heroes_to` is an :class:`~kivy.properties.LiatProperty`
|
|
and defaults to `[]`.
|
|
"""
|
|
|
|
def on_hero_to(self, screen, widget: MDHeroTo) -> None:
|
|
"""Called when the value of the :attr:`hero_to` attribute changes."""
|
|
|
|
if not isinstance(widget, MDHeroTo) or not issubclass(
|
|
widget.__class__, MDHeroTo
|
|
):
|
|
raise TypeError(
|
|
f"The `{widget}` widget must be an `kivymd.uix.hero.MDHeroTo` "
|
|
f"class or inherited from this class"
|
|
)
|
|
self.heroes_to = [widget]
|