InputHandlerInput

Struct InputHandlerInput 

Source
pub struct InputHandlerInput<'a> {
    pub computed_data: ComputedData,
    pub cursor_position_rel: Option<PxPosition>,
    pub cursor_events: &'a mut Vec<CursorEvent>,
    pub keyboard_events: &'a mut Vec<KeyEvent>,
    pub ime_events: &'a mut Vec<Ime>,
    pub key_modifiers: ModifiersState,
    pub requests: &'a mut WindowRequests,
    pub clipboard: &'a mut Clipboard,
    /* private fields */
}
Expand description

Input for the input handler function (InputHandlerFn).

Note that you can modify the cursor_events and keyboard_events vectors for exmaple block some keyboard events or cursor events to prevent them from propagating to parent components and older brother components.

Fields§

§computed_data: ComputedData

The size of the component node, computed during the measure stage.

§cursor_position_rel: Option<PxPosition>

The position of the cursor, if available. Relative to the root position of the component.

§cursor_events: &'a mut Vec<CursorEvent>

Cursor events from the event loop, if any.

§keyboard_events: &'a mut Vec<KeyEvent>

Keyboard events from the event loop, if any.

§ime_events: &'a mut Vec<Ime>

IME events from the event loop, if any.

§key_modifiers: ModifiersState

The current state of the keyboard modifiers at the time of the event. This allows for implementing keyboard shortcuts (e.g., Ctrl+C).

§requests: &'a mut WindowRequests

A context for making requests to the window for the current frame.

§clipboard: &'a mut Clipboard

Clipboard

Implementations§

Source§

impl InputHandlerInput<'_>

Source

pub fn block_cursor(&mut self)

Blocks the cursor to other components.

Source

pub fn block_keyboard(&mut self)

Blocks the keyboard events to other components.

Source

pub fn block_ime(&mut self)

Blocks the IME events to other components.

Source

pub fn block_all(&mut self)

Block all events (cursor, keyboard, IME) to other components.

Source

pub fn accessibility(&self) -> AccessibilityBuilderGuard<'_>

Provides a fluent API for setting accessibility information for the current component.

This method returns a builder that allows you to set various accessibility properties like role, label, actions, and state. The accessibility information is automatically committed when the builder is dropped or when .commit() is called explicitly.

§Example
use accesskit::{Action, Role};
use tessera_ui::tessera;

#[tessera]
fn accessible_button() {
    input_handler(Box::new(|input| {
        input.accessibility()
            .role(Role::Button)
            .label("Click me")
            .focusable()
            .action(Action::Click);
         
        // Handle clicks...
    }));
}

Note: The builder should be committed with .commit() or allowed to drop, which will automatically store the accessibility information in the metadata.

Source

pub fn set_accessibility_action_handler( &self, handler: impl Fn(Action) + Send + Sync + 'static, )

Sets an action handler for accessibility actions.

This handler will be called when assistive technologies request actions like clicking, focusing, or changing values.

§Example
use accesskit::Action;
use tessera_ui::tessera;

#[tessera]
fn interactive_button() {
    input_handler(Box::new(|input| {
        input.set_accessibility_action_handler(|action| {
            if action == Action::Click {
                // Handle click from assistive technology
            }
        });
    }));
}

Auto Trait Implementations§

§

impl<'a> Freeze for InputHandlerInput<'a>

§

impl<'a> !RefUnwindSafe for InputHandlerInput<'a>

§

impl<'a> Send for InputHandlerInput<'a>

§

impl<'a> Sync for InputHandlerInput<'a>

§

impl<'a> Unpin for InputHandlerInput<'a>

§

impl<'a> !UnwindSafe for InputHandlerInput<'a>

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> AsAny for T
where T: Any,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Returns a reference to the concrete type as &dyn Any.
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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

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
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,