tmux.PaneOptionValues

struct tmux.PaneOptionValues

struct [source] ¶

struct [source] ¶

struct tmux.PaneOptionValues

PaneOptionValues is an immutable materialized view of known pane option values; its zero value is empty and it does not refresh. Obtain it with Pane.Options . OptionValue.Get reports presence and OptionValue.Origin reports inheritance. Use Pane.RawOption for caller-named or undecoded values.

Members

• AllowPassthrough method AllowPassthrough returns materialized "allow-passthrough" as OptionValue with value type OptionValue AllowPassthrough from pane option values; it does not query tmux. Available as FLAG since tmux 3.3; CHOICE since tmux 3.4 (choices: "off", "on", "all"); set it with Pane.SetAllowPassthrough .
• AllowRename method AllowRename returns materialized "allow-rename" as OptionValue with value type OptionValuebool from pane option values; it does not query tmux. Available as FLAG since tmux 3.2a; set it with Pane.SetAllowRename .
• AllowSetTitle method AllowSetTitle returns materialized "allow-set-title" as OptionValue with value type OptionValuebool from pane option values; it does not query tmux. Available as FLAG since tmux 3.5; set it with Pane.SetAllowSetTitle .
• AlternateScreen method AlternateScreen returns materialized "alternate-screen" as OptionValue with value type OptionValuebool from pane option values; it does not query tmux. Available as FLAG since tmux 3.2a; set it with Pane.SetAlternateScreen .
• CopyModePositionFormat method CopyModePositionFormat returns materialized "copy-mode-position-format" as OptionValue with value type OptionValuestring from pane option values; it does not query tmux. Available as STRING since tmux 3.6; set it with Pane.SetCopyModePositionFormat .
• CursorColour method CursorColour returns materialized "cursor-colour" as OptionValue with value type OptionValuestring from pane option values; it does not query tmux. Available as COLOUR since tmux 3.3; set it with Pane.SetCursorColour .
• CursorStyle method CursorStyle returns materialized "cursor-style" as OptionValue with value type OptionValue CursorStyle from pane option values; it does not query tmux. Available as CHOICE since tmux 3.3 (choices: "default", "blinking-block", "block", "blinking-underline", "underline", "blinking-bar", "bar"); set it with Pane.SetCursorStyle .
• PaneActiveBorderStyle method PaneActiveBorderStyle returns materialized "pane-active-border-style" as OptionValue with value type OptionValuestring from pane option values; it does not query tmux. Available as STRING since tmux 3.7; set it with Pane.SetPaneActiveBorderStyle . It is a style option.
• PaneBorderFormat method PaneBorderFormat returns materialized "pane-border-format" as OptionValue with value type OptionValuestring from pane option values; it does not query tmux. Available as STRING since tmux 3.3; set it with Pane.SetPaneBorderFormat .
• PaneBorderStyle method PaneBorderStyle returns materialized "pane-border-style" as OptionValue with value type OptionValuestring from pane option values; it does not query tmux. Available as STRING since tmux 3.7; set it with Pane.SetPaneBorderStyle . It is a style option.
• PaneColours method PaneColours returns materialized "pane-colours" as OptionValue with value type OptionValue[SparseArraystring] from pane option values; it does not query tmux. Available as COLOUR since tmux 3.3; set it with Pane.SetPaneColours . Its present SparseArray value preserves assigned tmux indexes, including gaps.
• PaneScrollbarsStyle method PaneScrollbarsStyle returns materialized "pane-scrollbars-style" as OptionValue with value type OptionValuestring from pane option values; it does not query tmux. Available as STRING since tmux 3.6; set it with Pane.SetPaneScrollbarsStyle . It is a style option.
• RemainOnExit method RemainOnExit returns materialized "remain-on-exit" as OptionValue with value type OptionValue RemainOnExit from pane option values; it does not query tmux. Available as CHOICE since tmux 3.2a (choices: "off", "on", "failed"); CHOICE since tmux 3.7 (choices: "off", "on", "failed", "key"); set it with Pane.SetRemainOnExit .
• RemainOnExitFormat method RemainOnExitFormat returns materialized "remain-on-exit-format" as OptionValue with value type OptionValuestring from pane option values; it does not query tmux. Available as STRING since tmux 3.3; set it with Pane.SetRemainOnExitFormat .
• ScrollOnClear method ScrollOnClear returns materialized "scroll-on-clear" as OptionValue with value type OptionValuebool from pane option values; it does not query tmux. Available as FLAG since tmux 3.3; set it with Pane.SetScrollOnClear .
• SynchronizePanes method SynchronizePanes returns materialized "synchronize-panes" as OptionValue with value type OptionValuebool from pane option values; it does not query tmux. Available as FLAG since tmux 3.2a; set it with Pane.SetSynchronizePanes .
• TreeModePreviewFormat method TreeModePreviewFormat returns materialized "tree-mode-preview-format" as OptionValue with value type OptionValuestring from pane option values; it does not query tmux. Available as STRING since tmux 3.7; set it with Pane.SetTreeModePreviewFormat .
• WindowActiveStyle method WindowActiveStyle returns materialized "window-active-style" as OptionValue with value type OptionValuestring from pane option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Pane.SetWindowActiveStyle . It is a style option.
• WindowStyle method WindowStyle returns materialized "window-style" as OptionValue with value type OptionValuestring from pane option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Pane.SetWindowStyle . It is a style option.