typealias libtmux-scala latest
Pane
A captured pane occurrence, opaque over the Java handle. Java equality identifies the physical pane; every operation beyond that is an extension, generated from the operation catalog or handwritten where the catalog marks it WAIT , STREAM or LIFECYCLE .
Source and package
- Module
- io.github.libtmux.scaladsl
- Package
- io.github.libtmux:libtmux-scala_3
- Source
- libtmux-scala/src/main/scala/io/github/libtmux/scaladsl/Pane.scala
- Other languages
- PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftKotlin F#
-
Discussed in Server, session, window, pane
In other ports A tmux pane
- Python
libtmux.Pane - Ruby
LibTmux::Pane - Lua
libtmux.Pane - TypeScript
pane.Pane - Rust
pane.Pane - Go
tmux.Pane - Java
io.github.libtmux.Pane - C#
LibTmux.Pane - C++
libtmux::Pane - Swift
Pane - Kotlin
io.github.libtmux.kotlin.Pane - F# No source-verified F# equivalent is recorded for this operation.
- Python
Members62 members#
Parent objects2 members#
Common operations10 members#
- capture method This pane's visible content, one element per line.
- sendKeys method Sends an ordered group of key names to this pane, as tmux resolves them.
- split method Splits this pane in half, putting the new one below it.
- active method Whether this was its window's active pane.
- await method Waits until
settledholds for this pane as it is now.settledreceives a fresh capture each look. - awaitText method Waits until
textappears, ortimeoutpasses first. - command method The command tmux reported running in the pane.
- options method This pane's own options.
- run method Runs a shell command in this pane to its end, and answers with its exit status and output.
- sendLine method Sends a line to this pane and presses Enter, which is how a command gets run.
Other members50 members#
- asJava method The underlying Java pane. Opaque wrapping is free, so this never copies scope or state.
- atBottom method Whether the pane touches the bottom of its window.
- atLeft method Whether the pane touches the left of its window.
- atRight method Whether the pane touches the right of its window.
- atTop method Whether the pane touches the top of its window.
- batch method Collects commands fenced to the server incarnation that produced this pane.
- breakOut method Moves this pane into a window of its own, leaving tmux to name it.
- clearHistory method Discards this pane's scrollback.
- copyMode method Puts this pane into copy mode, where its scrollback can be navigated.
- currentCommand method The command tmux reported running here.
- currentPath method The working directory tmux reported for the pane.
- 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.
- expand method Expands a tmux format in this pane's context, and answers with what it came to.
- floating method Whether this pane floats, or empty when the running tmux cannot say.
- given_CanEqual_Pane_Pane constant
- height method The pane's height, in cells.
- hooks method This pane's own hooks.
- id method The pane id.
- index method The pane's position in its window.
- info method The fields this capture stored.
- joinTo method Moves this pane into another window, splitting it.
- kill method Closes this pane.
- left method The column of the pane's left edge in its window.
- 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. - paste method Pastes text into this pane as one block, leaving nothing behind on the server.
- pasteBuffer method Pastes a named buffer into this pane, as though it had been typed.
- path method The pane's working directory, as the text tmux reported.
- pid method The process id of the program running in the pane, captured at the time of the read this handle came from.
- pipeTo method Sends everything this pane prints to a shell command, until
#stopPiping. - position method Where the pane's top-left corner sat in its window when captured, in terminal cells.
- refresh method Takes a new capture and returns this pane as it is now.
- resize method Grows this pane by a number of cells in one direction.
- resizeTo method Resizes this pane.
- respawn method Kills whatever runs here and starts the pane's default command again.
- respawnIn method Restarts the configured pane process in a caller-supplied literal directory, resolved against this process's working directory when relative.
- retitle method Retitles this pane and returns its replacement capture.
- select method Makes this the active pane of its window.
- send method Sends keys to this pane without pressing Enter.
- 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.
- stopPiping method Stops sending this pane's output anywhere.
- swapWith method Swaps this pane's position with another's.
- title method The pane's title, which a program running in it can set.
- top method The row of the pane's top edge in its window.
- variables method Reads validated tmux variables in this pane's format context.
- width method The pane's width, in cells.