EventContext

Struct EventContext 

Source
pub struct EventContext<C: ComponentId> {
    pub focused_component: Option<C>,
    pub mouse_position: Option<(u16, u16)>,
    pub modifiers: KeyModifiers,
    pub component_areas: HashMap<C, Rect>,
    pub is_modal_open: bool,
    pub active_modal: Option<C>,
}
Expand description

Context passed with every event

Generic over the component ID type C which must implement ComponentId.

Fields§

§focused_component: Option<C>

Currently focused component

§mouse_position: Option<(u16, u16)>

Current mouse position (if known)

§modifiers: KeyModifiers

Active key modifiers

§component_areas: HashMap<C, Rect>

Component areas for hit-testing

§is_modal_open: bool

Whether a modal is currently open

§active_modal: Option<C>

The active modal (if any)

Implementations§

Source§

impl<C: ComponentId> EventContext<C>

Source

pub fn new() -> Self

Create a new event context

Source

pub fn is_focused(&self, component: C) -> bool

Check if a component is focused

Source

pub fn point_in_component(&self, component: C, x: u16, y: u16) -> bool

Check if a point is within a component’s area

Source

pub fn component_at(&self, x: u16, y: u16) -> Option<C>

Get the component at a given point

Source

pub fn set_component_area(&mut self, component: C, area: Rect)

Update the area for a component

Source

pub fn set_focus(&mut self, component: Option<C>)

Set the focused component

Source

pub fn set_modal(&mut self, modal: Option<C>)

Set modal state

Trait Implementations§

Source§

impl<C: Clone + ComponentId> Clone for EventContext<C>

Source§

fn clone(&self) -> EventContext<C>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<C: Debug + ComponentId> Debug for EventContext<C>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<C: ComponentId> Default for EventContext<C>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<C> Freeze for EventContext<C>
where C: Freeze,

§

impl<C> RefUnwindSafe for EventContext<C>
where C: RefUnwindSafe,

§

impl<C> Send for EventContext<C>
where C: Send,

§

impl<C> Sync for EventContext<C>
where C: Sync,

§

impl<C> Unpin for EventContext<C>
where C: Unpin,

§

impl<C> UnwindSafe for EventContext<C>
where C: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more