Struct GenericLayout 

pub struct GenericLayout<W>
where
    W: Eq + Hash + Clone,
{ /* private fields */ }

Stores layout data resulting from some layout algorithm.

Widgets and labels are stored for some key that identifies the widget. It is also possible to store the label text.

Blocks can be added too. It is expected that blocks will be rendered in order of addition.

There is a concept for pages too. The page-height defines the pages. The page-width is not used to constrain the pages and is just informational. It can be used to find if the layout has to be rebuilt after a resize.

The page-count is available too, but there may be areas that map beyond the page-count.

See LayoutForm layout_edit

Implementations

impl<W> GenericLayout<W>

where W: Eq + Hash + Clone,

pub fn new() -> Self

pub fn with_capacity(num_widgets: usize, num_blocks: usize) -> Self

Initialize with a certain capacity.

pub fn clear(&mut self)

Clear all data.

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

Set the area used for this layout. The area may or may not have anything to do with the page-size.

pub fn area(&self) -> Rect

The area used for this layout. The area may or may not have anything to do with the page-size.

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

Area differs from stored area?

pub fn set_page_size(&mut self, size: Size)

Set the page-size for this layout.

Defaults to (u16::MAX, u16::MAX).

pub fn page_size(&self) -> Size

Get the page-size for this layout.

pub fn size_changed(&self, size: Size) -> bool

Page-size changed.

pub fn set_page_count(&mut self, page_count: usize)

Number of pages

pub fn page_count(&self) -> usize

Number of pages

pub fn add( &mut self, key: W, area: Rect, label: Option<Cow<'static, str>>, label_area: Rect, )

Add widget + label areas.

pub fn add_block(&mut self, area: Rect, block: Option<Block<'static>>)

Add a block.

pub fn place(self, pos: Position) -> Self

Places the layout at the given position. This shifts all area right by the given offset.

Most layout functions create a layout that starts at (0,0). That is ok, as the widgets using such a layout associate their top/left position with (0,0) and start from there.

If you want to use the layout without such a widget, this one is nice.

pub fn first(&self, page: usize) -> Option<W>

First widget on the given page.

pub fn page_of(&self, widget: W) -> Option<usize>

Calculates the page of the widget.

pub fn is_empty(&self) -> bool

Any widgets/blocks?

pub fn is_endless(&self) -> bool

Is this as layout with height = u16::MAX?

pub fn widget_len(&self) -> usize

Number of widgets/labels.

pub fn try_index_of(&self, widget: W) -> Option<usize>

Returns the index for this widget.

pub fn index_of(&self, widget: W) -> usize

Returns the index for this widget.

Panic Panics if there is no widget for the key.

pub fn widget_key(&self, idx: usize) -> W

Access widget key.

Panic Panics on out of bounds.

pub fn widget_keys(&self) -> impl Iterator<Item = &W>

Access widget keys

pub fn label_for(&self, widget: W) -> Rect

Access the label area by key.

Panic Panics on out of bounds. Panics if the key doesn’t exist.

pub fn label(&self, idx: usize) -> Rect

Access label area.

Panic Panics on out of bounds.

pub fn set_label(&mut self, idx: usize, area: Rect)

Set the label area.

Panic Panics on out of bounds.

pub fn widget_for(&self, widget: W) -> Rect

Access the widget area by key.

Panic Panics on out of bounds. Panics if the key doesn’t exist.

pub fn widget(&self, idx: usize) -> Rect

Access widget area.

Panic Panics on out of bounds.

pub fn set_widget(&mut self, idx: usize, area: Rect)

Change the widget area.

Panic Panics on out of bounds.

pub fn try_label_str_for(&self, widget: W) -> &Option<Cow<'static, str>>

Access the label string by key.

Panic Panics on out of bounds. Panics if the key doesn’t exist.

pub fn try_label_str(&self, idx: usize) -> &Option<Cow<'static, str>>

Access label string.

Panic Panics on out of bounds.

pub fn label_str_for(&self, widget: W) -> &str

Access the label string by key.

Panic Panics on out of bounds. Panics if the key doesn’t exist.

pub fn label_str(&self, idx: usize) -> &str

Access label string.

Panic Panics on out of bounds.

pub fn set_label_str(&mut self, idx: usize, str: Option<Cow<'static, str>>)

Set the label string.

Panic Panics on out of bounds.

pub fn block_len(&self) -> usize

Container count.

pub fn block_area(&self, idx: usize) -> Rect

Access block area.

Panic Panics on out of bounds.

pub fn set_block_area(&mut self, idx: usize, area: Rect)

Set the block area.

Panic Panics on out of bounds.

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

Iterate block areas.

pub fn block(&self, idx: usize) -> &Option<Block<'static>>

Access container block.

Panic Panics on out of bounds.

pub fn set_block(&mut self, idx: usize, block: Option<Block<'static>>)

Set the container block.

Panic Panics on out of bounds.

Trait Implementations

impl<W> Clone for GenericLayout<W>

where W: Eq + Hash + Clone + Clone,

fn clone(&self) -> GenericLayout<W>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<W> Debug for GenericLayout<W>

where W: Eq + Hash + Clone + Debug,

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

Formats the value using the given formatter.

impl<W> Default for GenericLayout<W>

where W: Eq + Hash + Clone,

fn default() -> Self

Returns the “default value” for a type.