mirror of
https://github.com/1j01/textual-paint.git
synced 2024-12-22 06:11:37 +03:00
243 lines
10 KiB
Python
243 lines
10 KiB
Python
import re
|
|
from typing import Any, Callable
|
|
from textual import events
|
|
from textual.containers import Container
|
|
from textual.reactive import var
|
|
from textual.widgets import Button, Static
|
|
from textual.message import Message
|
|
from rich.text import Text
|
|
from localization.i18n import markup_hotkey, get_hotkey, get_direction
|
|
|
|
def to_snake_case(name: str) -> str:
|
|
name = re.sub('(.)([A-Z][a-z]+)', r'\1_\2', name)
|
|
name = re.sub('__([A-Z])', r'_\1', name)
|
|
name = re.sub('([a-z0-9])([A-Z])', r'\1_\2', name)
|
|
return name.lower()
|
|
|
|
class Menu(Container):
|
|
"""A menu widget. Note that menus can't be reused in multiple places."""
|
|
|
|
class StatusInfo(Message):
|
|
"""Sent when hovering over a menu item, or to reset when leaving a menu item or when menu is closed."""
|
|
def __init__(self, description: str|None, closed: bool = False) -> None:
|
|
super().__init__()
|
|
self.description = description
|
|
self.closed = closed
|
|
|
|
items = var([])
|
|
focus_index = var(0)
|
|
|
|
def __init__(self, items: list['MenuItem|Separator'], **kwargs: Any) -> None:
|
|
"""Initialize a menu."""
|
|
super().__init__(**kwargs)
|
|
self.items = items
|
|
# These are set when opening a submenu
|
|
self.parent_menu: Menu | None = None
|
|
self.parent_menu_item: MenuItem | None = None
|
|
|
|
def watch_items(self, old_items: list['MenuItem|Separator'], new_items: list['MenuItem|Separator']) -> None:
|
|
"""Update the menu items."""
|
|
for item in old_items:
|
|
item.remove()
|
|
for item in new_items:
|
|
self.mount(item)
|
|
if item.submenu:
|
|
self.app.mount(item.submenu)
|
|
item.submenu.close()
|
|
|
|
def on_key(self, event: events.Key) -> None:
|
|
"""Called when the user presses a key."""
|
|
|
|
if event.key == "up":
|
|
self.focus_index -= 1
|
|
if self.focus_index < 0:
|
|
self.focus_index = len(self.items) - 1
|
|
elif event.key == "down":
|
|
self.focus_index += 1
|
|
if self.focus_index >= len(self.items):
|
|
self.focus_index = 0
|
|
elif event.key == "escape":
|
|
self.close()
|
|
if self.parent_menu:
|
|
self.parent_menu.focus()
|
|
elif event.is_printable:
|
|
# TODO: alt+hotkey for top level menus, globally.
|
|
# This is pretty useless when you have to click a menu first.
|
|
for item in self.items:
|
|
if isinstance(item, MenuItem) and item.hotkey and event.character:
|
|
if item.hotkey.lower() == event.character.lower():
|
|
item.press()
|
|
break
|
|
|
|
|
|
def on_button_pressed(self, event: Button.Pressed) -> None:
|
|
"""Called when a button is clicked or activated with the keyboard."""
|
|
|
|
if isinstance(event.button, MenuItem):
|
|
if event.button.has_class("grayed"):
|
|
# TODO: use disabled property once Textual fixes mouse wheel events on disabled buttons
|
|
# and we have a way to listen for the mouse Enter event on disabled buttons
|
|
return
|
|
if event.button.action:
|
|
event.button.action()
|
|
root_menu = self
|
|
while root_menu.parent_menu:
|
|
root_menu = root_menu.parent_menu
|
|
root_menu.close()
|
|
elif event.button.submenu:
|
|
was_open = event.button.submenu.display
|
|
for item in self.items:
|
|
if item.submenu:
|
|
item.submenu.close()
|
|
if not was_open:
|
|
event.button.submenu.open(self, event.button)
|
|
|
|
def open(self, parent_menu: 'Menu', parent_menu_item: 'MenuItem') -> None:
|
|
self.display = True
|
|
if len(self.items) > 0:
|
|
self.items[0].focus()
|
|
self.parent_menu = parent_menu
|
|
self.parent_menu_item = parent_menu_item
|
|
self.add_class("menu_popup")
|
|
|
|
if isinstance(parent_menu, MenuBar):
|
|
self.styles.offset = (parent_menu_item.region.x, parent_menu_item.region.y + parent_menu_item.region.height)
|
|
else:
|
|
# JS code for reference
|
|
# https://github.com/1j01/os-gui/blob/bb4df0f0c26969c089858118130975cd137cdac8/MenuBar.js#L618-L644
|
|
# submenu_popup_el corresponds to self
|
|
# submenu_popup_rect corresponds to self.region
|
|
# rect corresponds to parent_menu_item.region
|
|
# scroll offset doesn't apply here
|
|
|
|
# const rect = item_el.getBoundingClientRect();
|
|
# let submenu_popup_rect = submenu_popup_el.getBoundingClientRect();
|
|
# submenu_popup_el.style.left = `${(get_direction() === "rtl" ? rect.left - submenu_popup_rect.width : rect.right) + window.scrollX}px`;
|
|
# submenu_popup_el.style.top = `${rect.top + window.scrollY}px`;
|
|
# submenu_popup_rect = submenu_popup_el.getBoundingClientRect();
|
|
# if (get_direction() === "rtl") {
|
|
# if (submenu_popup_rect.left < 0) {
|
|
# submenu_popup_el.style.left = `${rect.right}px`;
|
|
# submenu_popup_rect = submenu_popup_el.getBoundingClientRect();
|
|
# if (submenu_popup_rect.right > innerWidth) {
|
|
# submenu_popup_el.style.left = `${innerWidth - submenu_popup_rect.width}px`;
|
|
# }
|
|
# }
|
|
# } else {
|
|
# if (submenu_popup_rect.right > innerWidth) {
|
|
# submenu_popup_el.style.left = `${rect.left - submenu_popup_rect.width}px`;
|
|
# submenu_popup_rect = submenu_popup_el.getBoundingClientRect();
|
|
# if (submenu_popup_rect.left < 0) {
|
|
# submenu_popup_el.style.left = "0";
|
|
# }
|
|
# }
|
|
# }
|
|
|
|
rect = parent_menu_item.region
|
|
self.styles.offset = (
|
|
rect.x - self.region.width if get_direction() == "rtl" else rect.x + rect.width,
|
|
rect.y
|
|
)
|
|
if get_direction() == "rtl":
|
|
if self.region.x < 0:
|
|
self.styles.offset = (rect.x + rect.width, rect.y)
|
|
if self.region.x + self.region.width > self.screen.size.width:
|
|
self.styles.offset = (self.screen.size.width - self.region.width, rect.y)
|
|
else:
|
|
if self.region.x + self.region.width > self.screen.size.width:
|
|
self.styles.offset = (rect.x - self.region.width, rect.y)
|
|
if self.region.x < 0:
|
|
self.styles.offset = (0, rect.y)
|
|
|
|
# Find the widest label
|
|
max_width = 0
|
|
# any_submenus = False
|
|
for item in self.items:
|
|
if isinstance(item, MenuItem):
|
|
assert isinstance(item.label, Text)
|
|
if len(item.label.plain) > max_width:
|
|
max_width = len(item.label.plain)
|
|
if item.submenu:
|
|
# any_submenus = True
|
|
# Add a right pointing triangle to the label
|
|
# TODO: Make this work generally. Right now I've just spaced it for View > Zoom in English.
|
|
# Also, all this layout stuff should ideally use the width, not the length, of text.
|
|
# And it's stupid that this code applies multiple times to the same menu,
|
|
# and has to be idempotent.
|
|
# Basically I should rewrite this whole thing.
|
|
# I'd like to try using the built-in ListView widget for menus.
|
|
if not item.label.plain.endswith("▶"):
|
|
item.label = item.label.markup + "\t ▶"
|
|
# Split on tab character and align the shortcuts
|
|
for item in self.items:
|
|
if isinstance(item, MenuItem):
|
|
assert isinstance(item.label, Text)
|
|
markup_parts = item.label.markup.split("\t")
|
|
plain_parts = item.label.plain.split("\t")
|
|
if len(markup_parts) > 1:
|
|
item.label = markup_parts[0] + " " * (max_width - len(plain_parts[0])) + markup_parts[1]
|
|
|
|
def close(self):
|
|
for item in self.items:
|
|
if item.submenu:
|
|
item.submenu.close()
|
|
if not isinstance(self, MenuBar):
|
|
self.display = False
|
|
self.post_message(Menu.StatusInfo(None, closed=True))
|
|
|
|
class MenuBar(Menu):
|
|
"""A menu bar widget."""
|
|
|
|
def __init__(self, items: list['MenuItem|Separator'], **kwargs: Any) -> None:
|
|
"""Initialize a menu bar."""
|
|
super().__init__(items, **kwargs)
|
|
|
|
|
|
class MenuItem(Button):
|
|
"""A menu item widget."""
|
|
|
|
def __init__(self,
|
|
name: str,
|
|
action: Callable[[], None] | None = None,
|
|
id: str | int | None = None,
|
|
submenu: Menu | None = None,
|
|
description: str | None = None,
|
|
grayed: bool = False,
|
|
**kwargs: Any
|
|
) -> None:
|
|
"""Initialize a menu item."""
|
|
super().__init__(markup_hotkey(name), **kwargs)
|
|
self.hotkey: str|None = get_hotkey(name)
|
|
# self.disabled = grayed # This breaks scroll wheel over the menu item, as of Textual 0.20.1
|
|
if grayed:
|
|
self.add_class("grayed")
|
|
self.can_focus = False
|
|
self.action = action
|
|
self.submenu = submenu
|
|
self.description = description
|
|
if isinstance(id, str):
|
|
self.id = id
|
|
elif id:
|
|
self.id = "rc_" + str(id)
|
|
else:
|
|
self.id = "menu_item_" + to_snake_case(name)
|
|
|
|
def on_enter(self, event: events.Enter) -> None:
|
|
self.post_message(Menu.StatusInfo(self.description))
|
|
def on_leave(self, event: events.Leave) -> None:
|
|
self.post_message(Menu.StatusInfo(None))
|
|
|
|
|
|
mid_line = "─" * 100
|
|
class Separator(Static):
|
|
"""A menu separator widget."""
|
|
|
|
def __init__(self, **kwargs: Any) -> None:
|
|
"""Initialize a separator."""
|
|
super().__init__(mid_line, **kwargs)
|
|
self.hotkey = None
|
|
# self.disabled = True # This breaks scroll wheel over the separator, as of Textual 0.20.1
|
|
self.disabled = False
|
|
self.action = None
|
|
self.submenu = None
|