class libtmux-kotlin latest
Pane
A tmux pane, with operations for input, output, and layout.
Source and package
- Module
- io.github.libtmux.kotlin
- Package
- io.github.libtmux:libtmux-kotlin
- Source
- libtmux-kotlin/src/main/kotlin/io/github/libtmux/kotlin/Pane.kt
- Other languages
- PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftScala F#
-
Description#
Holds the Java handle privately, so a member here always wins over a same-named catalog-generated extension in
PaneOperations.kt.Companionhosts the generated query field namespace (Pane.command,Pane.active, ...).Discussed in Server, session, window, pane · Coroutines and flows , Getting started
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 - Scala
io.github.libtmux.scaladsl.Pane - F# No source-verified F# equivalent is recorded for this operation.
- Python
Members53 members#
Parent objects2 members#
Common operations7 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.
- options method This pane's own options.
- currentCommand property The command tmux reported running here.
- awaitText method Waits until
textshows in this pane. - sendLine method Sends a line to this pane and presses Enter, which is how a command gets run.
Other members44 members#
- active property Whether this was its window's active pane when captured.
- asJava property The Java pane this wraps: the same object, for a Java API that takes one.
- await method Waits until
settledaccepts this pane, read fresh from tmux before each test. - 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.
- Companion module
- copyMode method Puts this pane into copy mode, where its scrollback can be navigated.
- currentPath property The working directory tmux reported for the pane.
- dead method Whether this pane's process has exited, read fresh rather than from the capture.
- edges property Which sides of its window the pane touches.
- equals method
- 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 property Whether this pane floats, or null when the running tmux cannot say.
- hashCode method
- hooks method This pane's own hooks.
- id property The pane's stable id.
- index property The pane's position, which shifts as neighbours come and go.
- joinTo method Moves this pane into another window, splitting it.
- kill method Closes this pane.
- 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.
- pid property The process id of the program running in the pane, captured at the time of the read.
- pipeTo method Sends everything this pane prints to a shell command, until
.stopPiping. - position property 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.
- run method Runs a shell command in this pane to its end, and answers with its exit status and output.
- 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 property 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 property The pane title, which a program running inside it can change.
- toString method
- variables method Reads validated tmux variables in this pane's format context.