Struct ScrollState 

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

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

impl ScrollState

pub fn new() -> Self

Create scroll state starting at offset 0.

pub fn can_scroll_up(&self) -> bool

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

pub fn can_scroll_down(&self) -> bool

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

pub fn content_height(&self) -> u32

Get the total content height in rows.

pub fn viewport_height(&self) -> u32

Get the viewport height in rows.

pub fn progress(&self) -> f32

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

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

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

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

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

pub fn set_highlights(&mut self, ranges: &[HighlightRange])

Set the active highlight ranges. Replaces any previous highlights.

Selecting the first highlight automatically when the list is non-empty matches the behavior of search-result navigation in code editors.

pub fn highlights(&self) -> &[HighlightRange]

Read-only access to the active highlight ranges.

pub fn current_highlight(&self) -> Option<usize>

Index of the currently focused highlight, if any.

pub fn clear_highlights(&mut self)

Clear all highlights and reset the current index.

pub fn highlight_next(&mut self)

Advance to the next highlight, scrolling the viewport to show it. Wraps from last to first.

pub fn highlight_previous(&mut self)

Move to the previous highlight, scrolling the viewport to show it. Wraps from first to last.

pub fn scroll_to_current_highlight(&mut self)

Scroll the viewport so the currently focused highlight is visible with one line of context above when possible.

Trait Implementations

impl Clone for ScrollState

fn clone(&self) -> ScrollState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollState

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

Formats the value using the given formatter.

impl Default for ScrollState

fn default() -> Self

Returns the “default value” for a type.