Pane

struct Pane : struct Pane

struct [source] ¶

struct [source] ¶

struct Pane

Bases:

• Copyable
• Decodable
• Encodable
• Equatable
• Filterable
• Hashable
• Identifiable
• Sendable
• SendableMetatype

A tmux pane, as it was when the listing was read.

A pane belongs to one window; session membership runs through WindowLink .

Discussed in Architecture , Traversal

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.Pane
• .NET LibTmux.Pane
• C++ libtmux::Pane

Members

• id property tmux's own pane id — %0, %1.
• index property Position within its window, renumbered as panes come and go.
• height property The height tmux is drawing this pane at, in cells.
• width property The width tmux is drawing this pane at, in cells.
• isActive property The pane a command reaches when it names the window and stops there.
• currentCommand property The command tmux believes is running. It reflects the foreground process, so it changes as the user works.
• currentPath property The working directory of the process in the pane, which follows the user around rather than staying where the pane was created.
• windowID property The window this pane is in. Panes move between windows, so this is where it is now rather than where it started.
• isAtTop property Whether the pane reaches its window's top edge. A pane can be against more than one edge, and a lone pane is against all four.
• isAtBottom property Whether the pane reaches its window's bottom edge.
• isAtLeft property Whether the pane reaches its window's left edge.
• isAtRight property Whether the pane reaches its window's right edge.
• filterFieldID(for:) method The stable wire id for a key path, or nil if the property is not filterable.
• filterFieldType(_:) method The value kind an id names, or nil when this model does not know it.
• filterFormatField(_:) method The tmux format field an id reads, or nil when it has no single one.
• filterValue(_:of:) method Reads the field an id names, or nil if this model has no such field.
• incarnation property The daemon this value was read from.
• init(id:index:width:height:isActive:isDead:isInputOff:modeCount:isSynchronized:currentCommand:currentPath:isAtTop:isAtBottom:isAtLeft:isAtRight:windowID:incarnation:) method
• isDead property Whether the pane's configured process has exited.
• isInputOff property Whether tmux has disabled input to the pane.
• isSynchronized property Whether input to this pane participates in synchronized-pane delivery.
• modeCount property The number of human-client modes stacked on the pane.