Enum GlobalKeyPolicy 

pub enum GlobalKeyPolicy {
    Default,
    Keys(Vec<(KeyCode, KeyModifiers)>),
    Custom(Box<dyn Fn(&EventKind) -> bool + Send + Sync>),
}

Policy for determining which events are treated as global.

Global events bypass modal blocking and are delivered to global subscribers even when a modal is active. Resize events are always treated as global regardless of this policy.

By default, Esc, Ctrl+C, and Ctrl+Q are global keys. Use this to customize that behavior — for example, if your app uses Esc for “close modal” and doesn’t want it treated as global.

Example

use tui_dispatch::{EventBus, GlobalKeyPolicy};

// Remove Esc from global keys (keep only Ctrl+C, Ctrl+Q)
let bus = EventBus::new()
    .with_global_key_policy(GlobalKeyPolicy::without_esc());

// Custom set of global keys
let bus = EventBus::new()
    .with_global_key_policy(GlobalKeyPolicy::keys(vec![
        (KeyCode::Char('c'), KeyModifiers::CONTROL),
    ]));

// No key events are global (only Resize remains global)
let bus = EventBus::new()
    .with_global_key_policy(GlobalKeyPolicy::none());

Variants

Default

Default: Esc, Ctrl+C, Ctrl+Q are global. Same as EventKind::is_global().

Keys(Vec<(KeyCode, KeyModifiers)>)

Only these specific key combinations are global. Each entry is (KeyCode, required_modifiers).

Custom(Box<dyn Fn(&EventKind) -> bool + Send + Sync>)

Custom predicate function.

Implementations

impl GlobalKeyPolicy

pub fn none() -> Self

No key events are global (only Resize remains global).

pub fn without_esc() -> Self

Default without Esc — only Ctrl+C and Ctrl+Q are global.

Useful for apps that use Esc to close modals/dialogs.

pub fn keys(keys: Vec<(KeyCode, KeyModifiers)>) -> Self

Only these specific key combinations are global.

Each entry is (KeyCode, required_modifiers) — the key matches if its code equals the given code and its modifiers contain the required modifiers.

pub fn custom(f: impl Fn(&EventKind) -> bool + Send + Sync + 'static) -> Self

Custom predicate for full control over global classification.

Resize events are still always global regardless of the predicate.

pub fn is_global(&self, event: &EventKind) -> bool

Check whether an event is global under this policy.

Resize events always return true regardless of the policy.

Trait Implementations

impl Default for GlobalKeyPolicy

fn default() -> GlobalKeyPolicy

Returns the “default value” for a type.