Struct SinglePagerState

pub struct SinglePagerState {
    pub area: Rect,
    pub widget_area: Rect,
    pub scroll_area: Rect,
    pub prev_area: Rect,
    pub next_area: Rect,
    pub layout: PageLayout,
    pub page: usize,
    pub c_focus: ContainerFlag,
    pub mouse: MouseFlagsN,
}

Fields

area: Rect

Full area. read only renewed with each render.

widget_area: Rect

Area for widgets to render.

scroll_area: Rect

Title area except the page indicators. read only renewed with each render

prev_area: Rect

Area for prev-page indicator. read only renewed with each render.

next_area: Rect

Area for next-page indicator. read only renewed with each render.

layout: PageLayout

Page layout read only renewed with each render.

page: usize

Current page. read+write

c_focus: ContainerFlag

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

mouse: MouseFlagsN

Mouse

Implementations

impl SinglePagerState

pub fn new() -> Self

pub fn relocate_handle(&self, handle: AreaHandle) -> Option<Rect>

Relocate an area by handle from Layout coordinates to screen coordinates.

A result None indicates that the area is out of view.

pub fn relocate(&self, area: Rect) -> Option<Rect>

Relocate a rect from Layout coordinates to screen coordinates.

A result None indicates that the area is out of view.

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

Show the page for this rect.

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

Show the page for this rect.

pub fn first_area(&self, page: usize) -> Option<Rect>

First area for the page. This only returns a value if the page is visible. Use PageLayout::first_area if you want something else.

pub fn first_handle(&self, page: usize) -> 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 set_page(&mut self, page: usize) -> bool

Set the visible page.

pub fn next_page(&mut self) -> bool

Select next page. Keeps the page in bounds.

pub fn prev_page(&mut self) -> bool

Select prev page.

Trait Implementations

impl Clone for SinglePagerState

fn clone(&self) -> SinglePagerState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SinglePagerState

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

Formats the value using the given formatter.

impl Default for SinglePagerState

fn default() -> SinglePagerState

Returns the “default value” for a type.

impl HandleEvent<Event, MouseOnly, PagerOutcome> for SinglePagerState

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

Handle an event.

impl HandleEvent<Event, Regular, PagerOutcome> for SinglePagerState

fn handle(&mut self, event: &Event, _qualifier: Regular) -> PagerOutcome

Handle an event.