Enum rat_widget::event::ScrollOutcome

pub enum ScrollOutcome<R> {
    NotUsed,
    Unchanged,
    Changed,
    Inner(R),
}

Result value for event-handling. Used widgets in this crate.

Variants

NotUsed

The given event was not handled at all.

Unchanged

The event was handled, no repaint necessary.

Changed

The event was handled, repaint necessary.

Inner(R)

Outcome of the inner widget.

Implementations

impl<R> ScrollOutcome<ScrollOutcome<R>>

pub fn flatten(self) -> ScrollOutcome<R>

Compact two layers of Outcome to one.

impl<R> ScrollOutcome<ScrollOutcome<ScrollOutcome<R>>>

pub fn flatten2(self) -> ScrollOutcome<R>

Compact three layers of Outcome to one.

Trait Implementations

impl<R> Clone for ScrollOutcome<R>

where R: Clone,

fn clone(&self) -> ScrollOutcome<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R> ConsumedEvent for ScrollOutcome<R>

where R: ConsumedEvent,

fn is_consumed(&self) -> bool

fn or_else<F>(self, f: F) -> Self

where F: FnOnce() -> Self, Self: Sized,

Or-Else chaining with is_consumed() as the split.

impl<R> Debug for ScrollOutcome<R>

where R: Debug,

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

Formats the value using the given formatter.

impl<T> From<ScrollOutcome<T>> for Outcome

fn from(value: ScrollOutcome<T>) -> Outcome

Converts to this type from the input type.

impl<R, WState> HandleEvent<Event, FocusKeys, ScrollOutcome<R>> for ScrolledState<WState>

where WState: ScrollingState + HandleEvent<Event, FocusKeys, R> + HandleEvent<Event, MouseOnly, R>, R: ConsumedEvent,

Handle events or the scrolled widget and forward to the inner widget.

fn handle(&mut self, event: &Event, _keymap: FocusKeys) -> ScrollOutcome<R>

Handle an event.

impl<R> HandleEvent<Event, FocusKeys, ScrollOutcome<R>> for ViewState

where R: ConsumedEvent,

Handle all events. Text events are only processed if focus is true. Mouse events are processed if they are in range.

fn handle(&mut self, _event: &Event, _keymap: FocusKeys) -> ScrollOutcome<R>

Handle an event.

impl<R, S> HandleEvent<Event, FocusKeys, ScrollOutcome<R>> for ViewportState<S>

where S: HandleEvent<Event, FocusKeys, R>, R: ConsumedEvent,

Handle events if the widget has the focus.

fn handle(&mut self, event: &Event, _keymap: FocusKeys) -> ScrollOutcome<R>

Handle an event.

impl<WState, Q, R> HandleEvent<Event, Inner<Q>, ScrollOutcome<R>> for ScrolledState<WState>

where WState: ScrollingState + HandleEvent<Event, Q, R>, R: ConsumedEvent,

Forward event-handling to the inner widget.

fn handle(&mut self, event: &Event, qualifier: Inner<Q>) -> ScrollOutcome<R>

Handle an event.

impl<R, WState> HandleEvent<Event, MouseOnly, ScrollOutcome<R>> for ScrolledState<WState>

where WState: ScrollingState + HandleEvent<Event, MouseOnly, R>, R: ConsumedEvent,

Handle events for the Scrolled widget and the scrollbars.

fn handle(&mut self, event: &Event, _keymap: MouseOnly) -> ScrollOutcome<R>

Handle an event.

impl<R> HandleEvent<Event, MouseOnly, ScrollOutcome<R>> for ViewState

where R: ConsumedEvent,

Handle only mouse-events.

fn handle(&mut self, _event: &Event, _keymap: MouseOnly) -> ScrollOutcome<R>

Handle an event.

impl<R, S> HandleEvent<Event, MouseOnly, ScrollOutcome<R>> for ViewportState<S>

where S: HandleEvent<Event, MouseOnly, R>, R: ConsumedEvent,

Handle only mouse-events.

fn handle(&mut self, event: &Event, _keymap: MouseOnly) -> ScrollOutcome<R>

Handle an event.

impl<R> PartialEq for ScrollOutcome<R>

where R: PartialEq,

fn eq(&self, other: &ScrollOutcome<R>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<R> Copy for ScrollOutcome<R>

where R: Copy,

impl<R> Eq for ScrollOutcome<R>

where R: Eq,

impl<R> StructuralPartialEq for ScrollOutcome<R>