On this page

libtmux.Window

Module: libtmux
Package: libtmux
Source: src/libtmux/window.py

class libtmux.Window class [source] ¶ class [source] ¶ class libtmux.Window

Bases:

Holds Pane objects.

Examples

>>> window = session.new_window('My project', attach=True)

>>> window
Window(@2 2:My project, Session($... ...))

Windows have panes:

>>> window.panes
[Pane(...)]

>>> window.active_pane
Pane(...)

Relations moving up:

>>> window.session
Session(...)

>>> window.window_id == session.active_window.window_id
True

>>> window == session.active_window
True

>>> window in session.windows
True

The window can be used as a context manager to ensure proper cleanup:

>>> with session.new_window() as window:
...     pane = window.split()
...     # Do work with the pane
...     # Window will be killed automatically when exiting the context

References

[window_manual]: tmux window. openbsd manpage for TMUX(1). "Each session has one or more windows linked to it. A window occupies the entire screen and may be split into rectangular panes..." https://man.openbsd.org/tmux.1#DESCRIPTION. Accessed April 1st, 2018.

56 declared, 198 inherited

Members

default_hook_scope attribute
default_option_scope attribute
server attribute
__enter__ method Enter the context, returning self.
__eq__ method Equal operator for Window object.
__exit__ method Exit the context, killing the window if it exists.
__getitem__ method Return item lookup by key. Deprecated in favor of attributes.
__repr__ method Representation of Window object.
_list_panes method Return list of panes (deprecated in favor of panes ).
cmd method Execute tmux subcommand within window context.
display_message method Display message at window scope via $ tmux display-message.
find_where method Filter through panes, return first Pane .
from_env method Return the window containing the pane this process runs inside of.
from_window_id method Create Window from existing window_id.
get method Return key-based lookup. Deprecated by attributes.
get_by_id method Return pane by id. Deprecated in favor of panes.get().
kill method Kill Window .
kill_window method Kill the current Window object. $ tmux kill-window.
last_pane method Select the last (previously active) pane via $ tmux last-pane.
link method Link this window to another session via $ tmux link-window.
list_panes method Return list of Pane for the window.
move_window method Move current Window object $ tmux move-window.
new_pane method Create a floating Pane in this window ($ tmux new-pane).
new_window method Create new window respective of current window's position.
next_layout method Cycle to the next layout via $ tmux next-layout.
previous_layout method Cycle to the previous layout via $ tmux previous-layout.
refresh method Refresh window attributes from tmux.
rename_window method Rename window.
resize method Resize tmux window.
respawn method Respawn the window process via $ tmux respawn-window.
rotate method Rotate pane positions in the window via $ tmux rotate-window.
search_panes method Panes in this window, optionally filtered by tmux.
select method Select window.
select_layout method Select layout for window.
select_pane method Select pane and return selected Pane .
select_window method Select window.
set_window_option method Set option for tmux window. Deprecated by Window.set_option() .
show_window_option method Return option for target window. Deprecated by Window.show_option() .
show_window_options method Show options for tmux window. Deprecated by Window.show_options() .
split method Split window on active pane and return the created Pane .
split_window method Split window and return the created Pane .
swap method Swap this window with another via $ tmux swap-window.
unlink method Unlink this window from the current session via $ tmux unlink-window.
where method Filter through panes, return list of Pane .
_panes property Property / alias to return _list_panes .
active_pane property Return attached Pane .
attached_pane property Return attached Pane .
children property Was used by TmuxRelationalObject (but that's longer used in this class).
height property Alias of Window.window_height .
id property Alias of Window.window_id .
index property Alias of Window.window_index .
linked_sessions property Every session this window is reachable from.
name property Alias of Window.window_name .
panes property Panes contained by window.
session property Parent session of window.
width property Alias of Window.window_width .

Inherited members

Reached through libtmux.neo.Obj, libtmux.hooks.HooksMixin, libtmux.options.OptionsMixin.

active_window_index libtmux.neo.Obj
alternate_saved_x libtmux.neo.Obj
alternate_saved_y libtmux.neo.Obj
bracket_paste_flag libtmux.neo.Obj
buffer_name libtmux.neo.Obj
buffer_sample libtmux.neo.Obj
buffer_size libtmux.neo.Obj
client_activity libtmux.neo.Obj
client_cell_height libtmux.neo.Obj
client_cell_width libtmux.neo.Obj
client_control_mode libtmux.neo.Obj
client_created libtmux.neo.Obj
client_discarded libtmux.neo.Obj
client_flags libtmux.neo.Obj
client_height libtmux.neo.Obj
client_key_table libtmux.neo.Obj
client_last_session libtmux.neo.Obj
client_mode_format libtmux.neo.Obj
client_name libtmux.neo.Obj
client_pid libtmux.neo.Obj
client_prefix libtmux.neo.Obj
client_readonly libtmux.neo.Obj
client_session libtmux.neo.Obj
client_termfeatures libtmux.neo.Obj
client_termname libtmux.neo.Obj
client_termtype libtmux.neo.Obj
client_tty libtmux.neo.Obj
client_uid libtmux.neo.Obj
client_user libtmux.neo.Obj
client_utf8 libtmux.neo.Obj
client_width libtmux.neo.Obj
client_written libtmux.neo.Obj
command_list_alias libtmux.neo.Obj
command_list_name libtmux.neo.Obj
command_list_usage libtmux.neo.Obj
config_files libtmux.neo.Obj
copy_cursor_line libtmux.neo.Obj
copy_cursor_word libtmux.neo.Obj
copy_cursor_x libtmux.neo.Obj
copy_cursor_y libtmux.neo.Obj
current_file libtmux.neo.Obj
cursor_character libtmux.neo.Obj
cursor_flag libtmux.neo.Obj
cursor_x libtmux.neo.Obj
cursor_y libtmux.neo.Obj
history_bytes libtmux.neo.Obj
history_limit libtmux.neo.Obj
history_size libtmux.neo.Obj
hooks libtmux.hooks.HooksMixin
insert_flag libtmux.neo.Obj
keypad_cursor_flag libtmux.neo.Obj
keypad_flag libtmux.neo.Obj
last_window_index libtmux.neo.Obj
line libtmux.neo.Obj
mouse_all_flag libtmux.neo.Obj
mouse_any_flag libtmux.neo.Obj
mouse_button_flag libtmux.neo.Obj
mouse_sgr_flag libtmux.neo.Obj
mouse_standard_flag libtmux.neo.Obj
next_session_id libtmux.neo.Obj
origin_flag libtmux.neo.Obj
pane_active libtmux.neo.Obj
pane_at_bottom libtmux.neo.Obj
pane_at_left libtmux.neo.Obj
pane_at_right libtmux.neo.Obj
pane_at_top libtmux.neo.Obj
pane_bg libtmux.neo.Obj
pane_bottom libtmux.neo.Obj
pane_current_command libtmux.neo.Obj
pane_current_path libtmux.neo.Obj
pane_dead libtmux.neo.Obj
pane_dead_signal libtmux.neo.Obj
pane_dead_status libtmux.neo.Obj
pane_dead_time libtmux.neo.Obj
pane_fg libtmux.neo.Obj
pane_flags libtmux.neo.Obj
pane_floating_flag libtmux.neo.Obj
pane_format libtmux.neo.Obj
pane_height libtmux.neo.Obj
pane_id libtmux.neo.Obj
pane_in_mode libtmux.neo.Obj
pane_index libtmux.neo.Obj
pane_input_off libtmux.neo.Obj
pane_last libtmux.neo.Obj
pane_left libtmux.neo.Obj
pane_marked libtmux.neo.Obj
pane_marked_set libtmux.neo.Obj
pane_mode libtmux.neo.Obj
pane_path libtmux.neo.Obj
pane_pb_progress libtmux.neo.Obj
pane_pb_state libtmux.neo.Obj
pane_pid libtmux.neo.Obj
pane_pipe libtmux.neo.Obj
pane_pipe_pid libtmux.neo.Obj
pane_right libtmux.neo.Obj
pane_search_string libtmux.neo.Obj
pane_start_command libtmux.neo.Obj
pane_start_path libtmux.neo.Obj
pane_synchronized libtmux.neo.Obj
pane_tabs libtmux.neo.Obj
pane_title libtmux.neo.Obj
pane_top libtmux.neo.Obj
pane_tty libtmux.neo.Obj
pane_width libtmux.neo.Obj
pane_x libtmux.neo.Obj
pane_y libtmux.neo.Obj
pane_z libtmux.neo.Obj
pane_zoomed_flag libtmux.neo.Obj
pid libtmux.neo.Obj
scroll_position libtmux.neo.Obj
scroll_region_lower libtmux.neo.Obj
scroll_region_upper libtmux.neo.Obj
search_match libtmux.neo.Obj
selection_end_x libtmux.neo.Obj
selection_end_y libtmux.neo.Obj
selection_start_x libtmux.neo.Obj
selection_start_y libtmux.neo.Obj
session_activity libtmux.neo.Obj
session_alerts libtmux.neo.Obj
session_attached libtmux.neo.Obj
session_attached_list libtmux.neo.Obj
session_created libtmux.neo.Obj
session_format libtmux.neo.Obj
session_group libtmux.neo.Obj
session_group_attached libtmux.neo.Obj
session_group_attached_list libtmux.neo.Obj
session_group_list libtmux.neo.Obj
session_group_many_attached libtmux.neo.Obj
session_group_size libtmux.neo.Obj
session_grouped libtmux.neo.Obj
session_id libtmux.neo.Obj
session_last_attached libtmux.neo.Obj
session_many_attached libtmux.neo.Obj
session_marked libtmux.neo.Obj
session_name libtmux.neo.Obj
session_path libtmux.neo.Obj
session_stack libtmux.neo.Obj
session_windows libtmux.neo.Obj
socket_path libtmux.neo.Obj
start_time libtmux.neo.Obj
synchronized_output_flag libtmux.neo.Obj
uid libtmux.neo.Obj
user libtmux.neo.Obj
version libtmux.neo.Obj
window_active libtmux.neo.Obj
window_active_clients libtmux.neo.Obj
window_active_clients_list libtmux.neo.Obj
window_active_sessions libtmux.neo.Obj
window_active_sessions_list libtmux.neo.Obj
window_activity libtmux.neo.Obj
window_activity_flag libtmux.neo.Obj
window_bell_flag libtmux.neo.Obj
window_bigger libtmux.neo.Obj
window_cell_height libtmux.neo.Obj
window_cell_width libtmux.neo.Obj
window_end_flag libtmux.neo.Obj
window_flags libtmux.neo.Obj
window_format libtmux.neo.Obj
window_height libtmux.neo.Obj
window_id libtmux.neo.Obj
window_index libtmux.neo.Obj
window_last_flag libtmux.neo.Obj
window_layout libtmux.neo.Obj
window_linked libtmux.neo.Obj
window_linked_sessions libtmux.neo.Obj
window_linked_sessions_list libtmux.neo.Obj
window_marked_flag libtmux.neo.Obj
window_name libtmux.neo.Obj
window_offset_x libtmux.neo.Obj
window_offset_y libtmux.neo.Obj
window_panes libtmux.neo.Obj
window_raw_flags libtmux.neo.Obj
window_silence_flag libtmux.neo.Obj
window_stack_index libtmux.neo.Obj
window_start_flag libtmux.neo.Obj
window_visible_layout libtmux.neo.Obj
window_width libtmux.neo.Obj
window_zoomed_flag libtmux.neo.Obj
wrap_flag libtmux.neo.Obj
__init__ libtmux.options.OptionsMixin When not a user (custom) option, scope can be implied.
_refresh libtmux.neo.Obj Refresh dataclass fields from a single list-* row.
_show_hook libtmux.hooks.HooksMixin Return value for the hook.
_show_option libtmux.options.OptionsMixin Return option value for the target.
_show_option_raw libtmux.options.OptionsMixin Return raw option output for target.
_show_options libtmux.options.OptionsMixin Return a dict of options for the target.
_show_options_dict libtmux.options.OptionsMixin Return dict of options for the target.
_show_options_raw libtmux.options.OptionsMixin Return a dict of options for the target.
run_hook libtmux.hooks.HooksMixin Run a hook immediately. Useful for testing.
set_hook libtmux.hooks.HooksMixin Set hook for tmux target.
set_hooks libtmux.hooks.HooksMixin Set multiple indexed hooks at once.
set_option libtmux.options.OptionsMixin Set option for tmux target.
show_hook libtmux.hooks.HooksMixin Return value for a hook.
show_hooks libtmux.hooks.HooksMixin Return a dict of hooks for the target.
show_option libtmux.options.OptionsMixin Return option value for the target.
show_options libtmux.options.OptionsMixin Return all options for the target.
unset_hook libtmux.hooks.HooksMixin Unset hook for tmux target.
unset_option libtmux.options.OptionsMixin Unset option for tmux target.
_tmux_bin libtmux.hooks.HooksMixin Resolve tmux_bin from self (Server) or self.server (Session/Window/Pane).