Core LibraryAPI Reference

Choose documentation 1

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

class libtmux-kotlin latest

Window

Package io.github.libtmux.kotlin.Window io.github.libtmux.kotlin

A tmux window at a specific position in a session.

View as Markdown

Source and package
Module
io.github.libtmux.kotlin
Package
io.github.libtmux:libtmux-kotlin
Source
libtmux-kotlin/src/main/kotlin/io/github/libtmux/kotlin/Window.kt
Other languages
PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftScala F#
public class Window
class [source]

Description#

Holds the Java handle privately, so a member here always wins over a same-named catalog-generated extension in WindowOperations.kt . Companion hosts the generated query field namespace.

Discussed in Server, session, window, pane · Coroutines and flows , Getting started

In other ports A tmux window

Members38 members#

Parent objects2 members#

  • session property The session this link belongs to. A pure read of the capture.
  • server property

Collections and queries1 member#

  • panes property This link's panes, in tmux's order. A pure read of the capture.

Common operations1 member#

  • split method Splits this window's active pane in half, putting the new one below it.

Other members34 members#

  • active property Whether this was its session's active window when captured.
  • activePane property The pane tmux had active here. A pure read of the capture.
  • applyLayout method Restores an exact arrangement previously read from [.layout()].
  • asJava property The Java window this wraps: the same object, for a Java API that takes one.
  • Companion module
  • context property The winlink this handle addresses.
  • displayPopup method Shows a popup over this window, running a command in it.
  • equals method
  • expand method Expands a tmux format in this window's context, and answers with what it came to.
  • hashCode method
  • hooks method This window's own hooks, which every link to it shares.
  • id property The underlying window, shared by every link to it.
  • index property Where this link sits in its session.
  • kill method Closes this window.
  • layout property tmux's own layout for this window, in whichever form this server writes it.
  • linked property Whether the underlying window is linked into more than one session.
  • linkTo method Links this window into another session, so one window sits in both.
  • moveTo method Moves this window into another session.
  • name property The window name.
  • nextLayout method Moves to the next built-in layout, as tmux's own binding does.
  • options method This window's own options, which every link to it shares.
  • previousLayout method Moves to the previous built-in layout, as tmux's own binding does.
  • refresh method Takes a new capture and returns this winlink as it is now.
  • rename method Renames this window and returns its replacement capture.
  • resizeTo method Resizes this window in terminal cells.
  • respawn method Kills what is running in this window and starts it again.
  • rotate method Rotates the panes within this window.
  • select method Makes this the active window of its session.
  • selectLayout method Rearranges this window's panes into one of tmux's built-in layouts.
  • size property How large the window was when captured, in terminal cells.
  • stopSynchronizingPanes method Stops copying input between this window's panes.
  • synchronizePanes method Copies input to one pane into every pane in this window, until .stopSynchronizingPanes .
  • toString method
  • unlink method Removes this link, leaving the window wherever else it is linked.
Esc

Type to search.