Struct rat_widget::scrolled::ViewState

pub struct ViewState {
    pub area: Rect,
    pub view_area: Rect,
    pub h_offset: usize,
    pub v_offset: usize,
    pub non_exhaustive: NonExhaustive,
}

State of the view.

Fields

area: Rect

The drawing area for the view.

view_area: Rect

The view area that the inner widget sees.

h_offset: usize

Horizontal offset

v_offset: usize

Vertical offset

non_exhaustive: NonExhaustive

Only construct with ..Default::default().

Trait Implementations

impl Clone for ViewState

fn clone(&self) -> ViewState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ViewState

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

Formats the value using the given formatter.

impl Default for ViewState

fn default() -> ViewState

Returns the “default value” for a type.

impl<R> HandleEvent<Event, FocusKeys, ScrollOutcome<R>> for ViewState

where R: ConsumedEvent,

Handle all events. Text events are only processed if focus is true. Mouse events are processed if they are in range.

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

Handle an event.

impl<R> HandleEvent<Event, MouseOnly, ScrollOutcome<R>> for ViewState

where R: ConsumedEvent,

Handle only mouse-events.

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

Handle an event.

impl ScrollingState for ViewState

fn vertical_max_offset(&self) -> usize

Maximum offset that is accessible with scrolling.

fn vertical_offset(&self) -> usize

Current vertical offset.

fn vertical_page(&self) -> usize

Vertical page-size at the current offset.

fn horizontal_max_offset(&self) -> usize

Maximum offset that is accessible with scrolling.

fn horizontal_offset(&self) -> usize

Current horizontal offset.

fn horizontal_page(&self) -> usize

Horizontal page-size at the current offset.

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

Change the vertical offset.

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

Change the horizontal offset.

fn vertical_scroll(&self) -> usize

Suggested scroll per scroll-event.

fn horizontal_scroll(&self) -> usize

Suggested scroll per scroll-event.

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

Scroll up by n items. The widget returns true if the offset changed at all.

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

Scroll down by n items. The widget returns true if the offset changed at all.

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

Scroll up by n items. The widget returns true if the offset changed at all.

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

Scroll down by n items. The widget returns true if the offset changed at all.