Struct zng::event::EventPropagationHandle

pub struct EventPropagationHandle(/* private fields */);

Event propagation handle associated with one or multiple EventArgs.

Event handlers can use this to signal subsequent handlers that the event is already handled and they should operate as if the event was not received.

You can get the propagation handle of any event argument by using the AnyEventArgs::propagation method.

Implementations

impl EventPropagationHandle

pub fn new() -> EventPropagationHandle

New in the not stopped default state.

pub fn stop(&self)

Signal subsequent handlers that the event is already handled.

pub fn is_stopped(&self) -> bool

If the handler must skip this event instance.

Note that property level handlers don’t need to check this, as those handlers are not called when this is true. Direct event listeners in UiNode and AppExtension must check if this is true.

Trait Implementations

impl Clone for EventPropagationHandle

fn clone(&self) -> EventPropagationHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventPropagationHandle

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

Formats the value using the given formatter.

impl Default for EventPropagationHandle

fn default() -> EventPropagationHandle

Returns the “default value” for a type.

impl Hash for EventPropagationHandle

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

where H: Hasher,

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 EventPropagationHandle

fn eq(&self, other: &EventPropagationHandle) -> 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 Eq for EventPropagationHandle