Skip to main content

ScrollAlign

Enum ScrollAlign 

Source
pub enum ScrollAlign {
    Minimal,
    Fraction(f32),
}
Expand description

Where a WidgetEvent::ScrollIntoView target should come to rest on the scroll container’s vertical axis.

The horizontal axis is always revealed minimally — a fraction only has an obvious meaning for the axis the request is about, and pinning a caret vertically must not yank a horizontally-scrolled view sideways.

Variants§

§

Minimal

Scroll the least amount that makes the target fully visible, and not at all when it already is. This is what focus-driven reveals and EventContext::ensure_visible use, and it is the behaviour every scroll container had before alignment existed.

§

Fraction(f32)

Pin the target at f of the way down the viewport — 0.0 flush with the top, 0.5 centred, 1.0 flush with the bottom — whether or not it is already visible. Being unconditional is the whole point: a typewriter-scrolling caret that only moved the view when it fell off the edge would not be pinned at all.

The container still clamps to its scroll range, so a target near the start or end of the content comes to rest as close to f as the range allows. See ScrollArea::scroll_past_end for buying range past the end of the content so the last line can still reach the pin.

Trait Implementations§

Source§

impl Clone for ScrollAlign

Source§

fn clone(&self) -> ScrollAlign

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ScrollAlign

Source§

impl Debug for ScrollAlign

Source§

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

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

impl PartialEq for ScrollAlign

Source§

fn eq(&self, other: &ScrollAlign) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ScrollAlign

Auto Trait Implementations§

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, 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> 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 = !

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.