tmux.GlobalWindowScope

struct tmux.GlobalWindowScope

struct [source] ¶

struct [source] ¶

struct tmux.GlobalWindowScope

GlobalWindowScope is an immutable handle for global window options and hooks. Its zero value is invalid because it contains a zero Server .

Members

• AppendHook method AppendHook appends a command to a global window hook without refreshing models. Completed failures are secret-safe option errors; cancellation does not prove tmux did not accept the append.
• AppendOption method AppendOption appends to a global window option without refreshing models. Completed failures are secret-safe option errors; cancellation does not prove the append was not accepted.
• Hooks method Hooks returns a freshly decoded, caller-owned view of known global window hooks, including defaults. A read failure is returned rather than answered with zero values; context errors propagate.
• Options method Options returns a freshly decoded, caller-owned view of known global window options, including defaults. A read failure is returned rather than answered with zero values; context errors propagate. Each returned accessor names the setter that writes it, so WindowOptionValues.MainPaneWidth pairs with GlobalWindowScope.SetMainPaneWidth .
• RawHook method RawHook returns one exact global window-hook value. A successful string is caller-owned; ok reports presence and completed failures are returned. An unindexed empty hook array is ambiguous; use Hooks for typed presence.
• RawOption method RawOption returns one exact global window-option value. A successful string is caller-owned, and ok reports presence. An unindexed empty array is indistinguishable from an empty scalar; use Options for typed array presence.
• RunHook method RunHook asks tmux to run one global window hook directly. It targets global window scope rather than a receiver, returns secret-safe option errors for completed failures, and cancellation does not prove hook delivery or execution did not occur.
• SetAggressiveResize method SetAggressiveResize stores the "aggressive-resize" window option as bool (tmux 3.2a or later). Read it with WindowOptionValues.AggressiveResize from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetAllowPassthrough method SetAllowPassthrough stores the "allow-passthrough" window option as AllowPassthrough (tmux 3.3 or later). Read it with WindowOptionValues.AllowPassthrough from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetAllowRename method SetAllowRename stores the "allow-rename" window option as bool (tmux 3.2a or later). Read it with WindowOptionValues.AllowRename from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetAllowSetTitle method SetAllowSetTitle stores the "allow-set-title" window option as bool (tmux 3.5 or later). Read it with WindowOptionValues.AllowSetTitle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetAlternateScreen method SetAlternateScreen stores the "alternate-screen" window option as bool (tmux 3.2a or later). Read it with WindowOptionValues.AlternateScreen from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetAutomaticRename method SetAutomaticRename stores the "automatic-rename" window option as bool (tmux 3.2a or later). Read it with WindowOptionValues.AutomaticRename from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetAutomaticRenameFormat method SetAutomaticRenameFormat stores the "automatic-rename-format" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.AutomaticRenameFormat from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetClockModeColour method SetClockModeColour stores the "clock-mode-colour" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.ClockModeColour from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetClockModeStyle method SetClockModeStyle stores the "clock-mode-style" window option as ClockModeStyle (tmux 3.2a or later). Read it with WindowOptionValues.ClockModeStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetCopyModeCurrentLineNumberStyle method SetCopyModeCurrentLineNumberStyle stores the "copy-mode-current-line-number-style" window option as string (tmux 3.7 or later). Read it with WindowOptionValues.CopyModeCurrentLineNumberStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetCopyModeCurrentMatchStyle method SetCopyModeCurrentMatchStyle stores the "copy-mode-current-match-style" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.CopyModeCurrentMatchStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetCopyModeLineNumbers method SetCopyModeLineNumbers stores the "copy-mode-line-numbers" window option as CopyModeLineNumbers (tmux 3.7 or later). Read it with WindowOptionValues.CopyModeLineNumbers from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetCopyModeLineNumberStyle method SetCopyModeLineNumberStyle stores the "copy-mode-line-number-style" window option as string (tmux 3.7 or later). Read it with WindowOptionValues.CopyModeLineNumberStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetCopyModeMarkStyle method SetCopyModeMarkStyle stores the "copy-mode-mark-style" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.CopyModeMarkStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetCopyModeMatchStyle method SetCopyModeMatchStyle stores the "copy-mode-match-style" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.CopyModeMatchStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetCopyModePositionFormat method SetCopyModePositionFormat stores the "copy-mode-position-format" window option as string (tmux 3.6 or later). Read it with WindowOptionValues.CopyModePositionFormat from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetCopyModePositionStyle method SetCopyModePositionStyle stores the "copy-mode-position-style" window option as string (tmux 3.6 or later). Read it with WindowOptionValues.CopyModePositionStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetCopyModeSelectionStyle method SetCopyModeSelectionStyle stores the "copy-mode-selection-style" window option as string (tmux 3.6 or later). Read it with WindowOptionValues.CopyModeSelectionStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetCursorColour method SetCursorColour stores the "cursor-colour" window option as string (tmux 3.3 or later). Read it with WindowOptionValues.CursorColour from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetCursorStyle method SetCursorStyle stores the "cursor-style" window option as CursorStyle (tmux 3.3 or later). Read it with WindowOptionValues.CursorStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetFillCharacter method SetFillCharacter stores the "fill-character" window option as string (tmux 3.3 or later). Read it with WindowOptionValues.FillCharacter from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetHook method SetHook stores a global window hook without refreshing models. Completed failures are secret-safe option errors; cancellation does not prove tmux did not accept the mutation.
• SetHooks method SetHooks applies indexed global window-hook commands in ascending order. With ClearExisting it confirms clearing before applying sparse Values, stops at the first failure without rollback, and reports confirmed progress. Cancellation may follow accepted commands and cannot disprove their delivery.
• SetMainPaneHeight method SetMainPaneHeight stores the "main-pane-height" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.MainPaneHeight from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetMainPaneWidth method SetMainPaneWidth stores the "main-pane-width" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.MainPaneWidth from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetMenuBorderLines method SetMenuBorderLines stores the "menu-border-lines" window option as MenuBorderLines (tmux 3.4 or later). Read it with WindowOptionValues.MenuBorderLines from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetMenuBorderStyle method SetMenuBorderStyle stores the "menu-border-style" window option as string (tmux 3.4 or later). Read it with WindowOptionValues.MenuBorderStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetMenuSelectedStyle method SetMenuSelectedStyle stores the "menu-selected-style" window option as string (tmux 3.4 or later). Read it with WindowOptionValues.MenuSelectedStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetMenuStyle method SetMenuStyle stores the "menu-style" window option as string (tmux 3.4 or later). Read it with WindowOptionValues.MenuStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetModeKeys method SetModeKeys stores the "mode-keys" window option as ModeKeys (tmux 3.2a or later). Read it with WindowOptionValues.ModeKeys from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetModeStyle method SetModeStyle stores the "mode-style" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.ModeStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetMonitorActivity method SetMonitorActivity stores the "monitor-activity" window option as bool (tmux 3.2a or later). Read it with WindowOptionValues.MonitorActivity from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetMonitorBell method SetMonitorBell stores the "monitor-bell" window option as bool (tmux 3.2a or later). Read it with WindowOptionValues.MonitorBell from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetMonitorSilence method SetMonitorSilence stores the "monitor-silence" window option as int64 (tmux 3.2a or later). Read it with WindowOptionValues.MonitorSilence from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetOption method SetOption stores a global window option without refreshing existing models. Completed failures are secret-safe option errors; cancellation does not prove tmux did not accept the mutation.
• SetOtherPaneHeight method SetOtherPaneHeight stores the "other-pane-height" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.OtherPaneHeight from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetOtherPaneWidth method SetOtherPaneWidth stores the "other-pane-width" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.OtherPaneWidth from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetPaneActiveBorderStyle method SetPaneActiveBorderStyle stores the "pane-active-border-style" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.PaneActiveBorderStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetPaneBaseIndex method SetPaneBaseIndex stores the "pane-base-index" window option as int64 (tmux 3.2a or later). Read it with WindowOptionValues.PaneBaseIndex from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetPaneBorderFormat method SetPaneBorderFormat stores the "pane-border-format" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.PaneBorderFormat from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetPaneBorderIndicators method SetPaneBorderIndicators stores the "pane-border-indicators" window option as PaneBorderIndicators (tmux 3.3 or later). Read it with WindowOptionValues.PaneBorderIndicators from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetPaneBorderLines method SetPaneBorderLines stores the "pane-border-lines" window option as PaneBorderLines (tmux 3.2a or later). Read it with WindowOptionValues.PaneBorderLines from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetPaneBorderStatus method SetPaneBorderStatus stores the "pane-border-status" window option as PaneBorderStatus (tmux 3.2a or later). Read it with WindowOptionValues.PaneBorderStatus from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetPaneBorderStyle method SetPaneBorderStyle stores the "pane-border-style" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.PaneBorderStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetPaneColours method SetPaneColours replaces the complete "pane-colours" window option array with SparseArraystring, preserving holes and empty values (tmux 3.3 or later). Read it with WindowOptionValues.PaneColours from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default. Replacement is not atomic: the result reports confirmed writes, and failures stop without rollback. Serialize concurrent replacement of the same target and option.
• SetPaneScrollbars method SetPaneScrollbars stores the "pane-scrollbars" window option as PaneScrollbars (tmux 3.6 or later). Read it with WindowOptionValues.PaneScrollbars from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetPaneScrollbarsPosition method SetPaneScrollbarsPosition stores the "pane-scrollbars-position" window option as PaneScrollbarsPosition (tmux 3.6 or later). Read it with WindowOptionValues.PaneScrollbarsPosition from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetPaneScrollbarsStyle method SetPaneScrollbarsStyle stores the "pane-scrollbars-style" window option as string (tmux 3.6 or later). Read it with WindowOptionValues.PaneScrollbarsStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetPaneStatusCurrentStyle method SetPaneStatusCurrentStyle stores the "pane-status-current-style" window option as string (tmux 3.6 or later). Read it with WindowOptionValues.PaneStatusCurrentStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetPaneStatusStyle method SetPaneStatusStyle stores the "pane-status-style" window option as string (tmux 3.6 or later). Read it with WindowOptionValues.PaneStatusStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetPopupBorderLines method SetPopupBorderLines stores the "popup-border-lines" window option as PopupBorderLines (tmux 3.3 or later). Read it with WindowOptionValues.PopupBorderLines from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetPopupBorderStyle method SetPopupBorderStyle stores the "popup-border-style" window option as string (tmux 3.3 or later). Read it with WindowOptionValues.PopupBorderStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetPopupStyle method SetPopupStyle stores the "popup-style" window option as string (tmux 3.3 or later). Read it with WindowOptionValues.PopupStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetRemainOnExit method SetRemainOnExit stores the "remain-on-exit" window option as RemainOnExit (tmux 3.2a or later). Read it with WindowOptionValues.RemainOnExit from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetRemainOnExitFormat method SetRemainOnExitFormat stores the "remain-on-exit-format" window option as string (tmux 3.3 or later). Read it with WindowOptionValues.RemainOnExitFormat from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetScrollOnClear method SetScrollOnClear stores the "scroll-on-clear" window option as bool (tmux 3.3 or later). Read it with WindowOptionValues.ScrollOnClear from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetSessionStatusCurrentStyle method SetSessionStatusCurrentStyle stores the "session-status-current-style" window option as string (tmux 3.6 or later). Read it with WindowOptionValues.SessionStatusCurrentStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetSessionStatusStyle method SetSessionStatusStyle stores the "session-status-style" window option as string (tmux 3.6 or later). Read it with WindowOptionValues.SessionStatusStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetSynchronizePanes method SetSynchronizePanes stores the "synchronize-panes" window option as bool (tmux 3.2a or later). Read it with WindowOptionValues.SynchronizePanes from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetTiledLayoutMaxColumns method SetTiledLayoutMaxColumns stores the "tiled-layout-max-columns" window option as int64 (tmux 3.6 or later). Read it with WindowOptionValues.TiledLayoutMaxColumns from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetTreeModePreviewFormat method SetTreeModePreviewFormat stores the "tree-mode-preview-format" window option as string (tmux 3.7 or later). Read it with WindowOptionValues.TreeModePreviewFormat from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetTreeModePreviewStyle method SetTreeModePreviewStyle stores the "tree-mode-preview-style" window option as string (tmux 3.7 or later). Read it with WindowOptionValues.TreeModePreviewStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetWindowActiveStyle method SetWindowActiveStyle stores the "window-active-style" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.WindowActiveStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetWindowPaneCurrentStatusFormat method SetWindowPaneCurrentStatusFormat stores the "window-pane-current-status-format" window option as string (tmux 3.7 or later). Read it with WindowOptionValues.WindowPaneCurrentStatusFormat from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetWindowPaneStatusFormat method SetWindowPaneStatusFormat stores the "window-pane-status-format" window option as string (tmux 3.7 or later). Read it with WindowOptionValues.WindowPaneStatusFormat from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetWindowSize method SetWindowSize stores the "window-size" window option as WindowSize (tmux 3.2a or later). Read it with WindowOptionValues.WindowSize from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetWindowStatusActivityStyle method SetWindowStatusActivityStyle stores the "window-status-activity-style" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.WindowStatusActivityStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetWindowStatusBellStyle method SetWindowStatusBellStyle stores the "window-status-bell-style" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.WindowStatusBellStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetWindowStatusCurrentFormat method SetWindowStatusCurrentFormat stores the "window-status-current-format" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.WindowStatusCurrentFormat from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetWindowStatusCurrentStyle method SetWindowStatusCurrentStyle stores the "window-status-current-style" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.WindowStatusCurrentStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetWindowStatusFormat method SetWindowStatusFormat stores the "window-status-format" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.WindowStatusFormat from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetWindowStatusLastStyle method SetWindowStatusLastStyle stores the "window-status-last-style" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.WindowStatusLastStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetWindowStatusSeparator method SetWindowStatusSeparator stores the "window-status-separator" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.WindowStatusSeparator from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetWindowStatusStyle method SetWindowStatusStyle stores the "window-status-style" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.WindowStatusStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetWindowStyle method SetWindowStyle stores the "window-style" window option as string (tmux 3.2a or later). Read it with WindowOptionValues.WindowStyle from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetWrapSearch method SetWrapSearch stores the "wrap-search" window option as bool (tmux 3.2a or later). Read it with WindowOptionValues.WrapSearch from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• SetXTermKeys method SetXTermKeys stores the "xterm-keys" window option as bool (tmux 3.2a or later). Read it with WindowOptionValues.XTermKeys from GlobalWindowScope.Options ; GlobalWindowScope.UnsetOption restores inheritance or the global default.
• UnsetHook method UnsetHook removes every matching global window-hook index without refreshing models. Completed failures are secret-safe option errors; cancellation does not prove tmux did not accept the unset.
• UnsetOption method UnsetOption unsets a global window option without refreshing models. UnsetPanes is invalid at this scope; cancellation does not prove the unset was not accepted.