Struct PagerLayout

pub struct PagerLayout { /* private fields */ }

PagerLayout holds all areas for the widgets that want to be displayed.

It uses its own layout coordinates.

The layout step breaks this list into pages that can fit the widgets. If your widget is too big to fit in the page area it will be placed at a new page and will be clipped into shape.

Implementations

impl PagerLayout

pub fn new(stride: usize) -> Self

New layout.

pub fn with_layout(layout: StructuredLayout) -> Self

New layout from StructuredLayout

pub fn width_changed(&self, width: u16) -> bool

Has the target width of the layout changed.

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

Add a rect.

pub fn layout_handle(&self, handle: AreaHandle) -> Box<[Rect]>

Get the layout area for the given handle

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 len(&self) -> usize

Number of areas.

pub fn is_empty(&self) -> bool

Contains areas?

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

Run the layout algorithm.

pub fn page_area(&self) -> Rect

Page area in layout coordinates

pub fn num_pages(&self) -> usize

Number of pages after calculating the layout.

pub fn first_layout_area(&self, page: usize) -> Option<Box<[Rect]>>

First area on the given page.

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

First area-handle on the given page.

pub fn buf_handle(&self, handle: AreaHandle) -> (usize, Box<[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 buf_area(&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.

This will clip the bounds to the page area if not displayable otherwise.

And it returns the page the Rect is on.

Trait Implementations

impl Clone for PagerLayout

fn clone(&self) -> PagerLayout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PagerLayout

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

Formats the value using the given formatter.

impl Default for PagerLayout

fn default() -> PagerLayout

Returns the “default value” for a type.