tmux.WindowOptionValues

struct tmux.WindowOptionValues

struct [source] ¶

struct [source] ¶

struct tmux.WindowOptionValues

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

Members

• AggressiveResize method AggressiveResize returns materialized "aggressive-resize" as OptionValue with value type OptionValuebool from window option values; it does not query tmux. Available as FLAG since tmux 3.2a; set it with Window.SetAggressiveResize or GlobalWindowScope.SetAggressiveResize .
• AllowPassthrough method AllowPassthrough returns materialized "allow-passthrough" as OptionValue with value type OptionValue AllowPassthrough from window 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 Window.SetAllowPassthrough or GlobalWindowScope.SetAllowPassthrough .
• AllowRename method AllowRename returns materialized "allow-rename" as OptionValue with value type OptionValuebool from window option values; it does not query tmux. Available as FLAG since tmux 3.2a; set it with Window.SetAllowRename or GlobalWindowScope.SetAllowRename .
• AllowSetTitle method AllowSetTitle returns materialized "allow-set-title" as OptionValue with value type OptionValuebool from window option values; it does not query tmux. Available as FLAG since tmux 3.5; set it with Window.SetAllowSetTitle or GlobalWindowScope.SetAllowSetTitle .
• AlternateScreen method AlternateScreen returns materialized "alternate-screen" as OptionValue with value type OptionValuebool from window option values; it does not query tmux. Available as FLAG since tmux 3.2a; set it with Window.SetAlternateScreen or GlobalWindowScope.SetAlternateScreen .
• AutomaticRename method AutomaticRename returns materialized "automatic-rename" as OptionValue with value type OptionValuebool from window option values; it does not query tmux. Available as FLAG since tmux 3.2a; set it with Window.SetAutomaticRename or GlobalWindowScope.SetAutomaticRename .
• AutomaticRenameFormat method AutomaticRenameFormat returns materialized "automatic-rename-format" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetAutomaticRenameFormat or GlobalWindowScope.SetAutomaticRenameFormat .
• ClockModeColour method ClockModeColour returns materialized "clock-mode-colour" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as COLOUR since tmux 3.2a; set it with Window.SetClockModeColour or GlobalWindowScope.SetClockModeColour .
• ClockModeStyle method ClockModeStyle returns materialized "clock-mode-style" as OptionValue with value type OptionValue ClockModeStyle from window option values; it does not query tmux. Available as CHOICE since tmux 3.2a (choices: "12", "24"); CHOICE since tmux 3.6 (choices: "12", "24", "12-with-seconds", "24-with-seconds"); set it with Window.SetClockModeStyle or GlobalWindowScope.SetClockModeStyle .
• CopyModeCurrentLineNumberStyle method CopyModeCurrentLineNumberStyle returns materialized "copy-mode-current-line-number-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.7; set it with Window.SetCopyModeCurrentLineNumberStyle or GlobalWindowScope.SetCopyModeCurrentLineNumberStyle . It is a style option.
• CopyModeCurrentMatchStyle method CopyModeCurrentMatchStyle returns materialized "copy-mode-current-match-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetCopyModeCurrentMatchStyle or GlobalWindowScope.SetCopyModeCurrentMatchStyle . It is a style option.
• CopyModeLineNumbers method CopyModeLineNumbers returns materialized "copy-mode-line-numbers" as OptionValue with value type OptionValue CopyModeLineNumbers from window option values; it does not query tmux. Available as CHOICE since tmux 3.7 (choices: "off", "default", "absolute", "relative", "hybrid"); set it with Window.SetCopyModeLineNumbers or GlobalWindowScope.SetCopyModeLineNumbers .
• CopyModeLineNumberStyle method CopyModeLineNumberStyle returns materialized "copy-mode-line-number-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.7; set it with Window.SetCopyModeLineNumberStyle or GlobalWindowScope.SetCopyModeLineNumberStyle . It is a style option.
• CopyModeMarkStyle method CopyModeMarkStyle returns materialized "copy-mode-mark-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetCopyModeMarkStyle or GlobalWindowScope.SetCopyModeMarkStyle . It is a style option.
• CopyModeMatchStyle method CopyModeMatchStyle returns materialized "copy-mode-match-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetCopyModeMatchStyle or GlobalWindowScope.SetCopyModeMatchStyle . It is a style option.
• CopyModePositionFormat method CopyModePositionFormat returns materialized "copy-mode-position-format" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.6; set it with Window.SetCopyModePositionFormat or GlobalWindowScope.SetCopyModePositionFormat .
• CopyModePositionStyle method CopyModePositionStyle returns materialized "copy-mode-position-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.6; set it with Window.SetCopyModePositionStyle or GlobalWindowScope.SetCopyModePositionStyle . It is a style option.
• CopyModeSelectionStyle method CopyModeSelectionStyle returns materialized "copy-mode-selection-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.6; set it with Window.SetCopyModeSelectionStyle or GlobalWindowScope.SetCopyModeSelectionStyle . It is a style option.
• CursorColour method CursorColour returns materialized "cursor-colour" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as COLOUR since tmux 3.3; set it with Window.SetCursorColour or GlobalWindowScope.SetCursorColour .
• CursorStyle method CursorStyle returns materialized "cursor-style" as OptionValue with value type OptionValue CursorStyle from window 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 Window.SetCursorStyle or GlobalWindowScope.SetCursorStyle .
• FillCharacter method FillCharacter returns materialized "fill-character" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.3; set it with Window.SetFillCharacter or GlobalWindowScope.SetFillCharacter .
• MainPaneHeight method MainPaneHeight returns materialized "main-pane-height" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetMainPaneHeight or GlobalWindowScope.SetMainPaneHeight .
• MainPaneWidth method MainPaneWidth returns materialized "main-pane-width" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetMainPaneWidth or GlobalWindowScope.SetMainPaneWidth .
• MenuBorderLines method MenuBorderLines returns materialized "menu-border-lines" as OptionValue with value type OptionValue MenuBorderLines from window option values; it does not query tmux. Available as CHOICE since tmux 3.4 (choices: "single", "double", "heavy", "simple", "rounded", "padded", "none"); set it with Window.SetMenuBorderLines or GlobalWindowScope.SetMenuBorderLines .
• MenuBorderStyle method MenuBorderStyle returns materialized "menu-border-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.4; set it with Window.SetMenuBorderStyle or GlobalWindowScope.SetMenuBorderStyle . It is a style option.
• MenuSelectedStyle method MenuSelectedStyle returns materialized "menu-selected-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.4; set it with Window.SetMenuSelectedStyle or GlobalWindowScope.SetMenuSelectedStyle . It is a style option.
• MenuStyle method MenuStyle returns materialized "menu-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.4; set it with Window.SetMenuStyle or GlobalWindowScope.SetMenuStyle . It is a style option.
• ModeKeys method ModeKeys returns materialized "mode-keys" as OptionValue with value type OptionValue ModeKeys from window option values; it does not query tmux. Available as CHOICE since tmux 3.2a (choices: "emacs", "vi"); set it with Window.SetModeKeys or GlobalWindowScope.SetModeKeys .
• ModeStyle method ModeStyle returns materialized "mode-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetModeStyle or GlobalWindowScope.SetModeStyle . It is a style option.
• MonitorActivity method MonitorActivity returns materialized "monitor-activity" as OptionValue with value type OptionValuebool from window option values; it does not query tmux. Available as FLAG since tmux 3.2a; set it with Window.SetMonitorActivity or GlobalWindowScope.SetMonitorActivity .
• MonitorBell method MonitorBell returns materialized "monitor-bell" as OptionValue with value type OptionValuebool from window option values; it does not query tmux. Available as FLAG since tmux 3.2a; set it with Window.SetMonitorBell or GlobalWindowScope.SetMonitorBell .
• MonitorSilence method MonitorSilence returns materialized "monitor-silence" as OptionValue with value type OptionValueint64 from window option values; it does not query tmux. Available as NUMBER since tmux 3.2a; set it with Window.SetMonitorSilence or GlobalWindowScope.SetMonitorSilence .
• OtherPaneHeight method OtherPaneHeight returns materialized "other-pane-height" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetOtherPaneHeight or GlobalWindowScope.SetOtherPaneHeight .
• OtherPaneWidth method OtherPaneWidth returns materialized "other-pane-width" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetOtherPaneWidth or GlobalWindowScope.SetOtherPaneWidth .
• PaneActiveBorderStyle method PaneActiveBorderStyle returns materialized "pane-active-border-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; STRING since tmux 3.7; set it with Window.SetPaneActiveBorderStyle or GlobalWindowScope.SetPaneActiveBorderStyle . It is a style option.
• PaneBaseIndex method PaneBaseIndex returns materialized "pane-base-index" as OptionValue with value type OptionValueint64 from window option values; it does not query tmux. Available as NUMBER since tmux 3.2a; set it with Window.SetPaneBaseIndex or GlobalWindowScope.SetPaneBaseIndex .
• PaneBorderFormat method PaneBorderFormat returns materialized "pane-border-format" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; STRING since tmux 3.3; set it with Window.SetPaneBorderFormat or GlobalWindowScope.SetPaneBorderFormat .
• PaneBorderIndicators method PaneBorderIndicators returns materialized "pane-border-indicators" as OptionValue with value type OptionValue PaneBorderIndicators from window option values; it does not query tmux. Available as CHOICE since tmux 3.3 (choices: "off", "colour", "arrows", "both"); set it with Window.SetPaneBorderIndicators or GlobalWindowScope.SetPaneBorderIndicators .
• PaneBorderLines method PaneBorderLines returns materialized "pane-border-lines" as OptionValue with value type OptionValue PaneBorderLines from window option values; it does not query tmux. Available as CHOICE since tmux 3.2a (choices: "single", "double", "heavy", "simple", "number"); CHOICE since tmux 3.6 (choices: "single", "double", "heavy", "simple", "number", "spaces"); set it with Window.SetPaneBorderLines or GlobalWindowScope.SetPaneBorderLines .
• PaneBorderStatus method PaneBorderStatus returns materialized "pane-border-status" as OptionValue with value type OptionValue PaneBorderStatus from window option values; it does not query tmux. Available as CHOICE since tmux 3.2a (choices: "off", "top", "bottom"); set it with Window.SetPaneBorderStatus or GlobalWindowScope.SetPaneBorderStatus .
• PaneBorderStyle method PaneBorderStyle returns materialized "pane-border-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; STRING since tmux 3.7; set it with Window.SetPaneBorderStyle or GlobalWindowScope.SetPaneBorderStyle . It is a style option.
• PaneColours method PaneColours returns materialized "pane-colours" as OptionValue with value type OptionValue[SparseArraystring] from window option values; it does not query tmux. Available as COLOUR since tmux 3.3; set it with Window.SetPaneColours or GlobalWindowScope.SetPaneColours . Its present SparseArray value preserves assigned tmux indexes, including gaps.
• PaneScrollbars method PaneScrollbars returns materialized "pane-scrollbars" as OptionValue with value type OptionValue PaneScrollbars from window option values; it does not query tmux. Available as CHOICE since tmux 3.6 (choices: "off", "modal", "on"); set it with Window.SetPaneScrollbars or GlobalWindowScope.SetPaneScrollbars .
• PaneScrollbarsPosition method PaneScrollbarsPosition returns materialized "pane-scrollbars-position" as OptionValue with value type OptionValue PaneScrollbarsPosition from window option values; it does not query tmux. Available as CHOICE since tmux 3.6 (choices: "right", "left"); set it with Window.SetPaneScrollbarsPosition or GlobalWindowScope.SetPaneScrollbarsPosition .
• PaneScrollbarsStyle method PaneScrollbarsStyle returns materialized "pane-scrollbars-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.6; set it with Window.SetPaneScrollbarsStyle or GlobalWindowScope.SetPaneScrollbarsStyle . It is a style option.
• PaneStatusCurrentStyle method PaneStatusCurrentStyle returns materialized "pane-status-current-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.6; set it with Window.SetPaneStatusCurrentStyle or GlobalWindowScope.SetPaneStatusCurrentStyle . It is a style option.
• PaneStatusStyle method PaneStatusStyle returns materialized "pane-status-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.6; set it with Window.SetPaneStatusStyle or GlobalWindowScope.SetPaneStatusStyle . It is a style option.
• PopupBorderLines method PopupBorderLines returns materialized "popup-border-lines" as OptionValue with value type OptionValue PopupBorderLines from window option values; it does not query tmux. Available as CHOICE since tmux 3.3 (choices: "single", "double", "heavy", "simple", "rounded", "padded", "none"); set it with Window.SetPopupBorderLines or GlobalWindowScope.SetPopupBorderLines .
• PopupBorderStyle method PopupBorderStyle returns materialized "popup-border-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.3; set it with Window.SetPopupBorderStyle or GlobalWindowScope.SetPopupBorderStyle . It is a style option.
• PopupStyle method PopupStyle returns materialized "popup-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.3; set it with Window.SetPopupStyle or GlobalWindowScope.SetPopupStyle . It is a style option.
• RemainOnExit method RemainOnExit returns materialized "remain-on-exit" as OptionValue with value type OptionValue RemainOnExit from window 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 Window.SetRemainOnExit or GlobalWindowScope.SetRemainOnExit .
• RemainOnExitFormat method RemainOnExitFormat returns materialized "remain-on-exit-format" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.3; set it with Window.SetRemainOnExitFormat or GlobalWindowScope.SetRemainOnExitFormat .
• ScrollOnClear method ScrollOnClear returns materialized "scroll-on-clear" as OptionValue with value type OptionValuebool from window option values; it does not query tmux. Available as FLAG since tmux 3.3; set it with Window.SetScrollOnClear or GlobalWindowScope.SetScrollOnClear .
• SessionStatusCurrentStyle method SessionStatusCurrentStyle returns materialized "session-status-current-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.6; set it with Window.SetSessionStatusCurrentStyle or GlobalWindowScope.SetSessionStatusCurrentStyle . It is a style option.
• SessionStatusStyle method SessionStatusStyle returns materialized "session-status-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.6; set it with Window.SetSessionStatusStyle or GlobalWindowScope.SetSessionStatusStyle . It is a style option.
• SynchronizePanes method SynchronizePanes returns materialized "synchronize-panes" as OptionValue with value type OptionValuebool from window option values; it does not query tmux. Available as FLAG since tmux 3.2a; set it with Window.SetSynchronizePanes or GlobalWindowScope.SetSynchronizePanes .
• TiledLayoutMaxColumns method TiledLayoutMaxColumns returns materialized "tiled-layout-max-columns" as OptionValue with value type OptionValueint64 from window option values; it does not query tmux. Available as NUMBER since tmux 3.6; set it with Window.SetTiledLayoutMaxColumns or GlobalWindowScope.SetTiledLayoutMaxColumns .
• TreeModePreviewFormat method TreeModePreviewFormat returns materialized "tree-mode-preview-format" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.7; set it with Window.SetTreeModePreviewFormat or GlobalWindowScope.SetTreeModePreviewFormat .
• TreeModePreviewStyle method TreeModePreviewStyle returns materialized "tree-mode-preview-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.7; set it with Window.SetTreeModePreviewStyle or GlobalWindowScope.SetTreeModePreviewStyle . It is a style option.
• WindowActiveStyle method WindowActiveStyle returns materialized "window-active-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetWindowActiveStyle or GlobalWindowScope.SetWindowActiveStyle . It is a style option.
• WindowPaneCurrentStatusFormat method WindowPaneCurrentStatusFormat returns materialized "window-pane-current-status-format" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.7; set it with Window.SetWindowPaneCurrentStatusFormat or GlobalWindowScope.SetWindowPaneCurrentStatusFormat .
• WindowPaneStatusFormat method WindowPaneStatusFormat returns materialized "window-pane-status-format" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.7; set it with Window.SetWindowPaneStatusFormat or GlobalWindowScope.SetWindowPaneStatusFormat .
• WindowSize method WindowSize returns materialized "window-size" as OptionValue with value type OptionValue WindowSize from window option values; it does not query tmux. Available as CHOICE since tmux 3.2a (choices: "largest", "smallest", "manual", "latest"); set it with Window.SetWindowSize or GlobalWindowScope.SetWindowSize .
• WindowStatusActivityStyle method WindowStatusActivityStyle returns materialized "window-status-activity-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetWindowStatusActivityStyle or GlobalWindowScope.SetWindowStatusActivityStyle . It is a style option.
• WindowStatusBellStyle method WindowStatusBellStyle returns materialized "window-status-bell-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetWindowStatusBellStyle or GlobalWindowScope.SetWindowStatusBellStyle . It is a style option.
• WindowStatusCurrentFormat method WindowStatusCurrentFormat returns materialized "window-status-current-format" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetWindowStatusCurrentFormat or GlobalWindowScope.SetWindowStatusCurrentFormat .
• WindowStatusCurrentStyle method WindowStatusCurrentStyle returns materialized "window-status-current-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetWindowStatusCurrentStyle or GlobalWindowScope.SetWindowStatusCurrentStyle . It is a style option.
• WindowStatusFormat method WindowStatusFormat returns materialized "window-status-format" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetWindowStatusFormat or GlobalWindowScope.SetWindowStatusFormat .
• WindowStatusLastStyle method WindowStatusLastStyle returns materialized "window-status-last-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetWindowStatusLastStyle or GlobalWindowScope.SetWindowStatusLastStyle . It is a style option.
• WindowStatusSeparator method WindowStatusSeparator returns materialized "window-status-separator" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetWindowStatusSeparator or GlobalWindowScope.SetWindowStatusSeparator .
• WindowStatusStyle method WindowStatusStyle returns materialized "window-status-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetWindowStatusStyle or GlobalWindowScope.SetWindowStatusStyle . It is a style option.
• WindowStyle method WindowStyle returns materialized "window-style" as OptionValue with value type OptionValuestring from window option values; it does not query tmux. Available as STRING since tmux 3.2a; set it with Window.SetWindowStyle or GlobalWindowScope.SetWindowStyle . It is a style option.
• WrapSearch method WrapSearch returns materialized "wrap-search" as OptionValue with value type OptionValuebool from window option values; it does not query tmux. Available as FLAG since tmux 3.2a; set it with Window.SetWrapSearch or GlobalWindowScope.SetWrapSearch .
• XTermKeys method XTermKeys returns materialized "xterm-keys" as OptionValue with value type OptionValuebool from window option values; it does not query tmux. Available as FLAG since tmux 3.2a; set it with Window.SetXTermKeys or GlobalWindowScope.SetXTermKeys .