Skip to main content

ScrollState

Struct ScrollState 

Source
pub struct ScrollState {
    pub offset: usize,
    /* private fields */
}
Expand description

State for a scrollable container.

Pass a mutable reference to Context::scrollable each frame. The context updates offset and the internal bounds automatically based on mouse wheel and drag events.

Fields§

§offset: usize

Current vertical scroll offset in rows.

Implementations§

Source§

impl ScrollState

Source

pub fn new() -> Self

Create scroll state starting at offset 0.

Source

pub fn can_scroll_up(&self) -> bool

Check if scrolling upward is possible (offset is greater than 0).

Source

pub fn can_scroll_down(&self) -> bool

Check if scrolling downward is possible (content extends below the viewport).

Source

pub fn content_height(&self) -> u32

Get the total content height in rows.

Source

pub fn viewport_height(&self) -> u32

Get the viewport height in rows.

Source

pub fn progress(&self) -> f32

Get the scroll progress as a ratio in [0.0, 1.0].

Source

pub fn scroll_up(&mut self, amount: usize)

Scroll up by the given number of rows, clamped to 0.

Source

pub fn scroll_down(&mut self, amount: usize)

Scroll down by the given number of rows, clamped to the maximum offset.

Trait Implementations§

Source§

impl Default for ScrollState

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> 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, 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.