Core Library0.xAPI 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.

struct libtmux-go latest

SelectLayoutRequest

SelectLayoutRequest selects one layout operation. Its zero value reapplies the last preset layout. Layout, Spread, Next, and Previous are mutually exclusive and are validated before execution; an empty Layout is omitted rather than passed explicitly. The request contains no retained caller-owned storage and is supported on tmux 3.3a or later.

Source and package
Qualified name
tmux.SelectLayoutRequest
Package
tmux
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/window_layout.go
struct tmux.SelectLayoutRequest

Fields4#

SelectLayoutRequest fields
NameTypeDescription
Layout string Layout names a preset or supplies a tmux layout string - either the classic checksum-prefixed grammar every supported version accepts, or the JSON shape tmux 3.8+ also accepts, exactly as #{window_layout} reported it; empty selects the zero-value behavior.
Next bool Next selects the next preset layout.
Previous bool Previous selects the previous preset layout.
Spread bool Spread distributes pane space evenly.

Members1#

  • Validate method Validate checks mode exclusivity, NUL bytes, candidate preset names and classic checksummed syntax and JSON envelopes without running tmux. Its zero value is valid. Invalid requests match ErrInvalidServerCommandRequest. Names and abbreviations valid on any supported tmux are accepted here; execution checks daemon support. tmux validates JSON contents, geometry and live pane counts when applying it.
Esc

Type to search.

Reference previewOpen reference