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

WindowPlan

Swift
  • Python Unavailable
  • Ruby Unavailable
  • Lua Unavailable
  • TypeScript Unavailable
  • Rust Unavailable
  • Go Unavailable
  • Java Unavailable
  • .NET Unavailable
  • C++ Unavailable
  • Swift

API reference · Markdown

struct WindowPlan : struct WindowPlan
struct [source]
struct [source]
struct WindowPlan

One window, and the panes in it.

Discussed in Swift workspace builder behavior , Swift workspace builder API

Members

!=(_:_:)

!=(_:_:) ( lhs : Self , rhs : Self ) → Bool
functionstatic
functionstatic
!=(_:_:)

Inherited from Equatable.!=(_:_:)

Returns a Boolean value indicating whether two values are not equal.

Inequality is the inverse of equality. For any values a and b, a != b implies that a == b is false.

This is the default implementation of the not-equal-to operator (!=) for any type that conforms to Equatable.

  • Parameters:
    • lhs: A value to compare.
    • rhs: Another value to compare.

windowName

windowName : let windowName: String?
property [source]
property [source]
windowName

What to call it. Left out, tmux names it after what runs in it.

startDirectory

startDirectory : let startDirectory: String?
property [source]
property [source]
startDirectory

Where this window's panes start, overriding the workspace's own.

layout

layout : let layout: String?
property [source]
property [source]
layout

tmux's own layout name — even-horizontal, tiled, and the rest — applied after the panes exist.

panes

panes : let panes: [PanePlan]
property [source]
property [source]
panes

The panes to open. The first is the window itself; each one after it splits what is already there.

init(windowName:startDirectory:layout:panes:)

init(windowName:startDirectory:layout:panes:) ( windowName : String? , startDirectory : String? , layout : String? , panes : [PanePlan] )
method [source]
method [source]
init(windowName:startDirectory:layout:panes:)

init(from:)

init(from:) ( from : any Decoder )
method
method
init(from:)

Inherited from Decodable.init(from:)

Creates a new instance by decoding from the given decoder.

This initializer throws an error if reading from the decoder fails, or if the data read is corrupted or otherwise invalid.

  • Parameter decoder: The decoder to read data from.
Esc

Type to search.