Module botroyale.gui.kex.widgets.uix
UI widgets.
Expand source code Browse git
"""UI widgets."""
from typing import Optional, Any, Mapping
from .. import kivy as kv
from ..util import (
XWidget,
ColorType,
XColor,
)
from .layouts import (
XBox,
XAnchor,
)
class XLabel(XWidget, kv.Label):
"""Label."""
def __init__(self, fixed_width: bool = False, **kwargs):
"""Initialize the class.
Args:
fixed_width: Adjust the height of the label while maintaining width.
"""
kwargs = {
"markup": True,
"halign": "center",
"valign": "center",
} | kwargs
super().__init__(**kwargs)
if fixed_width:
self.bind(size=self._fix_height, text=self._fix_height)
else:
self.bind(size=self._on_size)
def _fix_height(self, *a):
self.text_size = self.size[0], None
self.texture_update()
self.set_size(hx=1, y=self.texture_size[1])
def _on_size(self, *a):
self.text_size = self.size
class XLabelClick(kv.ButtonBehavior, XLabel):
"""Label with ButtonBehavior."""
pass
class XCheckBox(XWidget, kv.CheckBox):
"""CheckBox."""
def toggle(self, *a):
"""Toggle the active state."""
self.active = not self.active
class XCheckBoxText(XBox):
"""CheckBox with Label."""
def __init__(self, text: str = ""):
"""Initialize the class.
Args:
text: Label text.
kwargs: Keyword arguments for the Label.
"""
super().__init__()
self.checkbox = XCheckBox()
self.label = XLabelClick(
text=text,
on_release=self.checkbox.toggle,
)
self.checkbox.set_size(y=30)
checkbox_anchor = XAnchor.from_widget(self.checkbox)
checkbox_anchor.set_size(x=30)
self.add(self.label, checkbox_anchor)
class XButton(XWidget, kv.Button):
"""Button."""
def __init__(
self,
background_color: ColorType = XColor.from_name("blue", 0.5).rgba,
**kwargs,
):
"""Initialize the class.
Args:
background_color: Background color of the button.
"""
kwargs = {
"markup": True,
"halign": "center",
"valign": "center",
} | kwargs
super().__init__(**kwargs)
self.background_color = background_color
def on_touch_down(self, m):
"""Overrides base class method to only react to left clicks."""
if m.button != "left":
return False
return super().on_touch_down(m)
class XToggleButton(kv.ToggleButtonBehavior, XButton):
"""ToggleButton."""
active = kv.BooleanProperty(False)
"""Behaves like an alias for the `state` property being "down"."""
def __init__(self, **kwargs):
"""Same arguments as kivy Button."""
super().__init__(**kwargs)
self.bind(state=self._set_active)
self.bind(active=self._set_state)
def toggle(self, *args):
"""Toggles the active state of the button."""
self.active = not self.active
def _set_state(self, *args):
self.state = "down" if self.active else "normal"
def _set_active(self, *args):
self.active = self.state == "down"
class XImageButton(XWidget, kv.ButtonBehavior, kv.Image):
"""Image with ButtonBehavior mixin."""
pass
class XEntry(XWidget, kv.TextInput):
"""TextInput with sane defaults."""
def __init__(
self,
multiline: bool = False,
background_color: XColor = XColor(0.2, 0.2, 0.2, 1),
foreground_color: XColor = XColor(1, 1, 1, 1),
text_validate_unfocus: bool = True,
**kwargs,
):
"""Initialize the class.
Args:
multiline: If should allow multiple lines.
background_color: Color of the background.
foreground_color: Color of the foreground.
text_validate_unfocus: If focus should be removed after validation
(pressing enter on a single-line widget).
kwargs: keyword arguments for TextInput.
"""
super().__init__(
background_color=background_color.rgba,
foreground_color=foreground_color.rgba,
multiline=multiline,
text_validate_unfocus=text_validate_unfocus,
**kwargs,
)
if not multiline:
self.set_size(y=35)
def _on_textinput_focused(self, *args, **kwargs):
"""Overrides base method to select all text when focused."""
value = args[1]
super()._on_textinput_focused(*args, **kwargs)
if value:
self.select_all()
def reset_cursor_selection(self, *a):
"""Resets the cursor position and selection."""
self.cancel_selection()
self.cursor = 0, 0
self.scroll_x = 0
self.scroll_y = 0
class XSlider(XWidget, kv.Slider):
"""Slider."""
pass
class XSliderText(XBox):
"""Slider with Label."""
def __init__(
self,
prefix: str = "",
rounding: int = 3,
box_kwargs: Optional[Mapping[str, Any]] = None,
label_kwargs: Optional[Mapping[str, Any]] = None,
**kwargs,
):
"""Initialize the class.
Args:
prefix: Text to prefix the value presented in the label.
rounding: How many decimal places to show.
box_kwargs: Keyword arguments for XBox.
label_kwargs: Keyword arguments for XLabel.
kwargs: Keyword arguments for XSlider.
"""
box_kwargs = {} if box_kwargs is None else box_kwargs
label_kwargs = {} if label_kwargs is None else label_kwargs
label_kwargs = {"halign": "left"} | label_kwargs
slider_kwargs = {"cursor_size": (25, 25)} | kwargs
super().__init__(**box_kwargs)
self.rounding = rounding
self.prefix = prefix
self.label = XLabel(**label_kwargs)
self.label.set_size(hx=0.2)
self.slider = XSlider(**slider_kwargs)
self.add(self.label)
self.add(self.slider)
self.slider.bind(value=self._set_text)
self._set_text(self, self.slider.value)
def _set_text(self, w, value):
if isinstance(value, float):
value = round(value, self.rounding)
if value == round(value):
value = int(value)
self.label.text = str(f"{self.prefix}{value}")
class XSpinner(XWidget, kv.Spinner):
"""Spinner."""
value = kv.StringProperty("")
def __init__(self, update_main_text: bool = True, **kwargs):
"""Same keyword arguments for Spinner.
Args:
update_main_text: Update the button text based on the selected value.
"""
super().__init__(**kwargs)
self.update_main_text = update_main_text
if update_main_text:
self.text_autoupdate = True
def on_select(self, data):
"""Overrides base method."""
pass
def _on_dropdown_select(self, instance, data, *largs):
if self.update_main_text:
self.text = data
self.value = data
self.is_open = False
self.on_select(data)
class XDropDown(XWidget, kv.DropDown):
"""DropDown."""
pass
class XPickColor(XBox):
"""Color picking widget."""
color = kv.ObjectProperty(XColor(0.5, 0.5, 0.5, 1))
def __init__(self, **kwargs):
"""Same keyword arguments for Slider."""
super().__init__(orientation="vertical")
self.set_size(x=300, y=100)
update_color = self._update_from_sliders
self.sliders = []
for i, c in enumerate("RGBA"):
slider_kwargs = {
"range": (0, 1),
"step": 0.01,
"value_track": True,
"value_track_color": XColor(**{c.lower(): 0.75}).rgba,
"value_track_width": "6dp",
"cursor_size": (0, 0),
} | kwargs
s = self.add(XSliderText(**slider_kwargs))
s.slider.bind(value=update_color)
self.sliders.append(s)
self.r, self.g, self.b, self.a = self.sliders
self.set_color(self.color)
def set_color(self, color: XColor):
"""Set the current color."""
self.r.slider.value = color.r
self.g.slider.value = color.g
self.b.slider.value = color.b
self.a.slider.value = color.a
def _update_from_sliders(self, *a):
color = XColor(
self.r.slider.value,
self.g.slider.value,
self.b.slider.value,
self.a.slider.value,
)
is_bright = sum(color.rgb) > 1.5
for s in self.sliders:
s.label.color = (0, 0, 0, 1) if is_bright else (1, 1, 1, 1)
self.make_bg(color)
self.color = color
class XSelectColor(XLabelClick):
"""An XPickColor that drops down from an XLabelClick."""
def __init__(
self,
prefix: str = "[u]Color:[/u]\n",
show_color_values: bool = True,
**kwargs,
):
"""Initialize the class.
Args:
prefix: Text to show before the RGB values.
show_color_values: Show the RGB values of the current color.
kwargs: Keyword arguments for the XLabelClick.
"""
self.prefix = prefix
self.show_color_values = show_color_values
super().__init__(**kwargs)
self.picker = XPickColor()
self.dropdown = XDropDown(auto_width=False, on_dismiss=self._on_color)
self.dropdown.set_size(*self.picker.size)
self.dropdown.add(self.picker)
self.picker.bind(size=lambda w, s: self.dropdown.set_size(*s))
self.bind(on_release=self.dropdown.open)
self.on_color()
def _on_color(self, *args):
color = self.picker.color
self.make_bg(color)
text = self.prefix
if self.show_color_values:
text += " , ".join(str(round(c, 2)) for c in color.rgba)
self.text = text
class XScreen(XWidget, kv.Screen):
"""Screen that can only contain one widget."""
def __init__(self, **kwargs):
"""Same arguments as Screen."""
super().__init__(**kwargs)
self.view = None
def add(self, *args, **kwargs) -> XWidget:
"""Overrides base method to set the view."""
self.view = super().add(*args, **kwargs)
if len(self.children) > 1:
raise RuntimeError(
f"Cannot add more than 1 widget to XScreen: {self.children=}"
)
class XScreenManager(XWidget, kv.ScreenManager):
"""ScreenManager with custom transition behavior."""
transition_speed = kv.NumericProperty(0.4)
def __init__(self, **kwargs):
"""Same arguments as for ScreenManager, minus transition."""
if "transition" in kwargs:
del kwargs["transition"]
super().__init__(**kwargs)
self.transition = kv.SlideTransition(
direction="left",
duration=self.transition_speed,
)
def add_screen(self, name: str, widget: XWidget) -> XScreen:
"""Add a screen."""
screen = self.add(XScreen(name=name))
screen.add(widget)
return screen
def switch_name(self, name: str) -> bool:
"""Switch to a screen by name."""
if name == self.current:
return True
if self.mid_transition:
return False
if name not in self.screen_names:
raise ValueError(f'Found no screen by name "{name}" in {self.screen_names}')
old_index = self.screen_names.index(self.current)
new_index = self.screen_names.index(name)
dir = "left" if old_index < new_index else "right"
self.transition = kv.SlideTransition(
direction=dir,
duration=self.transition_speed,
)
self.current = name
return True
@property
def mid_transition(self) -> bool:
"""If there is a transition in progress."""
return 0 < self.current_screen.transition_progress < 1
@classmethod
def from_widgets(cls, widgets: Mapping[str, XWidget], **kwargs) -> "XScreenManager":
"""Create an XScreenManager from a dictionary of screen names and widgets."""
sm = cls(**kwargs)
for n, w in widgets.items():
screen = XScreen(name=n)
screen.add(w)
sm.add(screen)
return smClasses
class XButton (background_color: tuple[float, float, float, float] = (0.05, 0.2, 0.45, 1), **kwargs)-
Button.
Initialize the class.
- Args
- -----=
background_color- Background color of the button.
Expand source code Browse git
class XButton(XWidget, kv.Button): """Button.""" def __init__( self, background_color: ColorType = XColor.from_name("blue", 0.5).rgba, **kwargs, ): """Initialize the class. Args: background_color: Background color of the button. """ kwargs = { "markup": True, "halign": "center", "valign": "center", } | kwargs super().__init__(**kwargs) self.background_color = background_color def on_touch_down(self, m): """Overrides base class method to only react to left clicks.""" if m.button != "left": return False return super().on_touch_down(m)Ancestors
- XWidget
- kivy.uix.button.Button
- kivy.uix.behaviors.button.ButtonBehavior
- kivy.uix.label.Label
- kivy.uix.widget.Widget
- kivy.uix.widget.WidgetBase
- kivy._event.EventDispatcher
- kivy._event.ObjectWithUid
Subclasses
Methods
def on_touch_down(self, m)-
Overrides base class method to only react to left clicks.
Expand source code Browse git
def on_touch_down(self, m): """Overrides base class method to only react to left clicks.""" if m.button != "left": return False return super().on_touch_down(m)
Inherited members
class XCheckBox (**kwargs)-
CheckBox.
Expand source code Browse git
class XCheckBox(XWidget, kv.CheckBox): """CheckBox.""" def toggle(self, *a): """Toggle the active state.""" self.active = not self.activeAncestors
- XWidget
- kivy.uix.checkbox.CheckBox
- kivy.uix.behaviors.togglebutton.ToggleButtonBehavior
- kivy.uix.behaviors.button.ButtonBehavior
- kivy.uix.widget.Widget
- kivy.uix.widget.WidgetBase
- kivy._event.EventDispatcher
- kivy._event.ObjectWithUid
Methods
def toggle(self, *a)-
Toggle the active state.
Expand source code Browse git
def toggle(self, *a): """Toggle the active state.""" self.active = not self.active
Inherited members
class XCheckBoxText (text: str = '')-
CheckBox with Label.
Initialize the class.
- Args
- -----=
text- Label text.
kwargs- Keyword arguments for the Label.
Expand source code Browse git
class XCheckBoxText(XBox): """CheckBox with Label.""" def __init__(self, text: str = ""): """Initialize the class. Args: text: Label text. kwargs: Keyword arguments for the Label. """ super().__init__() self.checkbox = XCheckBox() self.label = XLabelClick( text=text, on_release=self.checkbox.toggle, ) self.checkbox.set_size(y=30) checkbox_anchor = XAnchor.from_widget(self.checkbox) checkbox_anchor.set_size(x=30) self.add(self.label, checkbox_anchor)Ancestors
- XBox
- XWidget
- kivy.uix.boxlayout.BoxLayout
- kivy.uix.layout.Layout
- kivy.uix.widget.Widget
- kivy.uix.widget.WidgetBase
- kivy._event.EventDispatcher
- kivy._event.ObjectWithUid
Inherited members
class XDropDown (**kwargs)-
DropDown.
Expand source code Browse git
class XDropDown(XWidget, kv.DropDown): """DropDown.""" passAncestors
- XWidget
- kivy.uix.dropdown.DropDown
- kivy.uix.scrollview.ScrollView
- kivy.uix.stencilview.StencilView
- kivy.uix.widget.Widget
- kivy.uix.widget.WidgetBase
- kivy._event.EventDispatcher
- kivy._event.ObjectWithUid
Inherited members
class XEntry (multiline: bool = False, background_color: XColor = <botroyale.gui.kex.util.XColor object>, foreground_color: XColor = <botroyale.gui.kex.util.XColor object>, text_validate_unfocus: bool = True, **kwargs)-
TextInput with sane defaults.
Initialize the class.
- Args
- -----=
multiline- If should allow multiple lines.
background_color- Color of the background.
foreground_color- Color of the foreground.
text_validate_unfocus- If focus should be removed after validation (pressing enter on a single-line widget).
kwargs- keyword arguments for TextInput.
Expand source code Browse git
class XEntry(XWidget, kv.TextInput): """TextInput with sane defaults.""" def __init__( self, multiline: bool = False, background_color: XColor = XColor(0.2, 0.2, 0.2, 1), foreground_color: XColor = XColor(1, 1, 1, 1), text_validate_unfocus: bool = True, **kwargs, ): """Initialize the class. Args: multiline: If should allow multiple lines. background_color: Color of the background. foreground_color: Color of the foreground. text_validate_unfocus: If focus should be removed after validation (pressing enter on a single-line widget). kwargs: keyword arguments for TextInput. """ super().__init__( background_color=background_color.rgba, foreground_color=foreground_color.rgba, multiline=multiline, text_validate_unfocus=text_validate_unfocus, **kwargs, ) if not multiline: self.set_size(y=35) def _on_textinput_focused(self, *args, **kwargs): """Overrides base method to select all text when focused.""" value = args[1] super()._on_textinput_focused(*args, **kwargs) if value: self.select_all() def reset_cursor_selection(self, *a): """Resets the cursor position and selection.""" self.cancel_selection() self.cursor = 0, 0 self.scroll_x = 0 self.scroll_y = 0Ancestors
- XWidget
- kivy.uix.textinput.TextInput
- kivy.uix.behaviors.focus.FocusBehavior
- kivy.uix.widget.Widget
- kivy.uix.widget.WidgetBase
- kivy._event.EventDispatcher
- kivy._event.ObjectWithUid
Methods
def reset_cursor_selection(self, *a)-
Resets the cursor position and selection.
Expand source code Browse git
def reset_cursor_selection(self, *a): """Resets the cursor position and selection.""" self.cancel_selection() self.cursor = 0, 0 self.scroll_x = 0 self.scroll_y = 0
Inherited members
class XImageButton (**kwargs)-
Image with ButtonBehavior mixin.
Expand source code Browse git
class XImageButton(XWidget, kv.ButtonBehavior, kv.Image): """Image with ButtonBehavior mixin.""" passAncestors
- XWidget
- kivy.uix.behaviors.button.ButtonBehavior
- kivy.uix.image.Image
- kivy.uix.widget.Widget
- kivy.uix.widget.WidgetBase
- kivy._event.EventDispatcher
- kivy._event.ObjectWithUid
Inherited members
class XLabel (fixed_width: bool = False, **kwargs)-
Label.
Initialize the class.
- Args
- -----=
fixed_width- Adjust the height of the label while maintaining width.
Expand source code Browse git
class XLabel(XWidget, kv.Label): """Label.""" def __init__(self, fixed_width: bool = False, **kwargs): """Initialize the class. Args: fixed_width: Adjust the height of the label while maintaining width. """ kwargs = { "markup": True, "halign": "center", "valign": "center", } | kwargs super().__init__(**kwargs) if fixed_width: self.bind(size=self._fix_height, text=self._fix_height) else: self.bind(size=self._on_size) def _fix_height(self, *a): self.text_size = self.size[0], None self.texture_update() self.set_size(hx=1, y=self.texture_size[1]) def _on_size(self, *a): self.text_size = self.sizeAncestors
- XWidget
- kivy.uix.label.Label
- kivy.uix.widget.Widget
- kivy.uix.widget.WidgetBase
- kivy._event.EventDispatcher
- kivy._event.ObjectWithUid
Subclasses
Inherited members
class XLabelClick (**kwargs)-
Label with ButtonBehavior.
Expand source code Browse git
class XLabelClick(kv.ButtonBehavior, XLabel): """Label with ButtonBehavior.""" passAncestors
- kivy.uix.behaviors.button.ButtonBehavior
- XLabel
- XWidget
- kivy.uix.label.Label
- kivy.uix.widget.Widget
- kivy.uix.widget.WidgetBase
- kivy._event.EventDispatcher
- kivy._event.ObjectWithUid
Subclasses
Inherited members
class XPickColor (**kwargs)-
Color picking widget.
Same keyword arguments for Slider.
Expand source code Browse git
class XPickColor(XBox): """Color picking widget.""" color = kv.ObjectProperty(XColor(0.5, 0.5, 0.5, 1)) def __init__(self, **kwargs): """Same keyword arguments for Slider.""" super().__init__(orientation="vertical") self.set_size(x=300, y=100) update_color = self._update_from_sliders self.sliders = [] for i, c in enumerate("RGBA"): slider_kwargs = { "range": (0, 1), "step": 0.01, "value_track": True, "value_track_color": XColor(**{c.lower(): 0.75}).rgba, "value_track_width": "6dp", "cursor_size": (0, 0), } | kwargs s = self.add(XSliderText(**slider_kwargs)) s.slider.bind(value=update_color) self.sliders.append(s) self.r, self.g, self.b, self.a = self.sliders self.set_color(self.color) def set_color(self, color: XColor): """Set the current color.""" self.r.slider.value = color.r self.g.slider.value = color.g self.b.slider.value = color.b self.a.slider.value = color.a def _update_from_sliders(self, *a): color = XColor( self.r.slider.value, self.g.slider.value, self.b.slider.value, self.a.slider.value, ) is_bright = sum(color.rgb) > 1.5 for s in self.sliders: s.label.color = (0, 0, 0, 1) if is_bright else (1, 1, 1, 1) self.make_bg(color) self.color = colorAncestors
- XBox
- XWidget
- kivy.uix.boxlayout.BoxLayout
- kivy.uix.layout.Layout
- kivy.uix.widget.Widget
- kivy.uix.widget.WidgetBase
- kivy._event.EventDispatcher
- kivy._event.ObjectWithUid
Instance variables
var color-
ObjectProperty(defaultvalue=None, rebind=False, **kw) Property that represents a Python object.
:Parameters: <code>defaultvalue</code>: object type Specifies the default value of the property. <code>rebind</code>: bool, defaults to False Whether kv rules using this object as an intermediate attribute in a kv rule, will update the bound property when this object changes. That is the standard behavior is that if there's a kv rule ``text: self.a.b.c.d``, where <code>a</code>, <code>b</code>, and <code>c</code> are properties with <code>rebind</code> <code>False</code> and <code>d</code> is a :class:<code>StringProperty</code>. Then when the rule is applied, <code>text</code> becomes bound only to <code>d</code>. If <code>a</code>, <code>b</code>, or <code>c</code> change, <code>text</code> still remains bound to <code>d</code>. Furthermore, if any of them were <code>None</code> when the rule was initially evaluated, e.g. <code>b</code> was <code>None</code>; then <code>text</code> is bound to <code>b</code> and will not become bound to <code>d</code> even when <code>b</code> is changed to not be <code>None</code>. By setting <code>rebind</code> to <code>True</code>, however, the rule will be re-evaluated and all the properties rebound when that intermediate property changes. E.g. in the example above, whenever <code>b</code> changes or becomes not <code>None</code> if it was <code>None</code> before, <code>text</code> is evaluated again and becomes rebound to <code>d</code>. The overall result is that <code>text</code> is now bound to all the properties among <code>a</code>, <code>b</code>, or <code>c</code> that have <code>rebind</code> set to <code>True</code>. `\*\*kwargs`: a list of keyword arguments <code>baseclass</code> If kwargs includes a <code>baseclass</code> argument, this value will be used for validation: `isinstance(value, kwargs['baseclass'])`. !!! warning "Warning" To mark the property as changed, you must reassign a new python object. !!! versionchanged "Changed in version: 1.9.0" <code>rebind</code> has been introduced. !!! versionchanged "Changed in version: 1.7.0" <code>baseclass</code> parameter added.
Methods
def set_color(self, color: XColor)-
Set the current color.
Expand source code Browse git
def set_color(self, color: XColor): """Set the current color.""" self.r.slider.value = color.r self.g.slider.value = color.g self.b.slider.value = color.b self.a.slider.value = color.a
Inherited members
class XScreen (**kwargs)-
Screen that can only contain one widget.
Same arguments as Screen.
Expand source code Browse git
class XScreen(XWidget, kv.Screen): """Screen that can only contain one widget.""" def __init__(self, **kwargs): """Same arguments as Screen.""" super().__init__(**kwargs) self.view = None def add(self, *args, **kwargs) -> XWidget: """Overrides base method to set the view.""" self.view = super().add(*args, **kwargs) if len(self.children) > 1: raise RuntimeError( f"Cannot add more than 1 widget to XScreen: {self.children=}" )Ancestors
- XWidget
- kivy.uix.screenmanager.Screen
- kivy.uix.relativelayout.RelativeLayout
- kivy.uix.floatlayout.FloatLayout
- kivy.uix.layout.Layout
- kivy.uix.widget.Widget
- kivy.uix.widget.WidgetBase
- kivy._event.EventDispatcher
- kivy._event.ObjectWithUid
Methods
def add(self, *args, **kwargs) ‑> XWidget-
Overrides base method to set the view.
Expand source code Browse git
def add(self, *args, **kwargs) -> XWidget: """Overrides base method to set the view.""" self.view = super().add(*args, **kwargs) if len(self.children) > 1: raise RuntimeError( f"Cannot add more than 1 widget to XScreen: {self.children=}" )
Inherited members
class XScreenManager (**kwargs)-
ScreenManager with custom transition behavior.
Same arguments as for ScreenManager, minus transition.
Expand source code Browse git
class XScreenManager(XWidget, kv.ScreenManager): """ScreenManager with custom transition behavior.""" transition_speed = kv.NumericProperty(0.4) def __init__(self, **kwargs): """Same arguments as for ScreenManager, minus transition.""" if "transition" in kwargs: del kwargs["transition"] super().__init__(**kwargs) self.transition = kv.SlideTransition( direction="left", duration=self.transition_speed, ) def add_screen(self, name: str, widget: XWidget) -> XScreen: """Add a screen.""" screen = self.add(XScreen(name=name)) screen.add(widget) return screen def switch_name(self, name: str) -> bool: """Switch to a screen by name.""" if name == self.current: return True if self.mid_transition: return False if name not in self.screen_names: raise ValueError(f'Found no screen by name "{name}" in {self.screen_names}') old_index = self.screen_names.index(self.current) new_index = self.screen_names.index(name) dir = "left" if old_index < new_index else "right" self.transition = kv.SlideTransition( direction=dir, duration=self.transition_speed, ) self.current = name return True @property def mid_transition(self) -> bool: """If there is a transition in progress.""" return 0 < self.current_screen.transition_progress < 1 @classmethod def from_widgets(cls, widgets: Mapping[str, XWidget], **kwargs) -> "XScreenManager": """Create an XScreenManager from a dictionary of screen names and widgets.""" sm = cls(**kwargs) for n, w in widgets.items(): screen = XScreen(name=n) screen.add(w) sm.add(screen) return smAncestors
- XWidget
- kivy.uix.screenmanager.ScreenManager
- kivy.uix.floatlayout.FloatLayout
- kivy.uix.layout.Layout
- kivy.uix.widget.Widget
- kivy.uix.widget.WidgetBase
- kivy._event.EventDispatcher
- kivy._event.ObjectWithUid
Static methods
def from_widgets(widgets: Mapping[str, XWidget], **kwargs) ‑> XScreenManager-
Create an XScreenManager from a dictionary of screen names and widgets.
Expand source code Browse git
@classmethod def from_widgets(cls, widgets: Mapping[str, XWidget], **kwargs) -> "XScreenManager": """Create an XScreenManager from a dictionary of screen names and widgets.""" sm = cls(**kwargs) for n, w in widgets.items(): screen = XScreen(name=n) screen.add(w) sm.add(screen) return sm
Instance variables
var mid_transition : bool-
If there is a transition in progress.
Expand source code Browse git
@property def mid_transition(self) -> bool: """If there is a transition in progress.""" return 0 < self.current_screen.transition_progress < 1 var transition_speed-
NumericProperty(defaultvalue=0, **kw) Property that represents a numeric value.
It only accepts the int or float numeric data type or a string that can be converted to a number as shown below. For other numeric types use ObjectProperty or use errorhandler to convert it to an int/float. It does not support numpy numbers so they must be manually converted to int/float. E.g. ``widget.num = np.arange(4)[0]`` will raise an exception. Numpy arrays are not supported at all, even by ObjectProperty because their comparison does not return a bool. But if you must use a Kivy property, use a ObjectProperty with <code>comparator</code> set to <code>np.array\_equal</code>. E.g.:: >>> class A(EventDispatcher): ... data = ObjectProperty(comparator=np.array_equal) >>> a = A() >>> a.bind(data=print) >>> a.data = np.arange(2) <__main__.A object at 0x000001C839B50208> [0 1] >>> a.data = np.arange(3) <__main__.A object at 0x000001C839B50208> [0 1 2] :Parameters: <code>defaultvalue</code>: int or float, defaults to 0 Specifies the default value of the property. >>> wid = Widget() >>> wid.x = 42 >>> print(wid.x) 42 >>> wid.x = "plop" Traceback (most recent call last): File "<stdin>", line 1, in <module> File "properties.pyx", line 93, in kivy.properties.Property.__set__ File "properties.pyx", line 111, in kivy.properties.Property.set File "properties.pyx", line 159, in kivy.properties.NumericProperty.check ValueError: NumericProperty accept only int/float !!! versionchanged "Changed in version: 1.4.1" NumericProperty can now accept custom text and tuple value to indicate a type, like "in", "pt", "px", "cm", "mm", in the format: '10pt' or (10, 'pt').
Methods
def add_screen(self, name: str, widget: XWidget) ‑> XScreen-
Add a screen.
Expand source code Browse git
def add_screen(self, name: str, widget: XWidget) -> XScreen: """Add a screen.""" screen = self.add(XScreen(name=name)) screen.add(widget) return screen def switch_name(self, name: str) ‑> bool-
Switch to a screen by name.
Expand source code Browse git
def switch_name(self, name: str) -> bool: """Switch to a screen by name.""" if name == self.current: return True if self.mid_transition: return False if name not in self.screen_names: raise ValueError(f'Found no screen by name "{name}" in {self.screen_names}') old_index = self.screen_names.index(self.current) new_index = self.screen_names.index(name) dir = "left" if old_index < new_index else "right" self.transition = kv.SlideTransition( direction=dir, duration=self.transition_speed, ) self.current = name return True
Inherited members
class XSelectColor (prefix: str = '[u]Color:[/u]\n', show_color_values: bool = True, **kwargs)-
An XPickColor that drops down from an XLabelClick.
Initialize the class.
- Args
- -----=
prefix- Text to show before the RGB values.
show_color_values- Show the RGB values of the current color.
kwargs- Keyword arguments for the XLabelClick.
Expand source code Browse git
class XSelectColor(XLabelClick): """An XPickColor that drops down from an XLabelClick.""" def __init__( self, prefix: str = "[u]Color:[/u]\n", show_color_values: bool = True, **kwargs, ): """Initialize the class. Args: prefix: Text to show before the RGB values. show_color_values: Show the RGB values of the current color. kwargs: Keyword arguments for the XLabelClick. """ self.prefix = prefix self.show_color_values = show_color_values super().__init__(**kwargs) self.picker = XPickColor() self.dropdown = XDropDown(auto_width=False, on_dismiss=self._on_color) self.dropdown.set_size(*self.picker.size) self.dropdown.add(self.picker) self.picker.bind(size=lambda w, s: self.dropdown.set_size(*s)) self.bind(on_release=self.dropdown.open) self.on_color() def _on_color(self, *args): color = self.picker.color self.make_bg(color) text = self.prefix if self.show_color_values: text += " , ".join(str(round(c, 2)) for c in color.rgba) self.text = textAncestors
- XLabelClick
- kivy.uix.behaviors.button.ButtonBehavior
- XLabel
- XWidget
- kivy.uix.label.Label
- kivy.uix.widget.Widget
- kivy.uix.widget.WidgetBase
- kivy._event.EventDispatcher
- kivy._event.ObjectWithUid
Inherited members
class XSlider (**kwargs)-
Slider.
Expand source code Browse git
class XSlider(XWidget, kv.Slider): """Slider.""" passAncestors
- XWidget
- kivy.uix.slider.Slider
- kivy.uix.widget.Widget
- kivy.uix.widget.WidgetBase
- kivy._event.EventDispatcher
- kivy._event.ObjectWithUid
Inherited members
class XSliderText (prefix: str = '', rounding: int = 3, box_kwargs: Optional[Mapping[str, Any]] = None, label_kwargs: Optional[Mapping[str, Any]] = None, **kwargs)-
Slider with Label.
Initialize the class.
- Args
- -----=
prefix- Text to prefix the value presented in the label.
rounding- How many decimal places to show.
box_kwargs- Keyword arguments for XBox.
label_kwargs- Keyword arguments for XLabel.
kwargs- Keyword arguments for XSlider.
Expand source code Browse git
class XSliderText(XBox): """Slider with Label.""" def __init__( self, prefix: str = "", rounding: int = 3, box_kwargs: Optional[Mapping[str, Any]] = None, label_kwargs: Optional[Mapping[str, Any]] = None, **kwargs, ): """Initialize the class. Args: prefix: Text to prefix the value presented in the label. rounding: How many decimal places to show. box_kwargs: Keyword arguments for XBox. label_kwargs: Keyword arguments for XLabel. kwargs: Keyword arguments for XSlider. """ box_kwargs = {} if box_kwargs is None else box_kwargs label_kwargs = {} if label_kwargs is None else label_kwargs label_kwargs = {"halign": "left"} | label_kwargs slider_kwargs = {"cursor_size": (25, 25)} | kwargs super().__init__(**box_kwargs) self.rounding = rounding self.prefix = prefix self.label = XLabel(**label_kwargs) self.label.set_size(hx=0.2) self.slider = XSlider(**slider_kwargs) self.add(self.label) self.add(self.slider) self.slider.bind(value=self._set_text) self._set_text(self, self.slider.value) def _set_text(self, w, value): if isinstance(value, float): value = round(value, self.rounding) if value == round(value): value = int(value) self.label.text = str(f"{self.prefix}{value}")Ancestors
- XBox
- XWidget
- kivy.uix.boxlayout.BoxLayout
- kivy.uix.layout.Layout
- kivy.uix.widget.Widget
- kivy.uix.widget.WidgetBase
- kivy._event.EventDispatcher
- kivy._event.ObjectWithUid
Inherited members
class XSpinner (update_main_text: bool = True, **kwargs)-
Spinner.
Same keyword arguments for Spinner.
- Args
- -----=
update_main_text- Update the button text based on the selected value.
Expand source code Browse git
class XSpinner(XWidget, kv.Spinner): """Spinner.""" value = kv.StringProperty("") def __init__(self, update_main_text: bool = True, **kwargs): """Same keyword arguments for Spinner. Args: update_main_text: Update the button text based on the selected value. """ super().__init__(**kwargs) self.update_main_text = update_main_text if update_main_text: self.text_autoupdate = True def on_select(self, data): """Overrides base method.""" pass def _on_dropdown_select(self, instance, data, *largs): if self.update_main_text: self.text = data self.value = data self.is_open = False self.on_select(data)Ancestors
- XWidget
- kivy.uix.spinner.Spinner
- kivy.uix.button.Button
- kivy.uix.behaviors.button.ButtonBehavior
- kivy.uix.label.Label
- kivy.uix.widget.Widget
- kivy.uix.widget.WidgetBase
- kivy._event.EventDispatcher
- kivy._event.ObjectWithUid
Instance variables
var value-
StringProperty(defaultvalue=u'', **kw) Property that represents a string value.
:Parameters: <code>defaultvalue</code>: string, defaults to '' Specifies the default value of the property.
Methods
def on_select(self, data)-
Overrides base method.
Expand source code Browse git
def on_select(self, data): """Overrides base method.""" pass
Inherited members
class XToggleButton (**kwargs)-
ToggleButton.
Same arguments as kivy Button.
Expand source code Browse git
class XToggleButton(kv.ToggleButtonBehavior, XButton): """ToggleButton.""" active = kv.BooleanProperty(False) """Behaves like an alias for the `state` property being "down".""" def __init__(self, **kwargs): """Same arguments as kivy Button.""" super().__init__(**kwargs) self.bind(state=self._set_active) self.bind(active=self._set_state) def toggle(self, *args): """Toggles the active state of the button.""" self.active = not self.active def _set_state(self, *args): self.state = "down" if self.active else "normal" def _set_active(self, *args): self.active = self.state == "down"Ancestors
- kivy.uix.behaviors.togglebutton.ToggleButtonBehavior
- XButton
- XWidget
- kivy.uix.button.Button
- kivy.uix.behaviors.button.ButtonBehavior
- kivy.uix.label.Label
- kivy.uix.widget.Widget
- kivy.uix.widget.WidgetBase
- kivy._event.EventDispatcher
- kivy._event.ObjectWithUid
Instance variables
var active-
Behaves like an alias for the
stateproperty being "down".
Methods
def toggle(self, *args)-
Toggles the active state of the button.
Expand source code Browse git
def toggle(self, *args): """Toggles the active state of the button.""" self.active = not self.active
Inherited members