Window
One tmux window at one of its positions, as one capture saw it.
Source and package
- Qualified name
-
io.github .libtmux. Window - Package
- io.github.libtmux
- Distribution
- io.github.libtmux:libtmux
- Source
- libtmux/src/main/java/io/github/libtmux/Window.java
- Other languages
- Perlclass Erlangstruct PowerShellcmdlet Juliastruct Elixirstruct Haskell Common Lispclass PythonRubyLuaTypeScriptRustGoC#C++SwiftKotlinScalaOCamltypealias F#module Clojurefunction
-
Description#
Identity is the winlink: the server, the session, the index and the window. A window linked into two sessions is one window and two handles, because tmux orders and addresses those positions separately.
#id()stays available for asking whether two links are the same underlying window.A method named for a captured field returns what
#info()holds and does no I/O;#refresh()reads again. Every other method asks tmux now.
Members39#
Parent objects2#
Collections and queries1#
- panes method This link's panes, in tmux's order. A pure read of the capture.
Common operations22#
- selectLayout method Rearranges this window's panes into one of tmux's built-in layouts.
- kill method Closes this window.
- rename method Renames this window and returns its replacement capture.
- linkTo method Links this window into another session, so one window sits in both.
- unlink method Removes this link, leaving the window wherever else it is linked.
- select method Makes this the active window of its session.
- id method The underlying window, shared by every link to it.
- name method The window name.
- moveTo method Moves this window into another session.
- split method Splits this window's active pane in half, putting the new one below it.
- options method This window's own options, which every link to it shares.
- index method Where this link sits in its session.
- resizeTo method Resizes this window in terminal cells.
- rotate method Rotates the panes within this window.
- hooks method This window's own hooks, which every link to it shares.
- active method Whether this was its session's active window when captured.
- layout method tmux's own layout for this window, in whichever form this server writes it.
- respawn method Kills what is running in this window and starts it again.
- activePane method The pane tmux had active here. A pure read of the capture.
- nextLayout method Moves to the next built-in layout, as tmux's own binding does.
- refresh method Takes a new capture and returns this winlink as it is now.
- linked method Whether the underlying window is linked into more than one session.
Other members14#
- applyLayout method Restores an exact arrangement previously read from
#layout(). - context method The winlink this handle addresses.
- displayPopup method Shows a popup over this window, running a command in it.
- equals method
- expand method Expands a tmux format in this window's context, and answers with what it came to.
- hashCode method
- info method The fields this capture stored. A later rename is not visible here.
- previousLayout method Moves to the previous built-in layout, as tmux's own binding does.
- size method How large the window was when captured, in terminal cells.
- snapshot method
- stopSynchronizingPanes method Stops copying input between this window's panes.
- synchronizePanes method Copies input to one pane into every pane in this window, until
#stopSynchronizingPanes(). - toString method
- Window method
Guides#
Pages that discuss Window.
- Concepts
- Topics
In other ports#
A tmux window
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Ruby | Lib |
| Lua | libtmux |
| PowerShell | Lib This cmdlet reads shared .NET LibTmux.Window placements. Use -Server for all sessions or -Session for one session. |
| Julia | Lib WindowSnapshot holds captured physical-window data. WindowLink records a placement in a session; actions use WindowRef. |
| Erlang | #tmux A physical window can have several session memberships. window_link holds the session-relative index and active flag. |
| Elixir | Lib Window is a physical window. WindowLink records its session index and active state. |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| Common Lisp | libtmux: window is a physical captured window. window-link preserves each session placement. |
| TypeScript | window |
| Rust | window |
| Go | tmux |
| Clojure | libtmux Traverses captured window-placement maps without I/O; the window value is a map with an explicit Java reference for effects. |
| Kotlin | io |
| Scala | io |
| C# | Lib |
| F# | Lib This F# module identifies shared .NET LibTmux.Window placements and builds deferred pane queries. Query.list acquires their results from tmux. |
| C++ | libtmux:: |
| Swift | Window |
| OCaml | Libtmux A global window can have several session placements. Window_link holds the session, index and current flag. |
| Perl | Lib Physical window identity. WindowLink owns each session/index placement. |