jbrowser.core.commands
Generated from the source code of JBrowser 1.5.1.
Command registry: single source of truth for actions, shortcuts and the cheat sheet.
Command#
class CommandsourceAttributes
| Name | Value |
|---|---|
id |
str |
title |
str |
category |
str |
handler |
Callable[[], None] |
shortcuts |
list[str] = field(default_factory=list) |
keywords |
str = '' |
icon |
str = '' |
palette |
bool = True |
state |
Callable[[], str | None] | None = None |
enabled |
Callable[[], bool] | None = None |
Command.shortcut_text#
shortcut_text() -> strsourceCommandRegistry#
class CommandRegistry(QObject)sourceCommandRegistry(parent: QObject | None=None)Signals
| Signal | Arguments |
|---|---|
executed |
(str) |
CommandRegistry.register#
register(cmd: Command) -> CommandsourceCommandRegistry.add#
add(id: str, title: str, category: str, handler: Callable[[], None], **kw) -> CommandsourceCommandRegistry.get#
get(id: str) -> Command | NonesourceCommandRegistry.all#
all() -> list[Command]sourceCommandRegistry.run#
run(id: str) -> NonesourceCommandRegistry.install_shortcuts#
install_shortcuts(window: QWidget) -> NonesourceCommandRegistry.set_shortcuts_enabled#
set_shortcuts_enabled(enabled: bool) -> NonesourceUsed while a full-window experience (the welcome tour) owns the keyboard.
CommandRegistry.categories#
categories() -> dict[str, list[Command]]source