io.github.libtmux.Pane.Pane

class io.github.libtmux.Pane.Pane

classreadonly [source] ¶

classreadonly [source] ¶

class io.github.libtmux.Pane.Pane

One tmux pane, as one capture saw it.

Identity is the server and the pane id. An index is state: panes renumber as neighbours come and go.

Discussed in Architecture

In other ports A tmux pane

• Python libtmux.Pane
• Ruby LibTmux::Pane
• Lua libtmux.Pane
• TypeScript pane.Pane
• Rust pane.Pane
• Go tmux.Pane
• .NET LibTmux.Pane
• C++ libtmux::Pane
• Swift Pane

Members

• capture method This pane's visible content, one element per line.
• respawn method Kills whatever runs here and starts the pane's default command again.
• kill method Closes this pane.
• select method Makes this the active pane of its window.
• breakOut method Moves this pane into a window of its own, leaving tmux to name it.
• split method Splits this pane in half, putting the new one below it.
• clearHistory method Discards this pane's scrollback.
• retitle method Retitles this pane and returns its replacement capture.
• pasteBuffer method Pastes a named buffer into this pane, as though it had been typed.
• window method The window link this pane was reached through. A pure read of the capture.
• resize method Grows this pane by a number of cells in one direction.
• options method This pane's own options.
• id method The pane's stable id.
• index method The pane's position, which shifts as neighbours come and go.
• swapWith method Swaps this pane's position with another's.
• pipeTo method Sends everything this pane prints to a shell command, until #stopPiping .
• copyMode method Puts this pane into copy mode, where its scrollback can be navigated.
• hooks method This pane's own hooks.
• title method The pane title, which a program running inside it can change.
• active method Whether this was its window's active pane when captured.
• currentCommand method The command tmux reported running here.
• joinTo method Moves this pane into another window, splitting it.
• currentPath method The working directory tmux reported for the pane.
• refresh method Takes a new capture and returns this pane as it is now.
• server method The server this pane lives on.
• pid method The process id of the program running in the pane, captured at the time of the read this handle came from.
• created method Runs a command that reports one new pane, and hands back a handle on it.
• equals method
• floating method Whether this pane floats, or empty when the running tmux cannot say.
• send method Sends keys to this pane without pressing Enter.
• sendLine method Sends a line to this pane and presses Enter, which is how a command gets run.
• await method Waits until a condition holds for this pane as tmux reports it, and says why the wait ended.
• expand method Expands a tmux format in this pane's context, and answers with what it came to.
• run method Runs a shell command in this pane to its end, and answers with its exit status and output.
• awaitText method Waits until this pane's text contains something, and says why the wait ended.
• batch method Collects commands fenced to the server incarnation that produced this pane.
• createdFormat method The format a creating command reports its new pane through.
• currentPathText method The working directory tmux reported for the pane, exactly as tmux reported it.
• dead method Whether this pane's process has exited, read fresh rather than from the capture.
• edges method Which sides of its window the pane touches.
• exitMode method Leaves whichever mode this pane is in.
• hashCode method
• mode method Which mode this pane is in at this moment, or empty when it is in none.
• noteTyped method Notes text that reached this pane without going through this handle, so a wait discounts its echo the way it discounts text sent through #sendLiteral .
• Pane method
• paste method Pastes text into this pane as one block, leaving nothing behind on the server.
• position method Where the pane's top-left corner sat in its window when captured, in terminal cells.
• resizeTo method Resizes this pane.
• respawnArgv method
• respawnIn method Restarts the configured pane process in a caller-supplied literal directory.
• sendKeys method Sends an ordered group of key names to this pane, as tmux resolves them.
• sendLiteral method Sends an ordered group of strings to this pane as the characters they spell.
• size method How large the pane was when captured, in terminal cells.
• snapshot method
• stopPiping method Stops sending this pane's output anywhere. Doing so twice is not an error.
• toString method
• variables method Reads validated tmux variables in this pane's format context.