kitty/kitty/rc/goto_layout.py
pagedown 17632dea3c
Docs: Improve remote control command documentation
Improve the --match option description.
Add more text roles and links.
Fix typos.
2022-04-29 01:31:11 +08:00

54 lines
1.8 KiB
Python

#!/usr/bin/env python
# License: GPLv3 Copyright: 2020, Kovid Goyal <kovid at kovidgoyal.net>
from typing import TYPE_CHECKING, Optional, Iterable
from .base import (
MATCH_TAB_OPTION, ArgsType, Boss, PayloadGetType, PayloadType, RCOptions,
RemoteCommand, ResponseType, UnknownLayout, Window
)
if TYPE_CHECKING:
from kitty.cli_stub import GotoLayoutRCOptions as CLIOptions
def layout_names() -> Iterable[str]:
from kitty.layout.interface import all_layouts
return all_layouts.keys()
class GotoLayout(RemoteCommand):
'''
layout+: The new layout name
match: Which tab to change the layout of
'''
short_desc = 'Set the window layout'
desc = (
'Set the window layout in the specified tabs (or the active tab if not specified).'
' You can use special match value :code:`all` to set the layout in all tabs.'
)
options_spec = MATCH_TAB_OPTION
argspec = 'LAYOUT_NAME'
args_count = 1
args_completion = {'names': ('Layouts', layout_names)}
def message_to_kitty(self, global_opts: RCOptions, opts: 'CLIOptions', args: ArgsType) -> PayloadType:
if len(args) != 1:
self.fatal('Exactly one layout must be specified')
return {'layout': args[0], 'match': opts.match}
def response_from_kitty(self, boss: Boss, window: Optional[Window], payload_get: PayloadGetType) -> ResponseType:
tabs = self.tabs_for_match_payload(boss, window, payload_get)
for tab in tabs:
if tab:
try:
tab.goto_layout(payload_get('layout'), raise_exception=True)
except ValueError:
raise UnknownLayout('The layout {} is unknown or disabled'.format(payload_get('layout')))
return None
goto_layout = GotoLayout()