Struct ViewState

pub struct ViewState {
    pub area: Rect,
    pub inner: Rect,
    pub view: Rect,
    pub hscroll: ScrollState,
    pub vscroll: ScrollState,
    pub non_exhaustive: NonExhaustive,
}

State of the viewport.

Fields

area: Rect

Complete area of the viewport. readonly. renewed for each render.

inner: Rect

Inner area of the viewport. readonly. renewed for each render.

view: Rect

The viewport area that the inner widget sees. readonly. renewed for each render.

hscroll: ScrollState

Horizontal scroll read+write

vscroll: ScrollState

Vertical scroll read+write

non_exhaustive: NonExhaustive

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

Implementations

impl ViewState

pub fn new() -> Self

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 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

Formats the value using the given formatter.

impl Default for ViewState

fn default() -> Self

Returns the “default value” for a type.

impl HandleEvent<Event, MouseOnly, Outcome> for ViewState

fn handle(&mut self, event: &Event, _qualifier: MouseOnly) -> Outcome

Handle an event.