mirrors/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty synced 2026-07-27 18:51:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document actions in the tab object

Browse Source
This commit is contained in:
Kovid Goyal
2021-06-29 20:12:39 +05:30
parent 3d5d60bc5b
commit 91f0da9dcd
2 changed files with 38 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
kitty/boss.py
View File

@@ -1635,6 +1635,11 @@ class Boss:
) )
def detach_window(self, *args: str) -> None: def detach_window(self, *args: str) -> None:
'''
@ac:win: Detach a window, moving it to another tab or OS Window
See :ref:`detach_window` for details.
'''
if not args or args[0] == 'new': if not args or args[0] == 'new':
return self._move_window_to(target_os_window_id='new') return self._move_window_to(target_os_window_id='new')
if args[0] == 'new-tab': if args[0] == 'new-tab':
@@ -1685,6 +1690,11 @@ class Boss:
) )
def detach_tab(self, *args: str) -> None: def detach_tab(self, *args: str) -> None:
'''
@ac:tab: Detach a tab, moving it to another OS Window
See :ref:`detach_window` for details.
'''
if not args or args[0] == 'new': if not args or args[0] == 'new':
return self._move_tab_to() return self._move_tab_to()

28
kitty/tabs.py
View File

@@ -393,11 +393,13 @@ class Tab: # {{{
) )
def close_window(self) -> None: def close_window(self) -> None:
'@ac:win: Close the currently active window'
w = self.active_window w = self.active_window
if w is not None: if w is not None:
self.remove_window(w) self.remove_window(w)
def close_other_windows_in_tab(self) -> None: def close_other_windows_in_tab(self) -> None:
'@ac:win: Close all windows in the tab other than the currently active window'
if len(self.windows) > 1: if len(self.windows) > 1:
active_window = self.active_window active_window = self.active_window
for window in tuple(self.windows): for window in tuple(self.windows):
@@ -436,6 +438,13 @@ class Tab: # {{{
return self.current_layout.nth_window(self.windows, n) return self.current_layout.nth_window(self.windows, n)
def nth_window(self, num: int = 0) -> None: def nth_window(self, num: int = 0) -> None:
'''
@ac:win: Focus the nth window if positive or the previously active windows if negative
For example, to ficus the previously active window::
map ctrl+p nth_window -1
'''
if self.windows: if self.windows:
if num < 0: if num < 0:
self.windows.make_previous_group_active(-num) self.windows.make_previous_group_active(-num)
@@ -449,9 +458,11 @@ class Tab: # {{{
self.relayout_borders() self.relayout_borders()
def next_window(self) -> None: def next_window(self) -> None:
'@ac:win: Focus the next window in the current tab'
self._next_window() self._next_window()
def previous_window(self) -> None: def previous_window(self) -> None:
'@ac:win: Focus the previous window in the current tab'
self._next_window(-1) self._next_window(-1)
prev_window = previous_window prev_window = previous_window
@@ -474,11 +485,25 @@ class Tab: # {{{
return self.most_recent_group(candidates) return self.most_recent_group(candidates)
def neighboring_window(self, which: EdgeLiteral) -> None: def neighboring_window(self, which: EdgeLiteral) -> None:
'''
@ac:win: Focus the neighboring window in the current tab
For example::
map ctrl+left neighboring_window left
map ctrl+down neighboring_window bottom
'''
neighbor = self.neighboring_group_id(which) neighbor = self.neighboring_group_id(which)
if neighbor: if neighbor:
self.windows.set_active_group(neighbor) self.windows.set_active_group(neighbor)
def move_window(self, delta: Union[EdgeLiteral, int] = 1) -> None: def move_window(self, delta: Union[EdgeLiteral, int] = 1) -> None:
'''
@ac:win: Move the window in the specified direction
For example::
map ctrl+left move_window left
map ctrl+down move_window bottom
'''
if isinstance(delta, int): if isinstance(delta, int):
if self.current_layout.move_window(self.windows, delta): if self.current_layout.move_window(self.windows, delta):
self.relayout() self.relayout()
@@ -489,14 +514,17 @@ class Tab: # {{{
self.relayout() self.relayout()
def move_window_to_top(self) -> None: def move_window_to_top(self) -> None:
'@ac:win: Move active window to the top (make it the first window)'
n = self.windows.active_group_idx n = self.windows.active_group_idx
if n > 0: if n > 0:
self.move_window(-n) self.move_window(-n)
def move_window_forward(self) -> None: def move_window_forward(self) -> None:
'@ac:win: Move active window forward (swap it with the next window)'
self.move_window() self.move_window()
def move_window_backward(self) -> None: def move_window_backward(self) -> None:
'@ac:win: Move active window backward (swap it with the previous window)'
self.move_window(-1) self.move_window(-1)
def list_windows(self, active_window: Optional[Window], self_window: Optional[Window] = None) -> Generator[WindowDict, None, None]: def list_windows(self, active_window: Optional[Window], self_window: Optional[Window] = None) -> Generator[WindowDict, None, None]: