Struct rat_widget::splitter::Split

pub struct Split<'a> { /* private fields */ }

Splits the area in multiple parts and allows changing the sizes.

This widget doesn’t hold a reference to the rendered widgets or such, use [SplitState::areas] to render each part, after rendering the split widget.

Additionally, Split itself can’t be rendered but acts as a builder for the actual widgets. Call into_widgets to get the actual SplitWidget and the SplitOverlay. SplitWidget must be rendered first, after that you can access the SplitState::areas to render the parts, and last render SplitOverlay to render the markers that will appear overlaid on the widgets.

Implementations

impl<'a> Split<'a>

pub fn new() -> Self

pub fn constraints( self, constraints: impl IntoIterator<Item = Constraint>, ) -> Self

Set constraints for the initial area sizes. If the window is resized the current widths are used as constraints for recalculating.

The number of constraints determines the number of areas.

pub fn direction(self, direction: Direction) -> Self

Layout direction of the widgets. Direction::Horizontal means the widgets are laid out left to right, with a vertical split area in between.

pub fn split_type(self, split_type: SplitType) -> Self

Controls rendering of the splitter.

pub fn join(self, border: BorderType) -> Self

Draw a join character between the split and the border on the left/top side. This sets the border type used for the left/top border.

pub fn join_0(self, border: BorderType) -> Self

Draw a join character between the split and the border on the left/top side. This sets the border type used for the left/top border.

pub fn join_1(self, border: BorderType) -> Self

Draw a join character between the split and the border on the right/bottom side. This sets the border type used for the right/bottom border.

pub fn block(self, block: Block<'a>) -> Self

Outer block.

pub fn styles(self, styles: SplitStyle) -> Self

Set all styles.

pub fn style(self, style: Style) -> Self

Style for the split area.

pub fn arrow_style(self, style: Style) -> Self

Style for the arrows.

pub fn drag_style(self, style: Style) -> Self

Style while dragging the splitter.

pub fn mark_offset(self, offset: u16) -> Self

Offset for the split marker from the top/left.

pub fn mark_0(self, mark: &'a str) -> Self

First marker char for the splitter.

pub fn mark_1(self, mark: &'a str) -> Self

Second marker char for the splitter.

pub fn into_widgets(self) -> (SplitWidget<'a>, SplitOverlay<'a>)

Constructs the widgets for rendering.

Trait Implementations

impl<'a> Clone for Split<'a>

fn clone(&self) -> Split<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Split<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Split<'a>

fn default() -> Split<'a>

Returns the “default value” for a type.