Enum ScrollOutcome 

pub enum ScrollOutcome {
    Continue,
    Unchanged,
    Changed,
    Up(usize),
    Down(usize),
    Left(usize),
    Right(usize),
    VPos(usize),
    HPos(usize),
}

Result of event-handling for a scroll.

All values are in terms of offset.

Variants

Continue

The given event has not been used at all.

Unchanged

The event has been recognized, but the result was nil. Further processing for this event may stop.

Changed

The event has been recognized and there is some change due to it. Further processing for this event may stop. Rendering the ui is advised.

Up(usize)

Scroll delta.

Down(usize)

Scroll delta.

Left(usize)

Scroll delta.

Right(usize)

Scroll delta.

VPos(usize)

Absolute position.

HPos(usize)

Absolute position.

Trait Implementations

impl Clone for ScrollOutcome

fn clone(&self) -> ScrollOutcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConsumedEvent for ScrollOutcome

fn is_consumed(&self) -> bool

Is this the ‘consumed’ result.

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

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

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

fn or_else_try<F, E>(self, f: F) -> Result<Self, E>

where Self: Sized, F: FnOnce() -> Result<Self, E>,

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

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

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

And_then-chaining based on is_consumed(). Returns max(self, f()).

fn and_then_try<F, E>(self, f: F) -> Result<Self, E>

where Self: Sized + Ord, F: FnOnce() -> Result<Self, E>,

And_then-chaining based on is_consumed(). Returns max(self, f()).

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

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

👎Deprecated since 1.2.2: use and_then()

Then-chaining. Returns max(self, f()).

fn and_try<F, E>(self, f: F) -> Result<Self, E>

where Self: Sized + Ord, F: FnOnce() -> Result<Self, E>,

👎Deprecated since 1.2.2: use and_then_try()

Then-chaining. Returns max(self, f()).

impl Debug for ScrollOutcome

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

Formats the value using the given formatter.

impl From<ScrollOutcome> for Outcome

fn from(value: ScrollOutcome) -> Outcome

Converts to this type from the input type.

impl HandleEvent<Event, MouseOnly, ScrollOutcome> for ScrollAreaState<'_>

Handle scrolling for the whole area spanned by the two scroll-states.

fn handle(&mut self, event: &Event, _qualifier: MouseOnly) -> ScrollOutcome

Handle an event.

impl HandleEvent<Event, MouseOnly, ScrollOutcome> for ScrollState

fn handle(&mut self, event: &Event, _qualifier: MouseOnly) -> ScrollOutcome

Handle an event.

impl Ord for ScrollOutcome

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ScrollOutcome

fn eq(&self, other: &ScrollOutcome) -> 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 PartialOrd for ScrollOutcome

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for ScrollOutcome

impl Eq for ScrollOutcome

impl StructuralPartialEq for ScrollOutcome