Module botroyale.gui.menubar

Top menu bar widget.

Is used by screens of the app, works well with Control.

Expand source code Browse git 
"""Top menu bar widget.

Is used by screens of the app, works well with `botroyale.api.gui.Control`.
"""
from collections import defaultdict
from botroyale.gui import (
    kex as kx,
    _defaults as defaults,
)
from botroyale.api.gui import Control
from botroyale.util import settings


DEBUG_COLORS = settings.get("gui.debug_colors")


def _get_spinner_btn(**kwargs):
    btn = kx.Button(**defaults.BUTTON_AUX, **kwargs)
    btn.set_size(y=defaults.LINE_HEIGHT)
    return btn


class MenuBar(kx.Box):
    """See module documentation for details."""

    def __init__(self, controls: list[Control], **kwargs):
        """Initialized with a list of Controls."""
        super().__init__(**kwargs)
        self.set_size(y=40)
        self.make_bg(kx.get_color("black"))
        self.controls = {}
        self.set_controls(controls)

    def set_controls(self, controls: list[Control]):
        """Reset the menu bar with a list of Controls."""
        self.controls = _categorize_controls(controls)
        self.clear_widgets()
        self.add(*self._get_spinner_widgets(controls))
        if DEBUG_COLORS:
            self.add(self._get_palette_box())

    def _get_spinner_widgets(self, controls: list[Control]):
        spinners = []
        for category, controls in self.controls.items():
            control_labels = []
            for c in controls:
                label = c.label
                if c.hotkeys:
                    hotkey_label = kx.InputManager.humanize(c.hotkeys[0])
                    label = f"{label} ([i]{hotkey_label}[/i])"
                control_labels.append(label)
            spinner = kx.Spinner(
                text=category,
                values=control_labels,
                **defaults.BUTTON,
                update_main_text=False,
                option_cls=_get_spinner_btn,
            )
            spinner.on_select = lambda l, s=spinner: self._invoke_control(s, l)
            spinners.append(spinner)
        return spinners

    def _get_palette_box(self):
        palette_box = kx.Box()
        total_width = 0
        for name, color in defaults.COLORS.items():
            w = kx.Label(text=name.capitalize(), color=color.fg.rgba)
            w.set_size(x=60)
            total_width += 60
            w.make_bg(color.bg)
            palette_box.add(w)
        for i in range(5):
            fg = kx.Label(text=str(i), color=kx.get_color("black").rgba)
            fg.make_bg(defaults.PALETTE[i])
            bg = kx.Label(text=str(5 + i), color=kx.get_color("white").rgba)
            bg.make_bg(defaults.PALETTE_BG[i])
            w = kx.Box(orientation="vertical")
            w.add(fg, bg)
            w.set_size(x=50)
            total_width += 50
            palette_box.add(w)
        palette_box.set_size(x=total_width)
        return palette_box

    def _invoke_control(self, spinner, label):
        category = spinner.text
        cidx = spinner.values.index(label)
        control = self.controls[category][cidx]
        control.callback()


def _categorize_controls(controls):
    """Organize a list of controls into a dictionary of categories of controls."""
    d = defaultdict(list)
    for c in controls:
        d[c.category].append(c)
    return d

Classes

class MenuBar (controls: list[Control], **kwargs)

See module documentation for details.

Initialized with a list of Controls.

Expand source code Browse git 
class MenuBar(kx.Box):
    """See module documentation for details."""

    def __init__(self, controls: list[Control], **kwargs):
        """Initialized with a list of Controls."""
        super().__init__(**kwargs)
        self.set_size(y=40)
        self.make_bg(kx.get_color("black"))
        self.controls = {}
        self.set_controls(controls)

    def set_controls(self, controls: list[Control]):
        """Reset the menu bar with a list of Controls."""
        self.controls = _categorize_controls(controls)
        self.clear_widgets()
        self.add(*self._get_spinner_widgets(controls))
        if DEBUG_COLORS:
            self.add(self._get_palette_box())

    def _get_spinner_widgets(self, controls: list[Control]):
        spinners = []
        for category, controls in self.controls.items():
            control_labels = []
            for c in controls:
                label = c.label
                if c.hotkeys:
                    hotkey_label = kx.InputManager.humanize(c.hotkeys[0])
                    label = f"{label} ([i]{hotkey_label}[/i])"
                control_labels.append(label)
            spinner = kx.Spinner(
                text=category,
                values=control_labels,
                **defaults.BUTTON,
                update_main_text=False,
                option_cls=_get_spinner_btn,
            )
            spinner.on_select = lambda l, s=spinner: self._invoke_control(s, l)
            spinners.append(spinner)
        return spinners

    def _get_palette_box(self):
        palette_box = kx.Box()
        total_width = 0
        for name, color in defaults.COLORS.items():
            w = kx.Label(text=name.capitalize(), color=color.fg.rgba)
            w.set_size(x=60)
            total_width += 60
            w.make_bg(color.bg)
            palette_box.add(w)
        for i in range(5):
            fg = kx.Label(text=str(i), color=kx.get_color("black").rgba)
            fg.make_bg(defaults.PALETTE[i])
            bg = kx.Label(text=str(5 + i), color=kx.get_color("white").rgba)
            bg.make_bg(defaults.PALETTE_BG[i])
            w = kx.Box(orientation="vertical")
            w.add(fg, bg)
            w.set_size(x=50)
            total_width += 50
            palette_box.add(w)
        palette_box.set_size(x=total_width)
        return palette_box

    def _invoke_control(self, spinner, label):
        category = spinner.text
        cidx = spinner.values.index(label)
        control = self.controls[category][cidx]
        control.callback()

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

Methods

def set_controls(self, controls: list[Control])

Reset the menu bar with a list of Controls.

Expand source code Browse git 
def set_controls(self, controls: list[Control]):
    """Reset the menu bar with a list of Controls."""
    self.controls = _categorize_controls(controls)
    self.clear_widgets()
    self.add(*self._get_spinner_widgets(controls))
    if DEBUG_COLORS:
        self.add(self._get_palette_box())

Inherited members