Struct rat_widget::scrolled::ViewportState

pub struct ViewportState<S> {
    pub widget: S,
    pub area: Rect,
    pub view_area: Rect,
    pub h_offset: usize,
    pub v_offset: usize,
    pub non_exhaustive: NonExhaustive,
}

State of the viewport.

Fields

widget: S

Widget state.

area: Rect

The drawing area for the viewport.

view_area: Rect

The viewport area that the inner widget sees.

h_offset: usize

Horizontal offset

v_offset: usize

Vertical offset

non_exhaustive: NonExhaustive

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

Implementations

impl<S> ViewportState<S>

pub fn relocate_crossterm(&self, event: &Event) -> Event

Relocate mouse-events for use inside the viewport.

Trait Implementations

impl<S> Clone for ViewportState<S>

where S: Clone,

fn clone(&self) -> ViewportState<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for ViewportState<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<S> Default for ViewportState<S>

where S: Default,

fn default() -> ViewportState<S>

Returns the “default value” for a type.

impl<R, S> HandleEvent<Event, FocusKeys, ScrollOutcome<R>> for ViewportState<S>

where S: HandleEvent<Event, FocusKeys, R>, R: ConsumedEvent,

Handle events if the widget has the focus.

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

Handle an event.

impl<R, S> HandleEvent<Event, MouseOnly, ScrollOutcome<R>> for ViewportState<S>

where S: HandleEvent<Event, MouseOnly, R>, R: ConsumedEvent,

Handle only mouse-events.

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

Handle an event.

impl<S> ScrollingState for ViewportState<S>

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.