Skip to main content

SplitPane

Struct SplitPane 

Source
pub struct SplitPane { /* private fields */ }
Expand description

A resizable split pane component

Implementations§

Source§

impl SplitPane

Source

pub fn new() -> Self

Create a new SplitPane

Source

pub fn orientation(self, orientation: Orientation) -> Self

Set the orientation (horizontal or vertical)

Source

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

Set the style

Source

pub fn min_size(self, min_size: u16) -> Self

Set the minimum size for each pane in cells

Source

pub fn min_percent(self, min_percent: u16) -> Self

Set the minimum percentage for the first pane

Source

pub fn max_percent(self, max_percent: u16) -> Self

Set the maximum percentage for the first pane

Source

pub fn divider_char(self, char: &'static str) -> Self

Set the divider character

Source

pub fn calculate_areas( &self, area: Rect, split_percent: u16, ) -> (Rect, Rect, Rect)

Calculate the layout areas for the split pane

Takes a split_percent (0-100) to determine the first pane size.

Source

pub fn render_with_content<F1, F2>( &self, area: Rect, buf: &mut Buffer, state: &mut SplitPaneState, first_pane_renderer: F1, second_pane_renderer: F2, registry: &mut ClickRegionRegistry<SplitPaneAction>, )
where F1: FnOnce(Rect, &mut Buffer), F2: FnOnce(Rect, &mut Buffer),

Render the split pane with custom content renderers and click region registry

Source

pub fn render_divider_only( &self, area: Rect, buf: &mut Buffer, state: &mut SplitPaneState, ) -> (Rect, Rect, Rect)

Render just the split pane divider (for cases where content is rendered separately)

Source

pub fn divider_click_region( &self, area: Rect, split_percent: u16, ) -> ClickRegion<SplitPaneAction>

Get a simple click region for the divider

Source

pub fn get_orientation(&self) -> Orientation

Get the orientation

Source

pub fn get_min_percent(&self) -> u16

Get min_percent

Source

pub fn get_max_percent(&self) -> u16

Get max_percent

Trait Implementations§

Source§

impl Default for SplitPane

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.