Core LibraryunreleasedAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased LibTmux has not been released. Its API may change during development. This site's structure and URLs may change too.

class libtmux-perl latest

Pane

Captured pane entity

Base types LibTmux::Entity
Source and package
Qualified name
LibTmux::Pane
Module
LibTmux
Package
LibTmux
Source
packages/core/lib/LibTmux/Pane.pm
Other languages
ErlangPowerShellcmdlet Juliastruct Elixirstruct Haskell Common Lispclass PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaOCamlF#module Clojurefunction

Description#

OWNERSHIP

Readers use the retained graph and never refresh it. Acquire a new snapshot for new state. Inherited to_record exports a detached scalar record.

Members13#

Parent objects1#

Common operations11#

  • id method string. Local captured data; no I/O.
  • index method integer. Local captured data; no I/O.
  • height method integer. Local captured data; no I/O.
  • width method integer. Local captured data; no I/O.
  • title method string. Local captured data; no I/O.
  • active method boolean. Local captured data; no I/O.
  • current_command method string. Local captured data; no I/O.
  • current_path method bytes. Local captured data; no I/O.
  • pid method integer. Local captured data; no I/O.
  • dead method boolean. Local captured data; no I/O.
  • cursor_shape method string. Local captured data; no I/O.

Other members1#

  • exit_status method integer or undef. Local captured data; no I/O.

Inherited members5 members#

Reached through LibTmux::Entity.

  • generation method inherited Return the captured generation. Restarted daemons cannot silently reuse this handle.
  • identity method inherited Return an opaque identity key scoped by server, generation, kind, and string ID. It is suitable for local equality; duplicate selection occurrences remain separate occurrences.
  • kind method inherited Return the schema entity-kind string. Concrete public field readers belong to LibTmux::Pane, LibTmux::Window, LibTmux::WindowLink, LibTmux::Session, and LibTmux::Client.
  • server_id method inherited Return the captured server scope. No daemon discovery or refresh occurs.
  • to_record method inherited Return a fresh hash reference of captured scalar fields and adjacency IDs. Editing it does not change the retained graph. Retaining the entity retains its captured graph, with no transport ownership or reference cycle.

In other ports#

A tmux pane

Equivalents of A tmux pane in other languages
Language Equivalent
Python libtmux.Pane
Ruby LibTmux::Pane
Lua libtmux.Pane
PowerShell LibTmux\Get-TmuxPane This cmdlet reads shared .NET LibTmux.Pane objects. Its -Server, -Session, and -Window parameter sets select the scope.
Julia LibTmux.PaneSnapshot PaneSnapshot holds captured pane data. Actions use its PaneRef; PaneOccurrence adds a window placement in a session.
Erlang #tmux_model:pane{}
Elixir LibTmux.Pane Pane is an immutable physical pane observation. It does not send keys or capture text.
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Common Lisp libtmux:pane pane is an immutable captured physical pane.
TypeScript pane.Pane
Rust pane.Pane
Go tmux.Pane
Java io.github.libtmux.Pane
Clojure libtmux.data/panes Traverses captured pane maps without I/O. Use keyword lookup for scalar observations and the preserved :tmux/ref for effects.
Kotlin io.github.libtmux.kotlin.Pane
Scala io.github.libtmux.scaladsl.Pane
C# LibTmux.Pane
F# LibTmux.FSharp.Pane This F# module reads captured fields and starts explicit operations on the shared .NET LibTmux.Pane type.
C++ libtmux::Pane
Swift Pane
OCaml Libtmux.Pane.t
Esc

Type to search.

Reference previewOpen reference