class libtmux-dotnet latest
Pane
Represents an immutable pane handle and snapshot.
Source and package
-
Description#
Thread-safe: the handle is immutable once constructed and may be shared freely, including as a singleton. Every mutating call answers a new handle rather than changing this one.
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 - Java
io.github.libtmux.Pane - C++
libtmux::Pane - Swift
Pane - Kotlin
io.github.libtmux.kotlin.Pane - Scala
io.github.libtmux.scaladsl.Pane - F# No source-verified F# equivalent is recorded for this operation.
- Python
Members74 members#
Parent objects3 members#
Common operations45 members#
- CaptureAsync method Reads the pane's contents.
- SendKeysAsync method Sends keys to the pane.
- SplitAsync method Splits this pane.
- RespawnAsync method Restarts the command running in this pane.
- KillAsync method Stops this pane.
- SelectAsync method Selects this pane.
- BreakAsync method Moves this pane out into a window of its own.
- ClearHistoryAsync method Drops the pane's scrollback history.
- SetTitleAsync method Sets this pane's title.
- PasteBufferAsync method Pastes a tmux buffer into the pane.
- ResizeAsync method Resizes this pane.
- Options property Gets the options of this pane.
- Id property Gets the pane identifier.
- Index property Gets the index this pane holds in its window.
- SwapAsync method Swaps this pane with another.
- PipeAsync method Pipes the pane's input or output through a command.
- EnterCopyModeAsync method Puts the pane into copy mode.
- Hooks property Gets the hooks of this pane.
- Height property Gets the pane height captured with this handle.
- Width property Gets the pane width captured with this handle.
- Title property Gets the pane title captured with this handle.
- JoinAsync method Joins this pane into another window.
- RefreshAsync method Re-reads this pane from tmux.
- AtTop property Gets whether the pane touches the top of its window.
- AtBottom property Gets whether the pane touches the bottom of its window.
- AtLeft property Gets whether the pane touches the left of its window.
- AtRight property Gets whether the pane touches the right of its window.
- DisplayMessageAsync method Shows a message on the client viewing this pane.
- MoveAsync method Moves this pane to another position.
- SendPrefixAsync method Sends the configured prefix key to the pane.
- SetHeightAsync method Sets this pane's height.
- SetWidthAsync method Sets this pane's width.
- EnterClockModeAsync method Puts the pane into clock mode.
- EnterCustomizeModeAsync method Puts the pane into customize mode.
- ChooseTreeAsync method Opens the session tree chooser in this pane.
- ChooseBufferAsync method Opens the buffer chooser in this pane.
- FindWindowAsync method Opens the window finder in this pane.
- DisplayPopupAsync method Shows a popup over the client viewing this pane.
- ChooseClientAsync method Opens the client chooser in this pane.
- ClearAsync method Clears the pane by running the shell's reset.
- ResetAsync method Resets the pane's terminal state and drops its history.
- EnterAsync method Presses Enter in the pane.
- SendTextAsync method Types text into the pane.
- Equals method
- FromEnvironmentAsync method Returns the pane this process was spawned in.
Other members26 members#
- Active property Gets whether the pane is its window's active pane.
- CaptureToBufferAsync method Captures the pane's contents into a tmux buffer.
- CreatePaneAsync method Creates a floating pane against this one.
- CurrentCommand property Gets the foreground command captured with this pane.
- CurrentPath property Gets the current working directory captured with this pane.
- Dead property Gets whether the pane's program has exited and the pane remains.
- DeadStatus property Gets the exit status of a dead pane's program.
- DisplayPaneNumbersAsync method Shows the pane numbers on every client.
- ExecuteCommandAsync method Executes one raw tmux command against this pane.
- Generation property Gets the server generation captured with this pane.
- GetHashCode method
- HistorySize property Gets how many lines have scrolled into the pane's history.
- InMode property Gets whether the pane is in a mode, such as copy mode.
- Left property Gets the pane's left offset, in cells, from its window's edge.
- ProcessId property Gets the process ID of the program the pane started.
- RawFormatFields property Gets the tmux fields captured when this handle materialized.
- ReadOutputSinceAsync method Reads what the pane has printed since a position, and where this read finished.
- RunAsync method Runs a shell command in the pane and waits for its exit status.
- SendKeysAndWaitAsync method Sends keys to the pane and waits for what it prints in response.
- SendTextAndWaitAsync method Types a line, presses Enter, and waits for a later line to contain the text.
- StartCommand property Gets the command the pane started, as tmux prints it, or empty for the default shell.
- Synchronized property Gets whether keys typed into the pane go to every synchronized pane in its window.
- Top property Gets the pane's top offset, in cells, from its window's edge.
- Tty property Gets the terminal device the pane's program reads and writes, such as
/dev/pts/3. - WaitForTextAsync method Waits until the pane shows literal text.
- WaitUntilAsync method Waits until a condition holds over the rows the pane shows.