Struct ClipperLayout

pub struct ClipperLayout { /* private fields */ }

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

It uses its own layout coordinates. The scroll offset is in layout coordinates too.

Implementations

impl ClipperLayout

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.

This is helpful if you only want vertical scrolling, and build your layout to fit.

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

Add a layout area.

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

Get the layout area for the given handle

pub fn len(&self) -> usize

Number of areas.

pub fn is_empty(&self) -> bool

Contains areas?

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

Run the layout algorithm.

Returns the extended area to render all visible widgets. The size of this area is the required size of the buffer.

• page: in layout coordinates
• ->: extended area in layout coordinates.

pub fn page_area(&self) -> Rect

Page area in layout coordinates

pub fn ext_page_area(&self) -> Rect

Extended page area in layout coordinates. This area is at least as large as page_area() and has enough space for partially visible widgets.

pub fn max_layout_pos(&self) -> (u16, u16)

Returns the bottom-right corner for the Layout.

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

First visible area in buffer in layout coordinates.

Caution Order is the order of addition, not necessarily the top-left area.

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

First visible area-handle.

Caution Order is the order of addition, not necessarily the top-left area.

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

Converts the areas behind the handle to buffer coordinates. This will return coordinates relative to the extended page. Or None.

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

Converts the layout area to buffer coordinates and clips to the buffer area.

Trait Implementations

impl Clone for ClipperLayout

fn clone(&self) -> ClipperLayout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClipperLayout

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

Formats the value using the given formatter.

impl Default for ClipperLayout

fn default() -> ClipperLayout

Returns the “default value” for a type.