Enum azul_core::dom::EventFilter

pub enum EventFilter {
    Hover(HoverEventFilter),
    Not(NotEventFilter),
    Focus(FocusEventFilter),
    Window(WindowEventFilter),
}

Sets the target for what events can reach the callbacks specifically.

Filtering events can happen on several layers, depending on if a DOM node is hovered over or actively focused. For example, for text input, you wouldn't want to use hovering, because that would mean that the user needs to hold the mouse over the text input in order to enter text. To solve this, the DOM needs to fire events for elements that are currently not part of the hit-test. EventFilter implements From<On> as a shorthand (so that you can opt-in to a more specific event) and use

Variants

Hover(HoverEventFilter)

Calls the attached callback when the mouse is actively over the given element.

Not(NotEventFilter)

Inverse of Hover - calls the attached callback if the mouse is not over the given element. This is particularly useful for popover menus where you want to close the menu when the user clicks anywhere else but the menu itself.

Focus(FocusEventFilter)

Calls the attached callback when the element is currently focused.

Window(WindowEventFilter)

Calls the callback when anything related to the window is happening. The "hit item" will be the root item of the DOM. For example, this can be useful for tracking the mouse position (in relation to the window). In difference to Desktop, this only fires when the window is focused.

This can also be good for capturing controller input, touch input (i.e. global gestures that aren't attached to any component, but rather the "window" itself).

Implementations

impl EventFilter

pub fn as_hover_event_filter(&self) -> Option<HoverEventFilter>

pub fn as_focus_event_filter(&self) -> Option<FocusEventFilter>

pub fn as_not_event_filter(&self) -> Option<NotEventFilter>

pub fn as_window_event_filter(&self) -> Option<WindowEventFilter>

Trait Implementations

impl Clone for EventFilter

fn clone(&self) -> EventFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for EventFilter

impl Debug for EventFilter

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

Formats the value using the given formatter.

impl Eq for EventFilter

impl From<On> for EventFilter

fn from(input: On) -> EventFilter

Performs the conversion.

impl Hash for EventFilter

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for EventFilter

fn cmp(&self, other: &EventFilter) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<EventFilter> for EventFilter

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<EventFilter> for EventFilter

fn partial_cmp(&self, other: &EventFilter) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &EventFilter) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &EventFilter) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &EventFilter) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &EventFilter) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for EventFilter

impl StructuralPartialEq for EventFilter