Workspace ManagerAPI Reference

Choose documentation 3

latest

Current version

latest
English

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

LibTmux.Workspace.WorkspaceActionKind

API reference · Markdown

enum LibTmux.Workspace.WorkspaceActionKind
enum [source]

Names one ordered workspace operation.

Members

CreateSession

CreateSession
constant [source]

Creates a session with a temporary bootstrap window.

CaptureBootstrap

CaptureBootstrap
constant [source]

Reads the sole bootstrap window created with a session.

RemoveSession

RemoveSession
constant [source]

Removes the exact session selected during planning.

CreateWindow

CreateWindow
constant [source]

Creates a window in the selected session.

CaptureFirstPane

CaptureFirstPane
constant [source]

Reads the first pane of a newly created window.

SplitPane

SplitPane
constant [source]

Creates another pane by splitting a known pane.

SetOption

SetOption
constant [source]

Sets a session, window or pane option.

UnlinkWindow

UnlinkWindow
constant [source]

Removes a captured placement, destroying the window only when no other links remain.

MoveToBaseIndex

MoveToBaseIndex
constant [source]

Moves the first workspace window to the session's effective base index.

SendText

SendText
constant [source]

Sends literal command text, followed by Enter when requested.

SelectLayout

SelectLayout
constant [source]

Applies a layout to the created panes.

SelectPane

SelectPane
constant [source]

Selects a pane by its created identity.

SelectWindow

SelectWindow
constant [source]

Selects a window by its created placement.

OpenReadinessChannel

OpenReadinessChannel
constant [source]

Opens a unique cooperative readiness channel before pane startup.

WaitForReadiness

WaitForReadiness
constant [source]

Waits for the pane's startup program to signal its channel.

CloseReadinessChannel

CloseReadinessChannel
constant [source]

Closes the owned readiness channel.

ReuseSession

ReuseSession
constant [source]

Returns the exact existing session without mutation.

RunHostScript

RunHostScript
constant [source]

Runs an allowed host script from the resolved session directory, or from the document directory when no session directory is declared.

CaptureResult

CaptureResult
constant [source]

Captures the final session and created placements in a server-wide pane snapshot.

ArrangePanes

ArrangePanes
constant [source]

Arranges existing panes to make space for the next split; failure stops application.

MoveToWindowIndex

MoveToWindowIndex
constant [source]

Moves the first workspace window to its declared session-relative index.

Esc

Type to search.