Struct PageLayout

pub struct PageLayout { /* private fields */ }

PageLayout is fed with the areas that should be displayed.

The areas must use widget relative coordinates not screen coordinates.

It then splits the list in pages in a way that there are no broken areas.

Implementations

impl PageLayout

pub fn new() -> Self

pub fn add(&mut self, area: Rect) -> AreaHandle

Add a rect.

pub fn add_all(&mut self, areas: impl IntoIterator<Item = Rect>)

Add rects.

pub fn extend( &mut self, areas: impl IntoIterator<Item = Rect>, handles: &mut Vec<AreaHandle>, )

Add rects. Appends the resulting handles.

pub fn break_after(&mut self, y: u16)

Add a manual break after the given position.

pub fn break_before(&mut self, y: u16)

Add a manual break before the given position.

pub fn layout(&mut self, page: Rect)

Run the layout algorithm.

pub fn len(&self) -> usize

Number of pages.

pub fn is_empty(&self) -> bool

Any pages

pub fn locate_handle(&self, handle: AreaHandle) -> (usize, Rect)

Locate an area by handle.

This will return a Rect with a y-value relative to the page it is in. But still in layout-coords.

And it returns the page the Rect is on.

pub fn locate(&self, area: Rect) -> (usize, Rect)

Locate an area.

This will return a Rect with a y-value relative to the page it is in. But still in layout-coords.

And it returns the page the Rect is on.

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

First area on the given page.

pub fn first_handle(&self, page: usize) -> Option<AreaHandle>

First area-handle on the given page.

Trait Implementations

impl Clone for PageLayout

fn clone(&self) -> PageLayout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PageLayout

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

Formats the value using the given formatter.

impl Default for PageLayout

fn default() -> PageLayout

Returns the “default value” for a type.