Enum EventType 

pub enum EventType {
    WindowCreated,
    WindowClosed,
    WindowFocusChanged,
    WindowResized,
    WindowConfigReloaded,
    GuiStartup,
    TabCreated,
    TabClosed,
    TabSwitched,
    NewTabButtonClick,
    PaneCreated,
    PaneClosed,
    PaneFocused,
    PaneTitleChanged,
    Bell,
    SelectionChanged,
    UserVarChanged,
    OpenUri,
    ScrollbackCleared,
    UpdateStatus,
    UpdateRightStatus,
    UpdateLeftStatus,
    FormatTabTitle,
    FormatWindowTitle,
    Output,
    Input,
    PreCommand,
    PostCommand,
    Resize,
    Attach,
    Detach,
    Custom(String),
}

Event type enumeration

Defines all events that plugins can subscribe to. Events are organized into categories: window, tab, pane, terminal, and status events.

Variants

WindowCreated

Fired when a new window is created

WindowClosed

Fired when a window is closed

WindowFocusChanged

Fired when window focus changes (gained or lost)

WindowResized

Fired when a window is resized

WindowConfigReloaded

Fired when configuration is reloaded

GuiStartup

Fired once when the GUI starts up (before first window)

TabCreated

Fired when a new tab is created

TabClosed

Fired when a tab is closed

TabSwitched

Fired when the active tab changes

NewTabButtonClick

Fired when the user clicks the “new tab” button

PaneCreated

Fired when a new pane is created (split)

PaneClosed

Fired when a pane is closed

PaneFocused

Fired when a pane gains focus

PaneTitleChanged

Fired when a pane’s title changes

Bell

Fired when the terminal bell is rung

SelectionChanged

Fired when the text selection changes

UserVarChanged

Fired when a user-defined variable changes (OSC 1337)

OpenUri

Fired when a clickable URI is detected

ScrollbackCleared

Fired when the scrollback buffer is cleared

UpdateStatus

Request to update the status bar

UpdateRightStatus

Request to update the right status section

UpdateLeftStatus

Request to update the left status section

FormatTabTitle

Request to format a tab title (return formatted string)

FormatWindowTitle

Request to format the window title (return formatted string)

Output

Terminal output (maps to HookType::PreOutput)

Input

User input (maps to HookType::PostInput)

PreCommand

Before command execution (maps to HookType::PreCommand)

PostCommand

After command execution (maps to HookType::PostCommand)

Resize

Terminal resize (maps to HookType::OnResize)

Attach

Client attached (maps to HookType::OnAttach)

Detach

Client detached (maps to HookType::OnDetach)

Custom(String)

User-defined custom event

Allows plugins to emit and listen for custom events with arbitrary names. For example, Custom("git-status-changed") or Custom("test-completed").

Implementations

impl EventType

pub fn is_window_event(&self) -> bool

Check if this is a window-related event

pub fn is_tab_event(&self) -> bool

Check if this is a tab-related event

pub fn is_pane_event(&self) -> bool

Check if this is a pane-related event

pub fn is_terminal_event(&self) -> bool

Check if this is a terminal interaction event

pub fn is_status_event(&self) -> bool

Check if this is a status/formatting event

pub fn is_legacy_event(&self) -> bool

Check if this is a legacy hook event

pub fn is_custom_event(&self) -> bool

Check if this is a custom event

pub fn name(&self) -> String

Get a human-readable name for this event

pub fn all_standard() -> Vec<EventType>

Get all standard (non-custom) event types

pub fn from_hook_type(hook_type: HookType) -> Self

Convert from legacy HookType to EventType

pub fn to_hook_type(&self) -> Option<HookType>

Try to convert EventType to legacy HookType (returns None for new events)

Trait Implementations

impl Clone for EventType

fn clone(&self) -> EventType

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EventType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for EventType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EventType

fn eq(&self, other: &EventType) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for EventType

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for EventType

impl StructuralPartialEq for EventType