Struct ScrollViewState 

pub struct ScrollViewState { /* private fields */ }

Implementations

impl ScrollViewState

pub fn new() -> Self

Create a new scroll view state with an offset of (0, 0)

pub fn with_offset(offset: Position) -> Self

Create a new scroll view state with the given offset

pub const fn set_offset(&mut self, offset: Position)

Set the offset of the scroll view state

pub const fn offset(&self) -> Position

Get the offset of the scroll view state

pub const fn scroll_up(&mut self)

Move the scroll view state up by one row

pub const fn scroll_down(&mut self)

Move the scroll view state down by one row

pub fn scroll_page_down(&mut self)

Move the scroll view state down by one page

pub fn scroll_page_up(&mut self)

Move the scroll view state up by one page

pub const fn scroll_left(&mut self)

Move the scroll view state left by one column

pub const fn scroll_right(&mut self)

Move the scroll view state right by one column

pub const fn scroll_to_top(&mut self)

Move the scroll view state to the top of the buffer

pub fn scroll_to_bottom(&mut self)

Move the scroll view state to the bottom of the buffer

If the buffer size is not yet computed (done during the first rendering), it will not be taken into account and the scroll offset will be set to the maximum value: u16::MAX

pub fn is_at_bottom(&self) -> bool

True if the scroll view state is at the bottom of the buffer

This takes the page size into account. It returns true if the last row in the buffer is visible in the current page.

The buffer and the page size are unknown until computed during the first rendering. If the buffer size is not yet known, this function always returns true. If the page size is not yet known, the current row is treated as a one-row page.

Saturating arithmetic prevents large offsets from overflowing when they are combined with the page size.

Trait Implementations

impl Clone for ScrollViewState

fn clone(&self) -> ScrollViewState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ScrollViewState

impl Debug for ScrollViewState

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

Formats the value using the given formatter.

impl Default for ScrollViewState

fn default() -> ScrollViewState

Returns the “default value” for a type.

impl Eq for ScrollViewState

impl Hash for ScrollViewState

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ScrollViewState

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