Struct ClickableScrollbarState 

pub struct ClickableScrollbarState {
    pub area: Rect,
    pub orientation: ScrollbarOrientation,
    pub offset: usize,
    pub page_len: usize,
    pub max_offset: usize,
    pub scroll_by: Option<usize>,
    /* private fields */
}

State for the clickable scrollbar.

This manages the scrolling position and handles mouse interactions.

Fields

area: Rect

Area where the scrollbar is rendered. Updated automatically during rendering.

orientation: ScrollbarOrientation

Orientation of the scrollbar.

offset: usize

Current scroll offset (position in content).

page_len: usize

Length of visible content area.

max_offset: usize

Maximum scroll offset (content_length - page_len).

scroll_by: Option<usize>

How many lines/columns to scroll per wheel event. Defaults to 1/10 of page_len.

Implementations

impl ClickableScrollbarState

pub fn new() -> Self

Create a new scrollbar state.

pub fn set_content(self, content_len: usize, page_len: usize) -> Self

Set the content length and page length. This will calculate max_offset automatically.

pub fn position(self, offset: usize) -> Self

Set the position.

pub fn offset(&self) -> usize

Get the current offset.

pub fn set_offset(&mut self, offset: usize) -> bool

Set the offset.

pub fn scroll_up(&mut self, n: usize) -> bool

Scroll up by N units.

pub fn scroll_down(&mut self, n: usize) -> bool

Scroll down by N units.

pub fn scroll_increment(&self) -> usize

Get the scroll increment for wheel events. Defaults to 1/10 of page_len.

pub fn handle_mouse_event(&mut self, event: &MouseEvent) -> ScrollbarEvent

Handle a mouse event. Returns Some(ScrollbarEvent) if the event was handled.

Trait Implementations

impl Clone for ClickableScrollbarState

fn clone(&self) -> ClickableScrollbarState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClickableScrollbarState

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

Formats the value using the given formatter.

impl Default for ClickableScrollbarState

fn default() -> Self

Returns the “default value” for a type.