Struct rat_widget::viewport::ViewportState

pub struct ViewportState<S> {
    pub widget: S,
    pub area: Rect,
    pub inner_area: Rect,
    pub view_area: Rect,
    pub hscroll: ScrollState,
    pub vscroll: ScrollState,
    pub non_exhaustive: NonExhaustive,
}

State of the viewport.

Fields

widget: S

area: Rect

Complete area of the viewport.

inner_area: Rect

Inner area of the viewport.

view_area: Rect

The viewport area that the inner widget sees.

hscroll: ScrollState

Horizontal scroll

vscroll: ScrollState

Vertical scroll

non_exhaustive: NonExhaustive

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

Implementations

impl<S> ViewportState<S>

where S: Default,

pub fn new(widget_state: S) -> Self

impl<S> ViewportState<S>

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

Relocate mouse-events for use inside the viewport.

impl<S> ViewportState<S>

pub fn vertical_offset(&self) -> usize

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

pub fn vertical_page_len(&self) -> usize

pub fn horizontal_offset(&self) -> usize

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

pub fn horizontal_page_len(&self) -> usize

pub fn horizontal_scroll_to(&mut self, pos: usize) -> bool

pub fn vertical_scroll_to(&mut self, pos: usize) -> bool

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

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

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

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

Trait Implementations

impl<S: Clone> Clone for ViewportState<S>

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> Debug for ViewportState<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for ViewportState<S>

fn default() -> Self

Returns the “default value” for a type.

impl<R, Q, S> HandleEvent<Event, Q, R> for ViewportState<S>

where S: HandleEvent<Event, Q, R>, R: From<Outcome> + ConsumedEvent + Debug,

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

Handle an event.