Struct StructuredLayout

pub struct StructuredLayout { /* private fields */ }

Container for the areas coming out of a layout function.

This is more or less a Vec<Rect>, but it takes a stride as parameter and treats N Rects as one unit.

This way it can add some structure to the list and express something like ‘the label area for the 5th item’.

As a second feature it returns a handle for each item, which can be used to retrieve the item later.

pub enum LW {
    Label,
    Widget
}

let mut l = StructuredLayout::new(LW::count());

// ... some layout calculations ...
let w0 = l.add(&[
        Rect::new(0,0,5,1),
        Rect::new(6,0,15,1)
]);

// ... something entirely else ...

Span::from("label")
    .render(l[w0][Label],&mut buf);

Checkbox::new()
    .text("Check this out")
    .render(l[w0][Widget], &mut buf, &mut state);

Implementations

impl StructuredLayout

pub fn new(stride: usize) -> Self

New layout with the given stride.

pub fn area(&self) -> Rect

Original area for which this layout has been calculated. Can be used to invalidate a layout if the area changes.

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

Original area for which this layout has been calculated. Can be used to invalidate a layout if the area changes.

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

Change detection.

pub fn height_change(&self, height: u16) -> bool

Change detection.

pub fn pos_change(&self, pos: Position) -> bool

Change detection.

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

Add the areas for one item.

You can refer Returns a handle to access the item later. You can always use a simple index too.

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

Add a manual break after the given position.

See SinglePager and DualPager who can work with this. Other widgets may simply ignore this.

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

Add a manual break before the given position.

See SinglePager and DualPager who can work with this. Other widgets may simply ignore this.

pub fn row_breaks(&self) -> &[u16]

Return the manual page breaks.

pub fn row_breaks_mut(&mut self) -> &mut [u16]

Return the manual page breaks.

pub fn sort_row_breaks_desc(&mut self)

Sort and dedup the row-breaks.

pub fn len(&self) -> usize

Number of areas.

pub fn is_empty(&self) -> bool

Any areas?

pub fn stride(&self) -> usize

Stride per item.

pub fn as_slice(&self) -> &[Rect]

All areas. If you want to access a specific item you must use the stride to calculate the offset.

pub fn as_mut_slice(&mut self) -> &mut [Rect]

All areas. If you want to access a specific item you must use the stride to calculate the offset.

pub fn iter(&self) -> impl Iterator<Item = &Rect>

Iterator over all areas.

pub fn chunked(&self) -> impl Iterator<Item = &[Rect]>

Iterator over all areas chunked by stride.

pub fn bounds(&self) -> Rect

Calculate the bounding box for all areas.

Trait Implementations

impl Clone for StructuredLayout

fn clone(&self) -> StructuredLayout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StructuredLayout

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

Formats the value using the given formatter.

impl Default for StructuredLayout

fn default() -> Self

Returns the “default value” for a type.

impl Index<AreaHandle> for StructuredLayout

type Output = [Rect]

The returned type after indexing.

fn index(&self, index: AreaHandle) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<DialogItem> for StructuredLayout

type Output = Rect

The returned type after indexing.

fn index(&self, index: DialogItem) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for StructuredLayout

type Output = [Rect]

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<AreaHandle> for StructuredLayout

fn index_mut(&mut self, index: AreaHandle) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<DialogItem> for StructuredLayout

fn index_mut(&mut self, index: DialogItem) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for StructuredLayout

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.