FormatValues
FormatValues is a read-only view of format expansions materialized with a Session, Window, Pane, or Client. Its methods do not query tmux. Projected cross-scope fields do not imply that the referenced record was materialized.
Source and package
- Qualified name
-
tmux.Format Values - Package
- tmux
- Distribution
- github.com/libtmux/libtmux-go/tmux
- Source
- tmux/format.go
-
Description#
Typed accessors return ok == false for an absent, empty, or malformed value;
FormatValues.Rawdistinguishes absent from present empty expansions. The zero value reports every field as absent.
Members196#
- ActiveWindowIndex method ActiveWindowIndex returns tmux #{active_window_index} as int from materialized session-scoped fields.
- AlternateOn method AlternateOn returns tmux #{alternate_on} as bool from materialized pane-scoped fields.
- AlternateSavedX method AlternateSavedX returns tmux #{alternate_saved_x} as int from materialized pane-scoped fields.
- AlternateSavedY method AlternateSavedY returns tmux #{alternate_saved_y} as int from materialized pane-scoped fields.
- BracketPasteFlag method BracketPasteFlag returns tmux #{bracket_paste_flag} as bool from materialized pane-scoped fields (tmux 3.7 or later).
- BufferModeFormat method BufferModeFormat returns tmux #{buffer_mode_format} as string from materialized universal-scoped fields.
- ClientActivity method ClientActivity returns tmux #{client_activity} as time.Time from materialized client-scoped fields.
- ClientCellHeight method ClientCellHeight returns tmux #{client_cell_height} as int from materialized client-scoped fields.
- ClientCellWidth method ClientCellWidth returns tmux #{client_cell_width} as int from materialized client-scoped fields.
- ClientControlMode method ClientControlMode returns tmux #{client_control_mode} as bool from materialized client-scoped fields.
- ClientCreated method ClientCreated returns tmux #{client_created} as time.Time from materialized client-scoped fields.
- ClientDiscarded method ClientDiscarded returns tmux #{client_discarded} as int from materialized client-scoped fields.
- ClientFlags method ClientFlags returns tmux #{client_flags} as string from materialized client-scoped fields.
- ClientHeight method ClientHeight returns tmux #{client_height} as int from materialized client-scoped fields.
- ClientKeyTable method ClientKeyTable returns tmux #{client_key_table} as string from materialized client-scoped fields.
- ClientLastSession method ClientLastSession returns tmux #{client_last_session} as string from materialized client-scoped fields.
- ClientModeFormat method ClientModeFormat returns tmux #{client_mode_format} as string from materialized client-scoped fields.
- ClientName method ClientName returns tmux #{client_name} as ClientName from materialized client-scoped fields.
- ClientPID method ClientPID returns tmux #{client_pid} as int from materialized client-scoped fields.
- ClientPrefix method ClientPrefix returns tmux #{client_prefix} as bool from materialized client-scoped fields.
- ClientReadOnly method ClientReadOnly returns tmux #{client_readonly} as bool from materialized client-scoped fields.
- ClientSession method ClientSession returns tmux #{client_session} as string from materialized client-scoped fields.
- ClientTermFeatures method ClientTermFeatures returns tmux #{client_termfeatures} as string from materialized client-scoped fields.
- ClientTermName method ClientTermName returns tmux #{client_termname} as string from materialized client-scoped fields.
- ClientTermType method ClientTermType returns tmux #{client_termtype} as string from materialized client-scoped fields.
- ClientTTY method ClientTTY returns tmux #{client_tty} as string from materialized client-scoped fields.
- ClientUID method ClientUID returns tmux #{client_uid} as int from materialized client-scoped fields.
- ClientUser method ClientUser returns tmux #{client_user} as string from materialized client-scoped fields.
- ClientUTF8 method ClientUTF8 returns tmux #{client_utf8} as bool from materialized client-scoped fields.
- ClientWidth method ClientWidth returns tmux #{client_width} as int from materialized client-scoped fields.
- ClientWritten method ClientWritten returns tmux #{client_written} as int from materialized client-scoped fields.
- ConfigFiles method ConfigFiles returns tmux #{config_files} as string from materialized universal-scoped fields.
- CursorBlinking method CursorBlinking returns tmux #{cursor_blinking} as bool from materialized pane-scoped fields (tmux 3.6 or later).
- CursorCharacter method CursorCharacter returns tmux #{cursor_character} as string from materialized pane-scoped fields.
- CursorColour method CursorColour returns tmux #{cursor_colour} as string from materialized pane-scoped fields (tmux 3.6 or later).
- CursorFlag method CursorFlag returns tmux #{cursor_flag} as bool from materialized pane-scoped fields.
- CursorShape method CursorShape returns tmux #{cursor_shape} as string from materialized pane-scoped fields (tmux 3.6 or later).
- CursorVeryVisible method CursorVeryVisible returns tmux #{cursor_very_visible} as bool from materialized pane-scoped fields (tmux 3.6 or later).
- CursorX method CursorX returns tmux #{cursor_x} as int from materialized pane-scoped fields.
- CursorY method CursorY returns tmux #{cursor_y} as int from materialized pane-scoped fields.
- HistoryAdded method HistoryAdded returns tmux #{history_added} as int from materialized pane-scoped fields (tmux 3.8 or later).
- HistoryAllBytes method HistoryAllBytes returns tmux #{history_all_bytes} as string from materialized pane-scoped fields.
- HistoryBytes method HistoryBytes returns tmux #{history_bytes} as int from materialized pane-scoped fields.
- HistoryCollected method HistoryCollected returns tmux #{history_collected} as int from materialized pane-scoped fields (tmux 3.8 or later).
- HistoryGeneration method HistoryGeneration returns tmux #{history_generation} as int from materialized pane-scoped fields (tmux 3.8 or later).
- HistoryLimit method HistoryLimit returns tmux #{history_limit} as int from materialized pane-scoped fields.
- HistorySize method HistorySize returns tmux #{history_size} as int from materialized pane-scoped fields.
- Host method Host returns tmux #{host} as string from materialized universal-scoped fields.
- HostShort method HostShort returns tmux #{host_short} as string from materialized universal-scoped fields.
- ImageSupport method ImageSupport returns tmux #{image_support} as bool from materialized universal-scoped fields (tmux next-3.9 or later).
- InsertFlag method InsertFlag returns tmux #{insert_flag} as bool from materialized pane-scoped fields.
- KeypadCursorFlag method KeypadCursorFlag returns tmux #{keypad_cursor_flag} as bool from materialized pane-scoped fields.
- KeypadFlag method KeypadFlag returns tmux #{keypad_flag} as bool from materialized pane-scoped fields.
- LastWindowIndex method LastWindowIndex returns tmux #{last_window_index} as int from materialized session-scoped fields.
- Line method Line returns tmux #{line} as int from materialized universal-scoped fields.
- MarshalJSON method MarshalJSON encodes the format expansions as tmux returned them. Nothing decodes:
json.Unmarshalinto this type reports no error and changes nothing, because every field is unexported. - MouseAllFlag method MouseAllFlag returns tmux #{mouse_all_flag} as bool from materialized pane-scoped fields.
- MouseAnyFlag method MouseAnyFlag returns tmux #{mouse_any_flag} as bool from materialized pane-scoped fields.
- MouseButtonFlag method MouseButtonFlag returns tmux #{mouse_button_flag} as bool from materialized pane-scoped fields.
- MouseSGRFlag method MouseSGRFlag returns tmux #{mouse_sgr_flag} as bool from materialized pane-scoped fields.
- MouseStandardFlag method MouseStandardFlag returns tmux #{mouse_standard_flag} as bool from materialized pane-scoped fields.
- MouseUTF8Flag method MouseUTF8Flag returns tmux #{mouse_utf8_flag} as bool from materialized pane-scoped fields.
- NextSessionID method NextSessionID returns tmux #{next_session_id} as SessionID from materialized universal-scoped fields.
- OriginFlag method OriginFlag returns tmux #{origin_flag} as bool from materialized pane-scoped fields.
- PaneActive method PaneActive returns tmux #{pane_active} as bool from materialized pane-scoped fields.
- PaneAtBottom method PaneAtBottom returns tmux #{pane_at_bottom} as bool from materialized pane-scoped fields.
- PaneAtLeft method PaneAtLeft returns tmux #{pane_at_left} as bool from materialized pane-scoped fields.
- PaneAtRight method PaneAtRight returns tmux #{pane_at_right} as bool from materialized pane-scoped fields.
- PaneAtTop method PaneAtTop returns tmux #{pane_at_top} as bool from materialized pane-scoped fields.
- PaneBG method PaneBG returns tmux #{pane_bg} as string from materialized pane-scoped fields.
- PaneBottom method PaneBottom returns tmux #{pane_bottom} as int from materialized pane-scoped fields.
- PaneCommandRunning method PaneCommandRunning returns tmux #{pane_command_running} as bool from materialized pane-scoped fields (tmux 3.8 or later).
- PaneCurrentCommand method PaneCurrentCommand returns tmux #{pane_current_command} as string from materialized pane-scoped fields.
- PaneCurrentPath method PaneCurrentPath returns tmux #{pane_current_path} as string from materialized pane-scoped fields.
- PaneDead method PaneDead returns tmux #{pane_dead} as bool from materialized pane-scoped fields.
- PaneDeadSignal method PaneDeadSignal returns tmux #{pane_dead_signal} as string from materialized pane-scoped fields.
- PaneDeadStatus method PaneDeadStatus returns tmux #{pane_dead_status} as int from materialized pane-scoped fields.
- PaneDeadTime method PaneDeadTime returns tmux #{pane_dead_time} as time.Time from materialized pane-scoped fields.
- PaneFG method PaneFG returns tmux #{pane_fg} as string from materialized pane-scoped fields.
- PaneFlags method PaneFlags returns tmux #{pane_flags} as string from materialized pane-scoped fields (tmux 3.7 or later).
- PaneFloatingFlag method PaneFloatingFlag returns tmux #{pane_floating_flag} as bool from materialized pane-scoped fields (tmux 3.7 or later).
- PaneFormat method PaneFormat returns tmux #{pane_format} as bool from materialized pane-scoped fields.
- PaneHeight method PaneHeight returns tmux #{pane_height} as int from materialized pane-scoped fields.
- PaneID method PaneID returns tmux #{pane_id} as PaneID from materialized pane-scoped fields.
- PaneIndex method PaneIndex returns tmux #{pane_index} as int from materialized pane-scoped fields.
- PaneInMode method PaneInMode returns tmux #{pane_in_mode} as int from materialized pane-scoped fields.
- PaneInputOff method PaneInputOff returns tmux #{pane_input_off} as bool from materialized pane-scoped fields.
- PaneKeyMode method PaneKeyMode returns tmux #{pane_key_mode} as string from materialized pane-scoped fields (tmux 3.5 or later).
- PaneLast method PaneLast returns tmux #{pane_last} as bool from materialized pane-scoped fields.
- PaneLeft method PaneLeft returns tmux #{pane_left} as int from materialized pane-scoped fields.
- PaneMarked method PaneMarked returns tmux #{pane_marked} as bool from materialized pane-scoped fields.
- PaneMarkedSet method PaneMarkedSet returns tmux #{pane_marked_set} as bool from materialized pane-scoped fields.
- PaneModalFlag method PaneModalFlag returns tmux #{pane_modal_flag} as bool from materialized pane-scoped fields (tmux 3.8 or later).
- PaneMode method PaneMode returns tmux #{pane_mode} as string from materialized pane-scoped fields.
- PaneOutputGeneration method PaneOutputGeneration returns tmux #{pane_output_generation} as int from materialized pane-scoped fields (tmux 3.8 or later).
- PanePath method PanePath returns tmux #{pane_path} as string from materialized pane-scoped fields.
- PanePBProgress method PanePBProgress returns tmux #{pane_pb_progress} as int from materialized pane-scoped fields (tmux 3.7 or later).
- PanePBState method PanePBState returns tmux #{pane_pb_state} as string from materialized pane-scoped fields (tmux 3.7 or later).
- PanePID method PanePID returns tmux #{pane_pid} as int from materialized pane-scoped fields.
- PanePipe method PanePipe returns tmux #{pane_pipe} as bool from materialized pane-scoped fields.
- PanePipePID method PanePipePID returns tmux #{pane_pipe_pid} as int from materialized pane-scoped fields (tmux 3.7 or later).
- PanePrivateModes method PanePrivateModes returns tmux #{pane_private_modes} as string from materialized pane-scoped fields (tmux 3.8 or later).
- PaneRight method PaneRight returns tmux #{pane_right} as int from materialized pane-scoped fields.
- PaneSearchString method PaneSearchString returns tmux #{pane_search_string} as string from materialized pane-scoped fields.
- PaneStartCommand method PaneStartCommand returns tmux #{pane_start_command} as string from materialized pane-scoped fields.
- PaneStartCommandList method PaneStartCommandList returns tmux #{pane_start_command_list} as string from materialized pane-scoped fields (tmux 3.8 or later).
- PaneStartPath method PaneStartPath returns tmux #{pane_start_path} as string from materialized pane-scoped fields.
- PaneSynchronized method PaneSynchronized returns tmux #{pane_synchronized} as bool from materialized pane-scoped fields.
- PaneTabs method PaneTabs returns tmux #{pane_tabs} as string from materialized pane-scoped fields.
- PaneTitle method PaneTitle returns tmux #{pane_title} as string from materialized pane-scoped fields.
- PaneTop method PaneTop returns tmux #{pane_top} as int from materialized pane-scoped fields.
- PaneTTY method PaneTTY returns tmux #{pane_tty} as string from materialized pane-scoped fields.
- PaneUnseenChanges method PaneUnseenChanges returns tmux #{pane_unseen_changes} as bool from materialized pane-scoped fields (tmux 3.4 or later).
- PaneUnzoomedHeight method PaneUnzoomedHeight returns tmux #{pane_unzoomed_height} as int from materialized pane-scoped fields (tmux 3.8 or later).
- PaneUnzoomedWidth method PaneUnzoomedWidth returns tmux #{pane_unzoomed_width} as int from materialized pane-scoped fields (tmux 3.8 or later).
- PaneWidth method PaneWidth returns tmux #{pane_width} as int from materialized pane-scoped fields.
- PaneX method PaneX returns tmux #{pane_x} as int from materialized pane-scoped fields (tmux 3.7 or later).
- PaneY method PaneY returns tmux #{pane_y} as int from materialized pane-scoped fields (tmux 3.7 or later).
- PaneZ method PaneZ returns tmux #{pane_z} as int from materialized pane-scoped fields (tmux 3.7 or later).
- PaneZoomedFlag method PaneZoomedFlag returns tmux #{pane_zoomed_flag} as bool from materialized pane-scoped fields (tmux 3.7 or later).
- PID method PID returns tmux #{pid} as int from materialized universal-scoped fields.
- Raw method Raw returns the exact materialized tmux format expansion for name. It never queries tmux; ok distinguishes an absent field from a present empty value.
- ScrollRegionLower method ScrollRegionLower returns tmux #{scroll_region_lower} as int from materialized pane-scoped fields.
- ScrollRegionUpper method ScrollRegionUpper returns tmux #{scroll_region_upper} as int from materialized pane-scoped fields.
- ServerSessions method ServerSessions returns tmux #{server_sessions} as int from materialized universal-scoped fields (tmux 3.4 or later).
- SessionActive method SessionActive returns tmux #{session_active} as bool from materialized session-scoped fields (tmux 3.6 or later).
- SessionActivity method SessionActivity returns tmux #{session_activity} as time.Time from materialized session-scoped fields.
- SessionActivityFlag method SessionActivityFlag returns tmux #{session_activity_flag} as bool from materialized session-scoped fields (tmux 3.6 or later).
- SessionAlert method SessionAlert returns tmux #{session_alert} as string from materialized session-scoped fields (tmux 3.6 or later).
- SessionAlerts method SessionAlerts returns tmux #{session_alerts} as string from materialized session-scoped fields.
- SessionAttached method SessionAttached returns tmux #{session_attached} as int from materialized session-scoped fields.
- SessionAttachedList method SessionAttachedList returns tmux #{session_attached_list} as string from materialized session-scoped fields.
- SessionBellFlag method SessionBellFlag returns tmux #{session_bell_flag} as bool from materialized session-scoped fields (tmux 3.6 or later).
- SessionCreated method SessionCreated returns tmux #{session_created} as time.Time from materialized session-scoped fields.
- SessionFormat method SessionFormat returns tmux #{session_format} as bool from materialized session-scoped fields.
- SessionGroup method SessionGroup returns tmux #{session_group} as string from materialized session-scoped fields.
- SessionGroupAttached method SessionGroupAttached returns tmux #{session_group_attached} as int from materialized session-scoped fields.
- SessionGroupAttachedList method SessionGroupAttachedList returns tmux #{session_group_attached_list} as string from materialized session-scoped fields.
- SessionGrouped method SessionGrouped returns tmux #{session_grouped} as bool from materialized session-scoped fields.
- SessionGroupList method SessionGroupList returns tmux #{session_group_list} as string from materialized session-scoped fields.
- SessionGroupManyAttached method SessionGroupManyAttached returns tmux #{session_group_many_attached} as bool from materialized session-scoped fields.
- SessionGroupSize method SessionGroupSize returns tmux #{session_group_size} as int from materialized session-scoped fields.
- SessionID method SessionID returns tmux #{session_id} as SessionID from materialized session-scoped fields.
- SessionLastAttached method SessionLastAttached returns tmux #{session_last_attached} as time.Time from materialized session-scoped fields.
- SessionManyAttached method SessionManyAttached returns tmux #{session_many_attached} as bool from materialized session-scoped fields.
- SessionMarked method SessionMarked returns tmux #{session_marked} as bool from materialized session-scoped fields.
- SessionName method SessionName returns tmux #{session_name} as string from materialized session-scoped fields.
- SessionPath method SessionPath returns tmux #{session_path} as string from materialized session-scoped fields.
- SessionSilenceFlag method SessionSilenceFlag returns tmux #{session_silence_flag} as bool from materialized session-scoped fields (tmux 3.6 or later).
- SessionStack method SessionStack returns tmux #{session_stack} as string from materialized session-scoped fields.
- SessionWindows method SessionWindows returns tmux #{session_windows} as int from materialized session-scoped fields.
- SixelSupport method SixelSupport returns tmux #{sixel_support} as bool from materialized universal-scoped fields (tmux 3.6 or later).
- SocketPath method SocketPath returns tmux #{socket_path} as string from materialized universal-scoped fields.
- StartTime method StartTime returns tmux #{start_time} as time.Time from materialized universal-scoped fields.
- SynchronizedOutputFlag method SynchronizedOutputFlag returns tmux #{synchronized_output_flag} as bool from materialized pane-scoped fields (tmux 3.7 or later).
- TreeModeFormat method TreeModeFormat returns tmux #{tree_mode_format} as string from materialized universal-scoped fields.
- UID method UID returns tmux #{uid} as int from materialized universal-scoped fields.
- User method User returns tmux #{user} as string from materialized universal-scoped fields.
- Version method Version returns tmux #{version} as Version from materialized universal-scoped fields.
- WindowActive method WindowActive returns tmux #{window_active} as bool from materialized window-scoped fields.
- WindowActiveClients method WindowActiveClients returns tmux #{window_active_clients} as int from materialized window-scoped fields.
- WindowActiveClientsList method WindowActiveClientsList returns tmux #{window_active_clients_list} as string from materialized window-scoped fields.
- WindowActiveSessions method WindowActiveSessions returns tmux #{window_active_sessions} as int from materialized window-scoped fields.
- WindowActiveSessionsList method WindowActiveSessionsList returns tmux #{window_active_sessions_list} as string from materialized window-scoped fields.
- WindowActivity method WindowActivity returns tmux #{window_activity} as time.Time from materialized window-scoped fields.
- WindowActivityFlag method WindowActivityFlag returns tmux #{window_activity_flag} as bool from materialized window-scoped fields.
- WindowBellFlag method WindowBellFlag returns tmux #{window_bell_flag} as bool from materialized window-scoped fields.
- WindowBigger method WindowBigger returns tmux #{window_bigger} as bool from materialized window-scoped fields.
- WindowCellHeight method WindowCellHeight returns tmux #{window_cell_height} as int from materialized window-scoped fields.
- WindowCellWidth method WindowCellWidth returns tmux #{window_cell_width} as int from materialized window-scoped fields.
- WindowEndFlag method WindowEndFlag returns tmux #{window_end_flag} as bool from materialized window-scoped fields.
- WindowFlags method WindowFlags returns tmux #{window_flags} as string from materialized window-scoped fields.
- WindowFormat method WindowFormat returns tmux #{window_format} as bool from materialized window-scoped fields.
- WindowHeight method WindowHeight returns tmux #{window_height} as int from materialized window-scoped fields.
- WindowID method WindowID returns tmux #{window_id} as WindowID from materialized window-scoped fields.
- WindowIndex method WindowIndex returns tmux #{window_index} as int from materialized window-scoped fields.
- WindowLastFlag method WindowLastFlag returns tmux #{window_last_flag} as bool from materialized window-scoped fields.
- WindowLayout method WindowLayout returns tmux #{window_layout} as string from materialized window-scoped fields.
- WindowLinked method WindowLinked returns tmux #{window_linked} as bool from materialized window-scoped fields.
- WindowLinkedSessions method WindowLinkedSessions returns tmux #{window_linked_sessions} as int from materialized window-scoped fields.
- WindowLinkedSessionsList method WindowLinkedSessionsList returns tmux #{window_linked_sessions_list} as string from materialized window-scoped fields.
- WindowManualHeight method WindowManualHeight returns tmux #{window_manual_height} as int from materialized window-scoped fields (tmux 3.8 or later).
- WindowManualWidth method WindowManualWidth returns tmux #{window_manual_width} as int from materialized window-scoped fields (tmux 3.8 or later).
- WindowMarkedFlag method WindowMarkedFlag returns tmux #{window_marked_flag} as bool from materialized window-scoped fields.
- WindowName method WindowName returns tmux #{window_name} as string from materialized window-scoped fields.
- WindowOffsetX method WindowOffsetX returns tmux #{window_offset_x} as int from materialized window-scoped fields.
- WindowOffsetY method WindowOffsetY returns tmux #{window_offset_y} as int from materialized window-scoped fields.
- WindowPanes method WindowPanes returns tmux #{window_panes} as int from materialized window-scoped fields.
- WindowRawFlags method WindowRawFlags returns tmux #{window_raw_flags} as string from materialized window-scoped fields.
- WindowSilenceFlag method WindowSilenceFlag returns tmux #{window_silence_flag} as bool from materialized window-scoped fields.
- WindowStackIndex method WindowStackIndex returns tmux #{window_stack_index} as int from materialized window-scoped fields.
- WindowStartFlag method WindowStartFlag returns tmux #{window_start_flag} as bool from materialized window-scoped fields.
- WindowVisibleLayout method WindowVisibleLayout returns tmux #{window_visible_layout} as string from materialized window-scoped fields.
- WindowWidth method WindowWidth returns tmux #{window_width} as int from materialized window-scoped fields.
- WindowZoomedFlag method WindowZoomedFlag returns tmux #{window_zoomed_flag} as bool from materialized window-scoped fields.
- WrapFlag method WrapFlag returns tmux #{wrap_flag} as bool from materialized pane-scoped fields.