Struct ViewEvent 

pub struct ViewEvent<Message> {
    pub redraw: ViewRedraw,
    pub captured: bool,
    pub message: Option<Message>,
}

Result of a view update or touch event.

Fields

redraw: ViewRedraw

Redraw requested by the view.

captured: bool

Whether the event was captured by the view.

message: Option<Message>

Optional application message emitted by the view.

Implementations

impl<Message> ViewEvent<Message>

pub const fn none() -> Self

Returns a no-op event.

Examples found in repository

src/foundation/traits.rs (line 26)

    fn update(
        &mut self,
        _dt_ms: u32,
        _registration: &ViewRegistration<'text, ViewId, N>,
        _env: &ViewEnvironment<'_, 'text>,
    ) -> ViewEvent<Message> {
        ViewEvent::none()
    }

pub const fn redraw(redraw: ViewRedraw) -> Self

Creates an event that only requests a redraw.

Examples found in repository

examples/runtime_shell.rs (line 39)

    fn handle_touch(
        &mut self,
        _touch: TouchEvent,
        _registration: &ViewRegistration<'static, RootId, 1>,
        _env: &ViewEnvironment<'_, 'static>,
    ) -> ViewEvent<()> {
        ViewEvent::redraw(ViewRedraw::Full)
    }

examples/uikit_root.rs (line 69)

    fn update(
        &mut self,
        dt_ms: u32,
        registration: &ViewRegistration<'static, DemoViewId, 2>,
        _env: &ViewEnvironment<'_, 'static>,
    ) -> ViewEvent<DemoMessage> {
        let list = registration.children()[0].frame;
        ViewEvent::redraw(self.list.tick(dt_ms, list))
    }

pub const fn captured(self, captured: bool) -> Self

Sets whether the originating event was captured.

pub fn message(self, message: Message) -> Self

Attaches an application message to the event.

Trait Implementations

impl<Message: Clone> Clone for ViewEvent<Message>

fn clone(&self) -> ViewEvent<Message>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Message: Debug> Debug for ViewEvent<Message>

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

Formats the value using the given formatter.

impl<Message: PartialEq> PartialEq for ViewEvent<Message>

fn eq(&self, other: &ViewEvent<Message>) -> 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<Message: Copy> Copy for ViewEvent<Message>

impl<Message: Eq> Eq for ViewEvent<Message>

impl<Message> StructuralPartialEq for ViewEvent<Message>