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

Window

Captured window entity

Base types LibTmux::Entity
Source and package
Qualified name
LibTmux::Window
Module
LibTmux
Package
LibTmux
Source
packages/core/lib/LibTmux/Window.pm
Other languages
Erlangstruct PowerShellcmdlet Juliastruct Elixirstruct Haskell Common Lispclass PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaOCamltypealias F#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.

Members8#

Collections and queries1#

Common operations6#

  • id method string. Local captured data; no I/O.
  • name method string. Local captured data; no I/O.
  • height method integer. Local captured data; no I/O.
  • width method integer. Local captured data; no I/O.
  • layout method string. Local captured data; no I/O.
  • active_pane method LibTmux::Pane entity or undef. Local captured data; no I/O.

Other members1#

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 window

Equivalents of A tmux window in other languages
Language Equivalent
Python libtmux.Window
Ruby LibTmux::Window
Lua libtmux.Window
PowerShell LibTmux\Get-TmuxWindow This cmdlet reads shared .NET LibTmux.Window placements. Use -Server for all sessions or -Session for one session.
Julia LibTmux.WindowSnapshot WindowSnapshot holds captured physical-window data. WindowLink records a placement in a session; actions use WindowRef.
Erlang #tmux_model:window{} A physical window can have several session memberships. window_link holds the session-relative index and active flag.
Elixir LibTmux.Window Window is a physical window. WindowLink records its session index and active state.
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Common Lisp libtmux:window window is a physical captured window. window-link preserves each session placement.
TypeScript window.Window
Rust window.Window
Go tmux.Window
Java io.github.libtmux.Window
Clojure libtmux.data/windows Traverses captured window-placement maps without I/O; the window value is a map with an explicit Java reference for effects.
Kotlin io.github.libtmux.kotlin.Window
Scala io.github.libtmux.scaladsl.Window
C# LibTmux.Window
F# LibTmux.FSharp.Window This F# module identifies shared .NET LibTmux.Window placements and builds deferred pane queries. Query.list acquires their results from tmux.
C++ libtmux::Window
Swift Window
OCaml Libtmux.Window.t A global window can have several session placements. Window_link holds the session, index and current flag.
Esc

Type to search.

Reference previewOpen reference