Struct ClipperState

pub struct ClipperState {
    pub area: Rect,
    pub widget_area: Rect,
    pub layout: ClipperLayout,
    pub hscroll: ScrollState,
    pub vscroll: ScrollState,
    pub c_focus: ContainerFlag,
    /* private fields */
}

Clipper state.

Fields

area: Rect

Full area for the widget. read only renewed for each render.

widget_area: Rect

Area inside the border. read only renewed for each render.

layout: ClipperLayout

Page layout. read only renewed for each render.

hscroll: ScrollState

Horizontal scroll read+write

vscroll: ScrollState

Vertical scroll read+write

c_focus: ContainerFlag

This widget has no focus of its own, but this flag can be used to set a container state.

Implementations

impl ClipperState

pub fn new() -> Self

pub fn show_handle(&mut self, handle: AreaHandle)

Show the area for the given handle.

pub fn show_area(&mut self, area: Rect)

Show this rect in layout coordinates.

pub fn first_handle(&self) -> Option<AreaHandle>

First handle for the page. This returns the first handle for the page. Does not check whether the connected area is visible.

pub fn first_area(&self) -> Option<Box<[Rect]>>

First handle for the page. This returns the first handle for the page. Does not check whether the connected area is visible.

impl ClipperState

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 ClipperState

fn clone(&self) -> ClipperState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClipperState

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

Formats the value using the given formatter.

impl Default for ClipperState

fn default() -> ClipperState

Returns the “default value” for a type.

impl HandleEvent<Event, MouseOnly, Outcome> for ClipperState

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

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for ClipperState

fn handle(&mut self, event: &Event, _keymap: Regular) -> Outcome

Handle an event.