Struct cursive_core::event::EventTrigger

pub struct EventTrigger { /* fields omitted */ }

A trigger that only selects some types of events.

It is meant to be stored in views.

Implementations

impl EventTrigger

pub fn from_fn<F>(f: F) -> Self where
    F: 'static + Fn(&Event) -> bool, 

Create a new EventTrigger using the given function as filter.

pub fn from_fn_and_tag<F, T>(f: F, tag: T) -> Self where
    F: 'static + Fn(&Event) -> bool,
    T: Any + Debug, 

Create a new EventTrigger.

pub fn has_tag<T: PartialEq + 'static>(&self, tag: &T) -> bool

Check if this trigger has the given tag.

Examples

use cursive_core::event::{Event, EventTrigger};

let event = Event::CtrlChar('c');
let trigger: EventTrigger = event.clone().into();
assert!(
    trigger.has_tag(&event),
    "Trigger does not recognize its own tag."
);

pub fn apply(&self, event: &Event) -> bool

Checks if this trigger applies to the given Event.

pub fn arrows() -> Self

Returns an EventTrigger that only accepts arrow keys.

Only bare arrow keys without modifiers (Shift, Ctrl, Alt) will be accepted.

pub fn mouse() -> Self

Returns an EventTrigger that only accepts mouse events.

pub fn any() -> Self

Returns an EventTrigger that accepts any event.

pub fn none() -> Self

Returns an EventTrigger that doesn't accept any event.

pub fn or<O>(self, other: O) -> Self where
    O: Into<EventTrigger>, 

Returns an EventTrigger that applies if either self or other applies.

Trait Implementations

impl From<Event> for EventTrigger

pub fn from(event: Event) -> Self

Performs the conversion.

impl<F> From<F> for EventTrigger where
    F: 'static + Fn(&Event) -> bool, 

pub fn from(f: F) -> Self

Performs the conversion.

impl From<Key> for EventTrigger

pub fn from(k: Key) -> Self

Performs the conversion.

impl From<char> for EventTrigger

pub fn from(c: char) -> Self

Performs the conversion.