Struct ScrollViewState 

pub struct ScrollViewState { /* private fields */ }

Implementations

impl ScrollViewState

pub fn new() -> Self

pub fn with_offset(offset: Position) -> Self

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

pub const fn offset(&self) -> Position

pub const fn scroll_up(&mut self)

pub const fn scroll_down(&mut self)

pub fn scroll_page_down(&mut self)

pub fn scroll_page_up(&mut self)

pub const fn scroll_left(&mut self)

pub const fn scroll_right(&mut self)

pub const fn scroll_to_top(&mut self)

pub fn scroll_to_bottom(&mut self)

pub const fn size(&self) -> Option<Size>

The content size (the full scrollable buffer). None before the first render.

pub const fn page_size(&self) -> Option<Size>

The visible page size (viewport after scrollbars). None before the first render.

pub fn is_at_bottom(&self) -> bool

Whether the last content row is visible in the current page.

Returns true before the first render (size unknown). Ported from upstream tui-scrollview; relies on page_size meaning the visible viewport.

pub fn scroll_to_visible(&mut self, y: u16, height: u16)

Scroll the vertical offset the minimum amount so the row range [y, y + height) is inside the visible page. No-op if already visible.

The render pass re-clamps against the content, so this only needs to move the offset toward the target.

pub fn child_area(&self, index: usize) -> Option<Rect>

The content-buffer area of the direct child at index (in child order), as recorded by ScrollView on the last render. None before the first render or when index is out of range.

pub fn scroll_to_index(&mut self, index: usize)

Scroll so the direct child at index (in child order) is visible.

This is the “follow the selection” primitive: after a page moves its selection over a list of ScrollView children, call this with the selected index so the viewport tracks it. No-op if index is unknown (e.g. before the first render). Child geometry is selection-independent, so the last recorded layout is correct for the new selection.

pub fn handle_event(&mut self, event: &Event) -> bool

Returns true if the event was a scroll input this state acted on.

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ScrollViewState