Struct rat_widget::scrolled::ScrolledState

pub struct ScrolledState<WidgetState> {
    pub widget: WidgetState,
    pub area: Rect,
    pub view_area: Rect,
    pub h_scrollbar_area: Option<Rect>,
    pub v_scrollbar_area: Option<Rect>,
    pub v_overscroll: usize,
    pub h_overscroll: usize,
    pub v_drag: bool,
    pub h_drag: bool,
    pub non_exhaustive: NonExhaustive,
}

Scrolled state.

Fields

widget: WidgetState

State of the scrolled widget.

area: Rect

Total screen area.

view_area: Rect

View area.

h_scrollbar_area: Option<Rect>

Scrollbar area.

v_scrollbar_area: Option<Rect>

Scrollbar area.

v_overscroll: usize

Allow overscroll by n items.

h_overscroll: usize

Allow overscroll by n items.

v_drag: bool

mouse action in progress

h_drag: bool

non_exhaustive: NonExhaustive

Implementations

impl<WState> ScrolledState<WState>

where WState: ScrollingState,

pub fn vertical_offset(&self) -> usize

Current vertical offset.

pub fn horizontal_offset(&self) -> usize

Current horizontal offset.

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

Change the offset. Limits the offset to max_v_offset + v_overscroll.

Due to overscroll it’s possible that this is an invalid offset for the widget. The widget must deal with this situation.

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

Change the offset. Limits the offset to max_h_offset + h_overscroll.

Due to overscroll it’s possible that this is an invalid offset for the widget. The widget must deal with this situation.

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

Scroll up by n.

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

Scroll down by n, but limited by the max_offset + overscroll

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

Scroll up by n.

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

Scroll right by n, but limited by the max_offset + overscroll

pub fn widget_mut(&mut self) -> &mut WState

Trait Implementations

impl<WidgetState> Clone for ScrolledState<WidgetState>

where WidgetState: Clone,

fn clone(&self) -> ScrolledState<WidgetState>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<WidgetState> Debug for ScrolledState<WidgetState>

where WidgetState: Debug,

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

Formats the value using the given formatter.

impl<WState> Default for ScrolledState<WState>

where WState: Default,

fn default() -> ScrolledState<WState>

Returns the “default value” for a type.

impl<R, WState> HandleEvent<Event, FocusKeys, ScrollOutcome<R>> for ScrolledState<WState>

where WState: ScrollingState + HandleEvent<Event, FocusKeys, R> + HandleEvent<Event, MouseOnly, R>, R: ConsumedEvent,

Handle events or the scrolled widget and forward to the inner widget.

fn handle(&mut self, event: &Event, _keymap: FocusKeys) -> ScrollOutcome<R>

Handle an event.

impl<WState, Q, R> HandleEvent<Event, Inner<Q>, ScrollOutcome<R>> for ScrolledState<WState>

where WState: ScrollingState + HandleEvent<Event, Q, R>, R: ConsumedEvent,

Forward event-handling to the inner widget.

fn handle(&mut self, event: &Event, qualifier: Inner<Q>) -> ScrollOutcome<R>

Handle an event.

impl<R, WState> HandleEvent<Event, MouseOnly, ScrollOutcome<R>> for ScrolledState<WState>

where WState: ScrollingState + HandleEvent<Event, MouseOnly, R>, R: ConsumedEvent,

Handle events for the Scrolled widget and the scrollbars.

fn handle(&mut self, event: &Event, _keymap: MouseOnly) -> ScrollOutcome<R>

Handle an event.