Core LibraryalphaAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-cxx latest

Pane.toggle_zoom

Toggle whether this pane's window is zoomed onto it — the whole window given over to one pane, full size.

Source and package
Qualified name
libtmux::Pane::toggle_zoom
Namespace
libtmux
Declared in
Pane
Package
libtmux-cxx
Source
include/libtmux/entities.hpp
[[C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.Language documentation]] expected<void, CommandFailure> toggle_zoom() const;

Description#

Zoom is window state, which Window::zoomed() reads; naming a pane here is how tmux picks which one to give the window to.

Only the zoom-in direction reads this pane: a window already zoomed unzooms on any target, this pane included, and stays on whichever pane it was zoomed onto (measured against raw tmux).

tmux command#

The tmux commands behind toggle_zoom.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference